ECMAscript 6 upgrade and options for custom browser, port (#60)

ashwinvis · web-flow · commit e8c82041ff60 · 2019-07-19T18:25:48.000+02:00
* Add darkness theme.

* Node upgrade dependencies

* Barely working mathjax rendering using node.js

* Cache mathjax css and make it a command line option

* Put darkness theme css back in

* mount current working directory to serve static files

* Allow use of local mathjax fonts

* Use strict; var -&gt; const and let

* Move mathjax-node-page config out of function scope

* No line break (word wrap) and justify

* Use serif font in darkness theme

* Add minimalist

* Add github-markdown.css, remove deprecated send syntax, upgrade npm packages

* Add markdown-it-task-lists plugin

* Use minimist to parse --mathjax

* Genversion

* Implement minimist, help, version, browser options

* Add port option

* Yarn build genversion and remove github-markdown-css

* Put all css together

* Fix xdg-open bug again

* Travis configuration and tests

* Sleep more, test more

* Use npm alone, avoid npx

* Curl fail

* Curl be silent

* Clean exit on DELETE request

* Add title tag

* Add issue template
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,39 @@
+# Problem summary
+
+## Expected
+
+
+## Environment Information
+
+ * OS:
+ * Vim / Neovim version:
+ * Browser:
+
+## Provide the output of test command (required)
+
+Run `npm test&; sleep 5; npm stop` or at least equivalent of `cat
+tests/test_math.md | instant-markdown-d --mathjax --debug` and paste the
+console output here:
+
+```sh
+
+```
+
+## Generate logfiles if appropriate
+
+ 1. package-lock.json / yarn.lock
+ 2. minimal `~/.vimrc` or `~/.config/nvim/init.vim` where variables for `vim-instant-markdown` defined
+ 3. `debug.html`
+
+## Steps to reproduce the issue (required)
+
+Start with command you used to install `instant-markdown-d`
+
+ 1.
+ 2.
+ 3.
+
+
+## Screen shot (if possible)
+
+
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,5 @@
 node_modules
 package-lock.json
+yarn.lock
+yarn*.log
+debug.html
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,15 @@
+language: node_js
+node_js:
+  - node
+  - lts/*
+  - "8"
+
+install:
+  - npm install -g .
+before_script:
+  - npm run-script build
+script:
+  - instant-markdown-d --version
+  - npm test &
+  - sleep 5
+  - npm stop
diff --git a/css/github-markdown.css b/css/github-markdown.css
diff --git a/css/github-syntax-highlight.css b/css/github-syntax-highlight.css
diff --git a/css/themes/darkness/github-markdown.css b/css/themes/darkness/github-markdown.css
@@ -0,0 +1,9 @@
+/* Set black background for code block */
+.markdown-body {
+  font-family: serif;
+}
+.markdown-body .highlight pre,
+.markdown-body pre {
+  color: #fff;
+  background-color: #18171b;
+}
diff --git a/css/themes/darkness/github-syntax-highlight.css b/css/themes/darkness/github-syntax-highlight.css
@@ -0,0 +1,11 @@
+/* Remove back ground and set font color  for diff items */
+.hljs-deletion {
+  background: transparent;
+  color: #900;
+
+}
+
+.hljs-addition {
+  background: transparent;
+  color: #009926;
+}
diff --git a/index.html b/index.html
@@ -1,11 +1,12 @@
 <!DOCTYPE html>
 <html lang="en" class="">
 <head>
+  <title>instant-markdown-d</title>
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta http-equiv="Content-Language" content="en">
-  <link rel="stylesheet" type="text/css" href="/github-syntax-highlight.css">
-  <link rel="stylesheet" type="text/css" href="/github-markdown.css">
+  <link rel="stylesheet" type="text/css" href="/css/github-syntax-highlight.css">
+  <link rel="stylesheet" type="text/css" href="/css/github-markdown.css">
   <link rel="stylesheet" type="text/css" href="/css/mjpage-html.css">
   <style>
     .markdown-body {
@@ -29,7 +30,7 @@
       setDisconnected(false);
       socket.on('newContent', function(newHTML) {
         document.querySelector(".markdown-body").innerHTML = newHTML;
-        
+
         // scroll to the hyperlink with id="marker"
         let marker = document.getElementById("marker");
         if(marker) {
diff --git a/instant-markdown-d b/instant-markdown-d
@@ -1,29 +1,57 @@
 #!/usr/bin/env node
-
-var MarkdownIt = require('markdown-it');
-var hljs = require('highlight.js');
-var server = require('http').createServer(httpHandler),
+"use strict";
+const MarkdownIt = require('markdown-it');
+const hljs = require('highlight.js');
+const server = require('http').createServer(httpHandler),
     exec = require('child_process').exec,
     io = require('socket.io').listen(server),
     os = require('os'),
+    fs = require('fs'),
     send = require('send');
 
-var mjpage = require('mathjax-node-page').mjpage;
-// var fs = require('fs');  // for debugging
-var enableMathJax = process.argv[2] === "--mathjax";
+const mjpage = require('mathjax-node-page').mjpage;
+const taskLists = require('markdown-it-task-lists');
+const argv = require('minimist')(process.argv.slice(2), {
+  string: ['browser'],
+  default: {port: 8090, debug: false},
+  alias: {V: 'version', h: 'help'},
+});
+
+if (argv.version || argv.debug) {
+  const version= require('./version');
+  console.log(`instant-mardown-d version: v${version}`);
+  console.log(`nodejs version: ${process.version}`);
+}
+if (argv.help) {
+  console.log(`\
+Usage: instant-markdown-d [OPTIONS]
+
+Options:
+  --mathjax          Enable MathJax parsing
+  --browser BROWSER  Use a custom browser
+  --port PORT        Use a custom port (default: 8090)
+  --debug           Be verbose and do not open browser
+  -V, --version      Display version
+  -h, --help         Display help\
+  `);
+}
+if (argv.version || argv.help) process.exit(0);
 
+if (argv.verbose) console.dir(argv);
+
+// console.dir(argv);
 // WARNING: By setting this environment variable, anyone on your network may
 // run arbitrary code in your browser and read arbitrary files in the working
 // directory of the open file!
 if (process.env.INSTANT_MARKDOWN_OPEN_TO_THE_WORLD) {
   // Listen on any interface.
-  server.listen(8090, onListening).once('error', onServerError);
+  server.listen(argv.port, onListening).once('error', onServerError);
 } else {
   // Listen locally.
-  server.listen(8090, '127.0.0.1', onListening).once('error', onServerError);
+  server.listen(argv.port, '127.0.0.1', onListening).once('error', onServerError);
 }
 
-var md = new MarkdownIt({
+let md = new MarkdownIt({
   html: true,
   linkify: true,
   highlight: function(str, lang) {
@@ -37,9 +65,9 @@ var md = new MarkdownIt({
       return str;
     }
   }
-});
+}).use(taskLists);
 
-if (enableMathJax) md.use(require('markdown-it-mathjax')());
+if (argv.mathjax) md.use(require('markdown-it-mathjax')());
 
 const mjPageConfig = {
   format: ["TeX"],
@@ -59,14 +87,17 @@ const mjNodeConfig = {
 };
 
 function mathJaxRenderEmit(newHtml) {
-  if(enableMathJax) {
+  if(argv.mathjax) {
     mjpage(
       newHtml,
       mjPageConfig,
       mjNodeConfig,
       function(data) {
-          // console.log(data); // resulting HTML string
-          // fs.writeFileSync('output.html', data, 'utf-8'); // debug
+          if (argv.debug) {
+            console.log("Rendered html saved as debug.html")
+            // console.log(data); // resulting HTML string
+            fs.writeFileSync('debug.html', data, 'utf-8'); // debug
+          }
           io.sockets.emit('newContent', data);
       }
     );
@@ -76,14 +107,14 @@ function mathJaxRenderEmit(newHtml) {
   }
 }
 
-var lastWrittenMarkdown = '';
+let lastWrittenMarkdown = '';
 function writeMarkdown(body) {
   lastWrittenMarkdown = md.render(body);
   mathJaxRenderEmit(lastWrittenMarkdown);
 }
 
 function readAllInput(input, callback) {
-  var body = '';
+  let body = '';
   input.on('data', function(data) {
     body += data;
     if (body.length > 1e6) {
@@ -96,12 +127,12 @@ function readAllInput(input, callback) {
 }
 
 function addSecurityHeaders(req, res, isIndexFile) {
-  var csp = [];
+  let csp = [];
 
   // Cannot use 'self' because Chrome does not treat 'self' as http://host
   // when the sandbox directive is set.
-  var HTTP_HOST = req.headers.host || 'localhost:8090';
-  var CSP_SELF = 'http://' + HTTP_HOST;
+  let HTTP_HOST = req.headers.host || 'localhost:' + argv.port;
+  let CSP_SELF = 'http://' + HTTP_HOST;
 
   if (!process.env.INSTANT_MARKDOWN_ALLOW_UNSAFE_CONTENT) {
     if (isIndexFile) {
@@ -131,35 +162,39 @@ function httpHandler(req, res) {
   {
     case 'GET':
       // Example: /my-repo/raw/master/sub-dir/some.png
-      var githubUrl = req.url.match(/\/[^\/]+\/raw\/[^\/]+\/(.+)/);
+      let githubUrl = req.url.match(/\/[^\/]+\/raw\/[^\/]+\/(.+)/);
       if (githubUrl) {
         addSecurityHeaders(req, res, false);
          // Serve the file out of the current working directory
-        send(req, githubUrl[1])
-         .root(process.cwd())
+        send(req, githubUrl[1], {root: process.cwd()})
          .pipe(res);
         return;
       }
 
-      var isIndexFile = /^\/(index\.html)?(\?|$)/.test(req.url);
+      let isIndexFile = /^\/(index\.html)?(\?|$)/.test(req.url);
       addSecurityHeaders(req, res, isIndexFile);
 
+      let cwd = process.cwd();
+      let mount = cwd && !fs.existsSync(__dirname + req.url) ? cwd : __dirname;
+
       // Otherwise serve the file from the directory this module is in
-      send(req, req.url)
-        .root(__dirname)
+      send(req, req.url, {root: mount})
         .pipe(res);
       break;
 
     // case 'HEAD':
       // res.writeHead(200);
       // res.end();
-      // exec('open -g http://localhost:8090', function(error, stdout, stderr){
-        // http.request({port: 8090})
+      // exec('open -g http://localhost:' + argv.port, function(error, stdout, stderr){
+        // http.request({port: argv.port})
       // });
       // break;
 
     case 'DELETE':
+      res.setHeader('Content-Type', 'text/plain');
+      res.writeHead(204, { 'Content-Type': 'text/plain' });
       io.sockets.emit('die');
+      res.end('ok')
       process.exit();
       break;
 
@@ -177,18 +212,26 @@ io.sockets.on('connection', function(sock){
   process.stdout.write('connection established!');
   if (lastWrittenMarkdown) {
     sock.emit('newContent', lastWrittenMarkdown);  // Quick preview
-    if (enableMathJax) mathJaxRenderEmit(lastWrittenMarkdown);
+    if (argv.mathjax) mathJaxRenderEmit(lastWrittenMarkdown);
   }
 });
 
 
 function onListening() {
-  if (os.platform() === 'win32') {
-    exec('start /b http://localhost:8090', function(error, stdout, stderr){});
-  } else if (os.platform() === 'darwin') {
-    exec('open -g http://localhost:8090', function(error, stdout, stderr){});
-  } else { // assume unix/linux
-    exec('xdg-open http://localhost:8090/', function(error, stdout, stderr){});
+  if (!argv.browser) {
+    if (os.platform() === 'win32') {
+      argv.browser = 'start /b';
+    } else if (os.platform() === 'darwin') {
+      argv.browser = 'open -g';
+    } else { // assume unix/linux
+      argv.browser = 'xdg-open';
+    }
+  }
+  let cmd = argv.browser + ' http://localhost:' + argv.port + '/';
+  if (argv.debug) {
+    console.log("Run the following to manually open browser: \n    " + cmd);
+  } else {
+    exec(cmd, function(error, stdout, stderr){});
   }
   readAllInput(process.stdin, function(body) {
     writeMarkdown(body);
@@ -202,7 +245,7 @@ function onServerError(e) {
       // Forward to existing instant-markdown-d server.
       require('http').request({
         hostname: 'localhost',
-        port: 8090,
+        port: argv.port,
         path: '/',
         method: 'PUT',
       }).end(body);
diff --git a/package.json b/package.json
@@ -1,27 +1,40 @@
 {
   "author": "Suan-Aik Yeo <yeosuanaik@gmail.com>",
   "name": "instant-markdown-d",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/suan/instant-markdown-d.git"
+  },
   "description": "Instantly-updating Markdown Server",
   "version": "0.2.0",
   "license": "Apache-2.0",
   "homepage": "https://github.com/suan/instant-markdown-d",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/suan/instant-markdown-d.git"
+  "engines": {
+    "node": ">=8.0.0"
   },
-  "engine": "node",
   "main": "instant-markdown-d",
   "preferGlobal": "true",
   "bin": {
     "instant-markdown-d": "./instant-markdown-d"
   },
+  "scripts": {
+    "start": "./instant-markdown-d",
+    "build": "genversion ./version.js",
+    "test": "cat tests/test_math.md | instant-markdown-d --mathjax --debug",
+    "stop": "curl -X DELETE -s -w 'status: %{http_code}' -m 3 localhost:8090"
+  },
   "dependencies": {
-    "highlight.js": "^9.13.0",
+    "highlight.js": "^9.15.6",
     "markdown-it": "^8.4.2",
     "markdown-it-mathjax": "^2.0.0",
-    "mathjax-node-page": "^3.0.1",
+    "markdown-it-task-lists": "^2.1.1",
     "mathjax": "^2.7.5",
-    "send": "~0.16.2",
-    "socket.io": "^2.1.1"
+    "mathjax-node-page": "^3.0.2",
+    "minimist": "^1.2.0",
+    "send": "~0.17.1",
+    "socket.io": "^2.2.0"
+  },
+  "devDependencies": {
+    "genversion": "^2.1.1"
   }
 }
diff --git a/tests/test_math.md b/tests/test_math.md
diff --git a/version.js b/version.js
