feat: support inline resources

Add { inline: true } options to inline stylesheets and scripts.

Fixes #25.

Author: lujjjh

.eslintrc.yml .eslintrc.yaml

@@ -1,2 +1,3 @@
 .*
 node_modules
+dist

.gitignore

@@ -0,0 +1,10 @@
+const Koa = require('koa')
+const restc = require('../..')
+const app = new Koa()
+
+app.use(restc.koa2({
+  includes: ['/api', /^\/foo/],
+  excludes: '/foobar'
+}))
+
+app.listen(3000)

examples/restc-example-koa2-inline/gateway.js

@@ -0,0 +1,12 @@
+const Koa = require('koa')
+const restc = require('../..')
+const app = new Koa()
+
+app.use(restc.koa2({ inline: true }))
+
+app.use((ctx, next) => {
+  ctx.body = { message: 'Hello world!' }
+  return next()
+})
+
+app.listen(3000)

examples/restc-example-koa2-inline/index.js

@@ -0,0 +1,12 @@
+{
+  "name": "restc-example-koa2",
+  "version": "1.0.0",
+  "description": "An example to demostrate how to use restc in koa 2.x.",
+  "private": true,
+  "main": "index.js",
+  "author": "lujjjh <[email protected]>",
+  "license": "MIT",
+  "dependencies": {
+    "koa": "^2.0.0"
+  }
+}

examples/restc-example-koa2-inline/package-lock.json

@@ -4,19 +4,20 @@ const fs = require('fs')
 const path = require('path')
 const Gateway = require('./utils/gateway.js')
 
-const content = fs.readFileSync(
-  path.join(__dirname, '../faas/index.html'),
-  'utf-8'
-)
-
 const cache = new WeakMap()
 
 module.exports = function (options = {}) {
   if (cache.has(options)) {
     return cache.get(options)
   }
 
-  const { includes, excludes, shouldHandle } = options
+  const { inline, includes, excludes, shouldHandle } = options
+
+  const content = fs.readFileSync(
+    path.join(__dirname, '..', 'dist', inline ? 'index.inline.html' : 'index.html'),
+    'utf-8'
+  )
+
   const gateway = new Gateway({ includes, excludes, shouldHandle })
   const handler = function (req, res) {
     // set vary header for every response

examples/restc-example-koa2-inline/package.json

@@ -8,24 +8,16 @@
   "typings": "index.d.ts",
   "files": [
     "lib",
-    "faas",
+    "dist",
     "index.js",
     "index.d.ts"
   ],
   "scripts": {
+    "build": "mkdir -p dist && cp src/index.html dist/ && ./scripts/inline.php",
     "lint": "eslint .",
     "lint-fix": "eslint --fix .",
-    "test": "ava"
-  },
-  "faas": {
-    "domain": "restc",
-    "public": "faas",
-    "description": "A server-side middleware to visualize REST requests.",
-    "author_name": "lujjjh",
-    "author_email": "[email protected]",
-    "notice": [
-      "[email protected]"
-    ]
+    "test": "ava",
+    "prepack": "npm run build"
   },
   "devDependencies": {
     "ava": "^3.13.0",