Update dependencies; remove fonts; test with KaTeX 0.8

Author: tatetian

.eslintrc

@@ -0,0 +1,83 @@
+{
+    "rules": {
+        "arrow-spacing": 2,
+        "brace-style": [2, "stroustrup", { "allowSingleLine": true }],
+        // We'd possibly like to remove the 'properties': 'never' one day.
+        "camelcase": [2, { "properties": "never" }],
+        "comma-dangle": [2, "always-multiline"],
+        "comma-spacing": [2, { "before": false, "after": true }],
+        "constructor-super": 2,
+        "curly": 0,
+        "eol-last": 2,
+        "eqeqeq": [2, "allow-null"],
+        "guard-for-in": 0,
+        "indent": [1, 4, {"SwitchCase": 1}],
+        "keyword-spacing": 2,
+        "linebreak-style": [2, "unix"],
+        "max-len": [2, 84, 4, { "ignoreUrls": true, "ignorePattern": "\\brequire\\([\"']|eslint-disable", "ignoreComments": true, }],
+        "no-alert": 2,
+        "no-array-constructor": 2,
+        "no-console": 2,
+        "no-const-assign": 2,
+        "no-constant-condition": 0,
+        "no-debugger": 2,
+        "no-dupe-class-members": 2,
+        "no-dupe-keys": 2,
+        "no-extra-bind": 2,
+        "no-new": 2,
+        "no-new-func": 2,
+        "no-new-object": 2,
+        "no-spaced-func": 2,
+        "no-this-before-super": 2,
+        "no-throw-literal": 0,
+        "no-trailing-spaces": 2,
+        "no-undef": 0,
+        "no-unexpected-multiline": 2,
+        "no-unreachable": 2,
+        "no-unused-vars": [2, {"args": "none", "varsIgnorePattern": "^_*$"}],
+        "no-useless-call": 2,
+        "no-with": 2,
+        "one-var": [2, "never"],
+        "prefer-const": 2,
+        "prefer-spread": 0, // re-enable once we use es6
+        "semi": [2, "always"],
+        "space-before-blocks": 2,
+        "space-before-function-paren": [2, "never"],
+        "space-infix-ops": 2,
+        "space-unary-ops": 2,
+        // ---------------------------------------
+        // Stuff we explicitly disable.
+        // We turned this off because it complains when you have a
+        // multi-line string, which I think is going too far.
+        "prefer-template": 0,
+        // We've decided explicitly not to care about this.
+        "arrow-parens": 0,
+        // ---------------------------------------
+        // TODO(csilvers): enable these if/when community agrees on it.
+        "prefer-arrow-callback": 0,
+        "object-curly-spacing": [0, "always"],
+        // Might be nice to turn this on one day, but since we don't
+        // use jsdoc anywhere it seems silly to require it yet.
+        "valid-jsdoc": 0,
+        "require-jsdoc": 0
+    },
+    "ecmaFeatures": {
+        "arrowFunctions": true,
+        "blockBindings": true,
+        "classes": true,
+        "destructuring": true,
+        "experimentalObjectRestSpread": true,
+        "forOf": true,
+        "jsx": true,
+        "restParams": true,
+        "spread": true,
+        "templateStrings": true
+    },
+    "env": {
+        "es6": true,
+        "node": true,
+        "browser": true
+    },
+    "extends": "eslint:recommended",
+    "root": true
+}

Makefile

@@ -1,49 +1,69 @@
-.PHONY: setup lint build zip build/pseudocode clean
+.PHONY: default setup lint build release clean
 
-build: lint build/pseudocode.min.js build/pseudocode.min.css
+VERSION=1.1
 
-setup: setup-katex
+# Building tools
+BROWSERIFY = $(realpath ./node_modules/.bin/browserify)
+WATCHIFY = $(realpath ./node_modules/.bin/watchify)
+UGLIFYJS = $(realpath ./node_modules/.bin/uglifyjs) \
+	--mangle \
+	--beautify \
+	ascii_only=true,beautify=false
+CLEANCSS = $(realpath ./node_modules/.bin/cleancss)
+ESLINT = $(realpath ./node_modules/.bin/eslint)
+
+default: build
+
+
+setup: static/katex/
 	npm install
-	mkdir -p build
-	ln -s ../static/fonts build/fonts
-	ln -s ../static/katex build/katex
+	@echo "> Node.js packages installed"
 
-setup-katex:
+static/katex/:
 	@rm -rf static/katex
-	cd static && wget https://github.com/Khan/KaTeX/releases/download/v0.2.0/katex.zip && unzip katex.zip
+	cd static && wget https://github.com/Khan/KaTeX/releases/download/v0.8.0/katex.zip && unzip katex.zip
 	@rm -rf static/katex.zip
