@cilix/lightjs 0.0.1 → 0.0.2

package/README.md

@@ -56,32 +56,170 @@ Light.js is **alpha** software. This documentation is a work in progress, but it
 ## Table of Contents
 
 - [Quick Start](#quick-start)
+- [Usage](#usage)
 - [Syntax](#syntax)
 - [Document](#document)
 - [Data](#data)
 - [Control Flow](#control-flow)
 - [Components](#components)
 - [Javascript](#javascript)
-- [Usage](#usage)
 
 ## Quick Start
 
-Create a project boilerplate using Light.js's built-in backend router:
+Create a project boilerplate using Light.js's built-in backend router. Usage below:
 
 ```bash
 npx lightjs create my-app
 ```
 
-Light.js is extremely flexible and can be used with any backend. Use the following command to create the same boilerplate but using Express instead:
+## Usage
 
-```bash
-npx lightjs create my-app --express
+### `lightjs.compile()`
+
+Fundamentally, Light.js is a library that takes in a Light.js source tree and outputs a single HTML file or string.
+
+```javascript
+const lightjs = require('lightjs');
+
+lightjs.compile({
+  input: 'src/index.lightjs',
+  output: 'public/index.html'
+});
 ```
 
-And for the smallest possible boilerplate, use this command:
+No other step is required for a fully reactive, bundled, minified application.
 
-```bash
-npx lightjs create my-app --lean
+This function may also be used to serve dynamic content in real time.
+
+```javascript
+const express = require('express');
+const lightjs = require('lightjs');
+
+const app = express();
+
+app.get('/', async (req, res) => {
+  const html = await lightjs.compile({
+    input: 'src/index.lightjs'
+  });
+  res.end(html);
+});
+
+app.listen(3838);
+```
+
+In order for the above example to have production quality speed, you must enable caching. And if desired, Javascript minification can be enabled as well:
+
+```javascript
+const html = await lightjs.compile({
+  input: 'src/index.lightjs',
+  cache: true,
+  minify: true
+});
+```
+
+The last thing to know about Light.js's compile function is document data.
+
+```javascript
+const html = await lightjs.compile({
+  input: 'src/about.lightjs',
+  data: {
+    pageTitle: 'About me'
+  }
+});
+```
+
+In your Light.js document pageTitle can be found on the global 'data' object:
+
+```javascript
+// index.lightjs
+html [
+  head []
+  body [
+    h1 '{{data.pageTitle}}'
+  ]
+]
+```
+
+### `lightjs.app()`
+
+As mentioned above, Light.js ships with a built-in backend router. This router is exposed through the 'app' function, which returns a Node.js HTTP request handler.
+
+```javascript
+const http = require('http');
+const light = require('lightjs');
+
+const PORT = 4477;
+
+const app = light.app({
+  publicDir: './public',
+  cache: true,
+  minify: true,
+  routes: {
+    // map a route directly to a light file
+    '/': 'src/index.light',
+
+    // or for more complex arrangements, you can map the route to the same arguments you would pass to light.compile()
+    '/blog/:id': {
+      input: 'src/blog.light',
+      data: async (req) => {
+        const post = 'hi' // get blog post with req.params.id
+        return post
+      }
+    }
+  }
+})
+
+http.createServer(app).listen(PORT);
+```
+
+Light.js's router is also completely compatible with Express:
+
+```javascript
+const http = require('http');
+const light = require('lightjs');
+const express = require('express');
+
+const PORT = 4477;
+
+const app = express();
+
+const lightRouter = light.app({
+  cache: true,
+  minify: true,
+  routes: {
+    // ...
+  }
+})
+
+app.use(express.static('public'));
+app.use(lightRouter);
+
+http.createServer(app).listen(PORT);
+```
+
+Or, as previously mentioned, you can simply use `light.compile` with Express:
+
+```javascript
+const http = require('http');
+const light = require('lightjs');
+const express = require('express');
+
+const PORT = 4477;
+
+const app = express();
+
+app.get('/', async (req, res) => {
+  const html = await light.compile({
+    input: 'src/index.light',
+    // for production
+    minify: true,
+    cache: true
+  });
+
+  res.end(html);
+});
+
+http.createServer(app).listen(PORT);
 ```
 
 ## Syntax
@@ -856,155 +994,6 @@ html [
 ]
 ```
 
-## Usage
-
-### `lightjs.compile()`
-
-Fundamentally, Light.js is a library that takes in a Light.js source tree and outputs a single HTML file or string.
-
-```javascript
-const lightjs = require('lightjs');
-
-lightjs.compile({
-  input: 'src/index.lightjs',
-  output: 'public/index.html'
-});
-```
-
-No other step is required for a fully reactive, bundled, minified application.
-
-This function may also be used to serve dynamic content in real time.
-
-```javascript
-const express = require('express');
-const lightjs = require('lightjs');
-
-const app = express();
-
-app.get('/', async (req, res) => {
-  const html = await lightjs.compile({
-    input: 'src/index.lightjs'
-  });
-  res.end(html);
-});
-
-app.listen(3838);
-```
-
-In order for the above example to have production quality speed, you must enable caching. And if desired, Javascript minification can be enabled as well:
-
-```javascript
-const html = await lightjs.compile({
-  input: 'src/index.lightjs',
-  cache: true,
-  minify: true
-});
-```
-
-The last thing to know about Light.js's compile function is document data.
-
-```javascript
-const html = await lightjs.compile({
-  input: 'src/about.lightjs',
-  data: {
-    pageTitle: 'About me'
-  }
-});
-```
-
-In your Light.js document pageTitle can be found on the global 'data' object:
-
-```javascript
-// index.lightjs
-html [
-  head []
-  body [
-    h1 '{{data.pageTitle}}'
-  ]
-]
-```
-
-### `lightjs.app()`
-
-As mentioned above, Light.js ships with a built-in backend router. This router is exposed through the 'app' function, which returns a Node.js HTTP request handler.
-
-```javascript
-const http = require('http');
-const light = require('lightjs');
-
-const PORT = 4477;
-
-const app = light.app({
-  publicDir: './public',
-  cache: true,
-  minify: true,
-  routes: {
-    // map a route directly to a light file
-    '/': 'src/index.light',
-
-    // or for more complex arrangements, you can map the route to the same arguments you would pass to light.compile()
-    '/blog/:id': {
-      input: 'src/blog.light',
-      data: async (req) => {
-        const post = 'hi' // get blog post with req.params.id
-        return post
-      }
-    }
-  }
-})
-
-http.createServer(app).listen(PORT);
-```
-
-Light.js's router is also completely compatible with Express:
-
-```javascript
-const http = require('http');
-const light = require('lightjs');
-const express = require('express');
-
-const PORT = 4477;
-
-const app = express();
-
-const lightRouter = light.app({
-  cache: true,
-  minify: true,
-  routes: {
-    // ...
-  }
-})
-
-app.use(express.static('public'));
-app.use(lightRouter);
-
-http.createServer(app).listen(PORT);
-```
-
-Or, as previously mentioned, you can simply use `light.compile` with Express:
-
-```javascript
-const http = require('http');
-const light = require('lightjs');
-const express = require('express');
-
-const PORT = 4477;
-
-const app = express();
-
-app.get('/', async (req, res) => {
-  const html = await light.compile({
-    input: 'src/index.light',
-    // for production
-    minify: true,
-    cache: true
-  });
-
-  res.end(html);
-});
-
-http.createServer(app).listen(PORT);
-```
 
 This is the entire feature set of Lightjs. If there is even one aspect of Lightjs that is missing from this document, it is considered a bug.
 

package/index.js

@@ -167,12 +167,14 @@ const serveStaticFile = (p, res) => {
       return true;
     }
     const data = fs.readFileSync(p);
-    const mime = (mimeTypes[ext] || { source: 'text/plain' }).source;
+    const mime = mimeTypes[ext] || 'text/plain';
     res.writeHead(200, { 'Content-type': `${mime}` });
     res.end(data);
     return true;
   } catch (e) {
-    return false;
+    res.statusCode = 404;
+    res.end();
+    return true;
   }
 };
 
@@ -209,14 +211,6 @@ const parseBody = (req, max) => {
   });
 };
 
-const parseQuery = (p) => {
-  const purl = url.parse(p);
-  if (purl.query) {
-    return qs.parse(purl.query);
-  }
-  return {};
-};
-
 function matchRoute (istr, mstr) {
   if (mstr === '*') return {};
   const p0 = istr.split('/').filter(p => p);
@@ -286,12 +280,15 @@ Light.router = function (opts) {
     }
   }
   return async function (req, res, next) {
-    const url = req.url;
-    if (publicDir && serveStaticFile(path.join(publicDir, url), res)) {
+    const purl = url.parse(req.url);
+    if (publicDir && serveStaticFile(path.join(publicDir, purl.pathname), res)) {
       return;
     }
-    const query = parseQuery(url);
-    req.query = query;
+    if (purl.query) {
+      req.query = qs.parse(purl.query);
+    } else {
+      req.query = {};
+    }
     try {
       req.body = await parseBody(req, 1024 * 1024); // 1MB limit
     } catch (e) {
@@ -306,7 +303,7 @@ Light.router = function (opts) {
     let routeParams = {};
     let routeConfig = null;
     for (const [pattern, config] of Object.entries(routes)) {
-      const params = matchRoute(url, pattern);
+      const params = matchRoute(purl.pathname, pattern);
       if (params !== null) {
         matchedRoute = pattern;
         routeParams = params;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cilix/lightjs",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A new kind of JavaScript framework",
   "main": "index.js",
   "scripts": {