Release: 0.2.0 (#62)

* Add an image to test

* Tests and dev files to npmignore

* Set rc1, require directory to be clean

* Add changelog

* Eslint

* Installation options

Author: ashwinvis

.eslintrc.yml

@@ -0,0 +1,253 @@
+env:
+  browser: true
+  commonjs: true
+  es6: true
+extends: 'eslint:recommended'
+globals:
+  Atomics: readonly
+  SharedArrayBuffer: readonly
+parserOptions:
+  ecmaVersion: 2018
+rules:
+  accessor-pairs: error
+  array-bracket-newline: error
+  array-bracket-spacing:
+    - error
+    - never
+  array-callback-return: error
+  array-element-newline: error
+  arrow-body-style: error
+  arrow-parens: error
+  arrow-spacing: error
+  block-scoped-var: error
+  block-spacing: error
+  brace-style: 'off'
+  callback-return: error
+  camelcase: error
+  capitalized-comments: 'off'
+  class-methods-use-this: error
+  comma-dangle: 'off'
+  comma-spacing:
+    - error
+    - after: true
+      before: false
+  comma-style:
+    - error
+    - last
+  complexity: error
+  computed-property-spacing:
+    - error
+    - never
+  consistent-return: 'off'
+  consistent-this: error
+  curly: 'off'
+  default-case: error
+  dot-location:
+    - error
+    - property
+  dot-notation: error
+  eol-last: error
+  eqeqeq: error
+  func-call-spacing: error
+  func-name-matching: error
+  func-names: 'off'
+  func-style:
+    - error
+    - declaration
+  function-paren-newline: error
+  generator-star-spacing: error
+  global-require: 'off'
+  guard-for-in: error
+  handle-callback-err: error
+  id-blacklist: error
+  id-length: 'off'
+  id-match: error
+  implicit-arrow-linebreak: error
+  indent: 'off'
+  indent-legacy: 'off'
+  init-declarations: error
+  jsx-quotes: error
+  key-spacing: error
+  keyword-spacing: 'off'
+  line-comment-position: 'off'
+  linebreak-style:
+    - error
+    - unix
+  lines-around-comment: error
+  lines-around-directive: 'off'
+  lines-between-class-members: error
+  max-classes-per-file: error
+  max-depth: error
+  max-len: 'off'
+  max-lines: error
+  max-lines-per-function: error
+  max-nested-callbacks: error
+  max-params: error
+  max-statements: 'off'
+  max-statements-per-line: error
+  multiline-comment-style:
+    - error
+    - separate-lines
+  new-cap: error
+  new-parens: error
+  newline-after-var: 'off'
+  newline-before-return: 'off'
+  newline-per-chained-call: 'off'
+  no-alert: error
+  no-array-constructor: error
+  no-await-in-loop: error
+  no-bitwise: error
+  no-buffer-constructor: error
+  no-caller: error
+  no-catch-shadow: error
+  no-confusing-arrow: error
+  no-console: 'off'
+  no-continue: error
+  no-div-regex: error
+  no-duplicate-imports: error
+  no-else-return: error
+  no-empty-function: 'off'
+  no-eq-null: error
+  no-eval: error
+  no-extend-native: error
+  no-extra-bind: error
+  no-extra-label: error
+  no-extra-parens: error
+  no-floating-decimal: error
+  no-implicit-coercion: error
+  no-implicit-globals: error
+  no-implied-eval: error
+  no-inline-comments: 'off'
+  no-invalid-this: error
+  no-iterator: error
+  no-label-var: error
+  no-labels: error
+  no-lone-blocks: error
+  no-lonely-if: error
+  no-loop-func: error
+  no-magic-numbers: 'off'
+  no-mixed-operators: error
+  no-mixed-requires: 'off'
+  no-multi-assign: error
+  no-multi-spaces:
+    - error
+    - ignoreEOLComments: true
+  no-multi-str: error
+  no-multiple-empty-lines: error
+  no-native-reassign: error
+  no-negated-condition: error
+  no-negated-in-lhs: error
+  no-nested-ternary: error
+  no-new: error
+  no-new-func: error
+  no-new-object: error
+  no-new-require: error
+  no-new-wrappers: error
+  no-octal-escape: error
+  no-param-reassign: error
+  no-path-concat: 'off'
+  no-plusplus: error
+  no-process-env: 'off'
+  no-process-exit: 'off'
+  no-proto: error
+  no-restricted-globals: error
+  no-restricted-imports: error
+  no-restricted-modules: error
+  no-restricted-properties: error
+  no-restricted-syntax: error
+  no-return-assign: error
+  no-return-await: error
+  no-script-url: error
+  no-self-compare: error
+  no-sequences: error
+  no-shadow: error
+  no-spaced-func: error
+  no-sync: 'off'
+  no-tabs: error
+  no-template-curly-in-string: error
+  no-ternary: 'off'
+  no-throw-literal: error
+  no-trailing-spaces: error
+  no-undef-init: error
+  no-undefined: error
+  no-underscore-dangle: error
+  no-unmodified-loop-condition: error
+  no-unneeded-ternary: error
+  no-unused-expressions: error
+  no-use-before-define: 'off'
+  no-useless-call: error
+  no-useless-computed-key: error
+  no-useless-concat: error
+  no-useless-constructor: error
+  no-useless-rename: error
+  no-useless-return: error
+  no-var: error
+  no-void: error
+  no-warning-comments: error
+  no-whitespace-before-property: error
+  nonblock-statement-body-position: error
+  object-curly-newline: error
+  object-curly-spacing: 'off'
+  object-shorthand: 'off'
+  one-var: 'off'
+  one-var-declaration-per-line: error
+  operator-assignment:
+    - error
+    - always
+  operator-linebreak: error
+  padded-blocks: 'off'
+  padding-line-between-statements: error
+  prefer-arrow-callback: 'off'
+  prefer-const: 'off'
+  prefer-destructuring: 'off'
+  prefer-named-capture-group: 'off'
+  prefer-numeric-literals: error
+  prefer-object-spread: error
+  prefer-promise-reject-errors: error
+  prefer-reflect: error
+  prefer-rest-params: error
+  prefer-spread: error
+  prefer-template: 'off'
+  quote-props: 'off'
+  quotes: 'off'
+  radix: error
+  require-await: error
+  require-jsdoc: 'off'
+  require-unicode-regexp: 'off'
+  rest-spread-spacing: error
+  semi: 'off'
+  semi-spacing: error
+  semi-style:
+    - error
+    - last
+  sort-imports: error
+  sort-keys: 'off'
+  sort-vars: 'off'
+  space-before-blocks: 'off'
+  space-before-function-paren: 'off'
+  space-in-parens:
+    - error
+    - never
+  space-infix-ops: 'off'
+  space-unary-ops: error
+  spaced-comment:
+    - error
+    - always
+  strict: error
+  switch-colon-spacing: error
+  symbol-description: error
+  template-curly-spacing:
+    - error
+    - never
+  template-tag-spacing: error
+  unicode-bom:
+    - error
+    - never
+  valid-jsdoc: error
+  vars-on-top: error
+  wrap-iife: error
+  wrap-regex: 'off'
+  yield-star-spacing: error
+  yoda:
+    - error
+    - never

.github/ISSUE_TEMPLATE.md

@@ -11,8 +11,8 @@
 
 ## 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
+Run `npm test&; sleep 5; npm stop` or at least equivalent of
+`cd tests; cat test_math.md | instant-markdown-d --mathjax --debug` and paste the
 console output here:
 
 ```sh

.npmignore

@@ -0,0 +1,3 @@
+tests/
+.github/
+.travis.yml

CHANGELOG.md

@@ -0,0 +1,14 @@
+# 0.2.0.rc1 (2017-07-19)
+
+* Optional MathJax support
+* Apache 2.0 license
+* Mount `__dirname` directory to serve images etc.
+* Browser port configuration
+* Debug option
+* Tests, CI
+* Issue template
+* ECMA6 upgrade, support only node>=8
+
+# 0.1.1 (2017-07-19)
+
+* Bug fix for windows

README.md

@@ -4,8 +4,18 @@ instant-markdown-d is a small Node.js server that enables instant compilation an
 
 Installation
 ------------
+
+Install the mini-server by running either:
+
 - `[sudo] npm -g install instant-markdown-d`
 
+or pre-release version
+
+- `[sudo] npm -g install instant-markdown-d@next`
+
+see [vim-instant-markdown](https://github.com/suan/vim-instant-markdown) for
+Vim / Neovim integration.
+
 REST API
 --------
 | Action           | HTTP Method | Request URL               | Request Body |

instant-markdown-d

@@ -1,5 +1,9 @@
 #!/usr/bin/env node
 "use strict";
+// node builtins
+const process = require('process');
+
+
 const MarkdownIt = require('markdown-it');
 const hljs = require('highlight.js');
 const server = require('http').createServer(httpHandler),
@@ -30,7 +34,7 @@ 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
+  --debug            Be verbose and do not open browser
   -V, --version      Display version
   -h, --help         Display help\
   `);