+	@echo "> Katex downloaded"
 
-# Watch the changes to js source code and update the target js code
-watch-js: pseudocode.js $(wildcard src/*.js)
-	./node_modules/.bin/watchify $< --standalone pseudocode -o build/pseudocode.js
 
-clean:
-	rm -rf build/*
-	ln -s ../static/fonts build/fonts
+build: build/pseudocode.js build/pseudocode.css
+	@echo "> Building succeeded"
 
-zip: build/pseudocode-js.tar.gz build/pseudocode-js.zip
+build/pseudocode.min.js: build/pseudocode.js
+	$(UGLIFYJS) < $< > $@
+
+build/pseudocode.js: pseudocode.js $(wildcard src/*.js)
+	@$(MAKE) --no-print-directory lint
+	$(BROWSERIFY) $< --exclude katex --standalone pseudocode -o $@
 
 lint: pseudocode.js $(wildcard src/*.js)
-	./node_modules/.bin/jshint $^
+	$(ESLINT) $^
 
-build/pseudocode.js: pseudocode.js $(wildcard src/*.js)
-	./node_modules/.bin/browserify --exclude katex $< --standalone pseudocode -o $@
+# Watch the changes to js source code and update the target js code
+watch-js: pseudocode.js $(wildcard src/*.js)
+	$(WATCHIFY) $< --standalone pseudocode -o build/pseudocode.js
 
-build/pseudocode.min.js: build/pseudocode.js
-	./node_modules/.bin/uglifyjs --mangle --beautify beautify=false < $< > $@
+build/pseudocode.min.css: build/pseudocode.css
+	$(CLEANCSS) -o $@ $<
 
 build/pseudocode.css: static/pseudocode.css
 	cp static/pseudocode.css build/pseudocode.css
 
-build/pseudocode.min.css: build/pseudocode.css
-	./node_modules/.bin/cleancss -o $@ $<
 
-build/pseudocode: build/pseudocode.min.js build/pseudocode.min.css README.md
-	mkdir -p build/pseudocode
-	cp -r $^ build/pseudocode
+release: build/pseudocode-js.tar.gz build/pseudocode-js.zip
+	@echo "> Release package generated"
 
-build/pseudocode-js.tar.gz: build/pseudocode
-	cd build && cp -r fonts pseudocode/ && tar czf pseudocode-js.tar.gz pseudocode/
+RELEASE_DIR=pseudocode-$(VERSION)/
+build/pseudocode-js.tar.gz: build/$(RELEASE_DIR)
+	cd build && tar czf pseudocode-js.tar.gz $(RELEASE_DIR)
 
-build/pseudocode-js.zip: build/pseudocode
-	cd build && cp -r fonts pseudocode && zip -rq pseudocode-js.zip pseudocode/
+build/pseudocode-js.zip: build/$(RELEASE_DIR)
+	cd build && zip -rq pseudocode-js.zip $(RELEASE_DIR)
+
+build/$(RELEASE_DIR): build/pseudocode.min.js build/pseudocode.min.css README.md
+	mkdir -p build/$(RELEASE_DIR)
+	cp -r $^ build/$(RELEASE_DIR)
+
+
+clean:
+	@rm -rf build/*

README.md

@@ -12,15 +12,15 @@ HTML.
 * **Math formula support:** Inserting math formulas in pseudocode.js is as easy 
   as LaTeX. Just enclose math expression in `$...$` or `\(...\)`.
 
-It supports all modern browsers, including Chrome, Safari, 
-Firefox, Opera, and IE 8 - IE 11.
-        
+It supports all modern browsers, including Chrome, Safari, Firefox, Edge, and
+IE 9 - IE 11.
+
 ## Demo
 Visit the [project website](http://www.tatetian.io/pseudocode.js) for demo.
 
 ## Usage
 
-### Basics
+### Quick Start
 Download [pseudocode.js](https://github.com/tatetian/pseudocode.js/releases), 
 and host the files on your server. And then include the `js` and `css` files in 
 your HTML files:
@@ -30,11 +30,9 @@ your HTML files:
 <script src="//path/to/pseudocode/pseudocode.min.js"></script>
 ```
 
-Pseudocode.js uses [KaTeX](https://github.com/Khan/KaTeX) to render math 
-formulas. So if you want to include any math formulas in
-your pseudocode, make sure that [KaTeX is 
-setup](https://github.com/Khan/KaTeX#usage).
-
+Pseudocode.js depends on [KaTeX](https://github.com/Khan/KaTeX) to render math 
+formulas and uses KaTeX's fonts to render texts. So make sure that [KaTeX is 
+setup](https://github.com/Khan/KaTeX#usage) properly.
 
 Assume the pseudocode to be rendered is in a `<pre>` DOM element:
 ```html
@@ -218,6 +216,23 @@ var DEFAULT_OPTIONS = {
     captionCount: undefined
 };
 ```
+
+## Build and Test
+Pseudocode.js is written in JavaScript and built with [Node.js](https://nodejs.org).
+So, make sure you have Node.js installed before building pseudocode.js.
+
+To compile the project on Ubuntu Linux, run the following commands in terminal:
+
+```bash
+cd pseudocode.js/
+make setup
+make
+```
+
+Then, open `static/test-suite.html` in your favourite browser to see whether 
+algorithms are typeset correctly.
+
+
 ## Author
 Tate Tian ([@tatetian](https://github.com/tatetian)) creates pseudocode.js. Any 
 suggestions and bug reports are welcome.

package.json

@@ -17,12 +17,11 @@
         "src/"
     ],
     "devDependencies": {
-        "browserify": "~9.0.3",
-        "watchify": "~2.4.0",
-        "uglify-js": "~2.4.15",
-        "clean-css": "~2.2.15",
-        "jshint": "^2.5.6",
-        "katex": "~0.1.1"
+        "browserify": "^13.3.0",
+        "watchify": "^3.9.0",
+        "uglify-js": "~2.7.5",
+        "clean-css-cli": "^4.0.0",
+        "eslint": "^3.13.0"
     },
     "license": "MIT"
 }

pseudocode.js

@@ -1,9 +1,5 @@
 /*
  * The entry points of pseudocode-js
- *
- * TODO:
- *      * Test on IE8 - IE10
- *      * Support color
  **/
 
 var ParseError = require('./src/ParseError');
@@ -32,5 +28,5 @@ module.exports = {
         var ele = renderer.toDOM();
         if (baseDomEle) baseDomEle.appendChild(ele);
         return ele;
-    }
+    },
 };

src/Lexer.js

@@ -26,11 +26,11 @@ Lexer.prototype.expect = function(type, text) {
     // The next atom is NOT of the right type
     if (nextAtom.type !== type)
         throw new ParseError('Expect an atom of ' + type + ' but received ' +
-                             nextAtom.type, this._pos, this._input);
+            nextAtom.type, this._pos, this._input);
     // Check whether the text is exactly the same
     if (!this._matchText(text))
-            throw new ParseError('Expect `' + text + '` but received `' +
-                                 nextAtom.text + '`', this._pos, this._input);
+        throw new ParseError('Expect `' + text + '` but received `' +
+            nextAtom.text + '`', this._pos, this._input);
 
     this._next();
     return this._currentAtom.text;
@@ -48,7 +48,7 @@ var mathPattern = {
     exec: function(str) {
         var delimiters = [
             {start: '$', end: '$'},
-            {start: '\\(', end: '\\)'}
+            {start: '\\(', end: '\\)'},
         ];
         var totalLen = str.length;
 
@@ -62,7 +62,8 @@ var mathPattern = {
             while (endPos < totalLen) {
                 var pos = remain.indexOf(endDel);
                 if (pos < 0)
-                    throw new ParseError('Math environment is not closed', this._pos, this._input);
+                    throw new ParseError('Math environment is not closed',
+                        this._pos, this._input);
 
                 // false positive, it's escaped, not a match
                 if (pos > 0 && remain[pos - 1] === '\\') {
@@ -73,13 +74,13 @@ var mathPattern = {
                 }
 
                 var res = [str.slice(0, endPos + pos + endDel.length),
-                        str.slice(startDel.length, endPos + pos)];
+                    str.slice(startDel.length, endPos + pos)];
                 return res;
             }
         }
 
         return null;
-    }
+    },
 };
 var atomRegex = {
     // TODO: which is correct? func: /^\\(?:[a-zA-Z]+|.)/,
@@ -89,7 +90,7 @@ var atomRegex = {
     open: /^\{/,
     close: /^\}/,
     quote: /^(`|``|'|'')/,
-    ordinary: /^[^\\{}$&#%_\s]+/
+    ordinary: /^[^\\{}$&#%_\s]+/,
 };
 var commentRegex = /^%.*/;
 var whitespaceRegex = /^\s+/;
@@ -126,7 +127,7 @@ Lexer.prototype._next = function() {
         this._nextAtom = {
             type: 'EOF',
             text: null,
-            whitespace: false
+            whitespace: false,
         };
         return false;
     }
@@ -145,7 +146,7 @@ Lexer.prototype._next = function() {
         this._nextAtom = {
             type: type, /* special, func, open, close, ordinary, math */
             text: usefulText, /* the text value of the atom */
-            whitespace: anyWhitespace /* any whitespace before the atom */
+            whitespace: anyWhitespace, /* any whitespace before the atom */
         };
 
         this._pos += matchText.length;