package.json

@@ -6,7 +6,7 @@
     "url": "git+https://github.com/suan/instant-markdown-d.git"
   },
   "description": "Instantly-updating Markdown Server",
-  "version": "0.2.0",
+  "version": "0.2.0-rc.1",
   "license": "Apache-2.0",
   "homepage": "https://github.com/suan/instant-markdown-d",
   "engines": {
@@ -20,8 +20,9 @@
   "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"
+    "test": "cd tests; cat test_math.md | instant-markdown-d --mathjax --debug",
+    "stop": "curl -X DELETE -s -w 'status: %{http_code}' -m 3 localhost:8090",
+    "prepare": "npm run build; git clean -f;"
   },
   "dependencies": {
     "highlight.js": "^9.15.6",

tests/images/test_img.png

@@ -1,10 +1,12 @@
+![](images/test_img.png)
+
 ```python
 import this
 ```
 
 # Inline equations
 
-$\Sigma_{i=0}^\infty \frac{1}{n} = 2$ is a fact. However: 
+$\Sigma_{i=0}^\infty \frac{1}{n} = 2$ is a fact. However:
 
 $$\sin x = 12$$
 

tests/test_math.md

@@ -1,2 +1,2 @@
 // generated by genversion
-module.exports = '0.2.0'
+module.exports = '0.2.0-rc.1'