feat: get rid of cjs module

BREAKING CHANGE: only provide esm module
arlac77 · Jan 2, 2019 · 067a4fd · 067a4fd
1 parent 35aea72
commit 067a4fd
Show file tree

Hide file tree

Showing 17 changed files with 344 additions and 367 deletions.
diff --git a/.markdown-doctest-setup.js b/.markdown-doctest-setup.js
@@ -1,5 +1,3 @@
 module.exports = {
-  require: {
-    'pratt-parser': require('./dist/parser')
-  }
-}
+  require: {}
+};
diff --git a/README.md b/README.md
@@ -23,8 +23,10 @@ Based on
 [Top Down Operator Precedence](https://tdop.github.io) and
 [Douglas Crockford TDOP](https://github.com/douglascrockford/TDOP)
 
+<!-- skip-example -->
+
 ```javascript
-const {Parser, WhiteSpaceToken, NumberToken} = require('pratt-parser');
+import { Parser, WhiteSpaceToken, NumberToken } from "pratt-parser";
 
 function Value(value) {
   return Object.create(null, {
@@ -35,34 +37,31 @@ function Value(value) {
 }
 
 const myGrammar = new Parser({
-  tokens: [
-    WhiteSpaceToken,
-    NumberToken
-  ],
+  tokens: [WhiteSpaceToken, NumberToken],
   prefix: {
-    '(': {
+    "(": {
       nud(grammar) {
         const e = grammar.expression(0);
-        grammar.advance(')');
+        grammar.advance(")");
         return e;
       }
     }
   },
   infix: {
-    ')': {},
-    '+': {
+    ")": {},
+    "+": {
       precedence: 50,
       combine: (left, right) => Value(left.value + right.value)
     },
-    '-': {
+    "-": {
       precedence: 50,
       combine: (left, right) => Value(left.value - right.value)
     },
-    '*': {
+    "*": {
       precedence: 60,
       combine: (left, right) => Value(left.value * right.value)
     },
-    '/': {
+    "/": {
       precedence: 60,
       combine: (left, right) => Value(left.value / right.value)
     }
@@ -78,27 +77,27 @@ console.log(myGrammar.parse("(1 + (1 + 4 * 3)) * (2 + 1)").value);
 
 ### Table of Contents
 
--   [pratt-parser](#pratt-parser)
--   [pratt-parser](#pratt-parser-1)
--   [pratt-parser](#pratt-parser-2)
--   [Parser](#parser)
-    -   [Parameters](#parameters)
-    -   [error](#error)
-        -   [Parameters](#parameters-1)
-    -   [parse](#parse)
-        -   [Parameters](#parameters-2)
--   [RootToken](#roottoken)
-    -   [parseString](#parsestring)
-        -   [Parameters](#parameters-3)
--   [WhiteSpaceToken](#whitespacetoken)
--   [LineCommentToken](#linecommenttoken)
--   [EOFToken](#eoftoken)
--   [Tokenizer](#tokenizer)
-    -   [Parameters](#parameters-4)
-    -   [tokens](#tokens)
-        -   [Parameters](#parameters-5)
-    -   [error](#error-1)
-        -   [Parameters](#parameters-6)
+- [pratt-parser](#pratt-parser)
+- [pratt-parser](#pratt-parser-1)
+- [pratt-parser](#pratt-parser-2)
+- [Parser](#parser)
+  - [Parameters](#parameters)
+  - [error](#error)
+    - [Parameters](#parameters-1)
+  - [parse](#parse)
+    - [Parameters](#parameters-2)
+- [RootToken](#roottoken)
+  - [parseString](#parsestring)
+    - [Parameters](#parameters-3)
+- [WhiteSpaceToken](#whitespacetoken)
+- [LineCommentToken](#linecommenttoken)
+- [EOFToken](#eoftoken)
+- [Tokenizer](#tokenizer)
+  - [Parameters](#parameters-4)
+  - [tokens](#tokens)
+    - [Parameters](#parameters-5)
+  - [error](#error-1)
+    - [Parameters](#parameters-6)
 
 ## pratt-parser
 
@@ -112,16 +111,16 @@ Creates a grammar for later parsing
 
 ### Parameters
 
--   `grammar` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** definition of the grammar with operators...
--   `options`   (optional, default `{}`)
+- `grammar` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** definition of the grammar with operators...
+- `options` (optional, default `{}`)
 
 ### error
 
 Forwards error to the tokenizer
 
 #### Parameters
 
--   `args` **...any** 
+- `args` **...any**
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** error
 
@@ -131,8 +130,8 @@ Parses the input and delivers the outermoost expression.
 
 #### Parameters
 
--   `chunk` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** input text
--   `context` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** object transparently passed to tokenizer
+- `chunk` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** input text
+- `context` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** object transparently passed to tokenizer
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** evaluated input
 
@@ -147,9 +146,9 @@ Modifies ParsePosition so that it points behind the detected token.
 
 #### Parameters
 
--   `pp` **PrsePosition** 
+- `pp` **PrsePosition**
 
-Returns **Token** 
+Returns **Token**
 
 ## WhiteSpaceToken
 
@@ -169,24 +168,24 @@ Creates a tokenizer for later parsing
 
 ### Parameters
 
--   `grammar` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** definition of the grammar with operators...
+- `grammar` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** definition of the grammar with operators...
 
 ### tokens
 
 delivers tokens from the input
 
 #### Parameters
 
--   `chunk` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the input to be processed
--   `context` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional info to be used by the actual token types
+- `chunk` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the input to be processed
+- `context` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional info to be used by the actual token types
 
 ### error
 
 #### Parameters
 
--   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
--   `context` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** token initiating the error
--   `value` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+- `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
+- `context` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** token initiating the error
+- `value` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** error
 

diff --git a/package.json b/package.json
@@ -4,8 +4,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "dist/parser.js",
-  "module": "src/parser.js",
+  "main": "src/parser.mjs",
+  "module": "src/parser.mjs",
   "description": "TDOP parser",
   "keywords": [
     "tokenizer",
@@ -23,9 +23,8 @@
   "scripts": {
     "cover": "c8 --temp-directory build/coverage ava && c8 report -r lcov --temp-directory build/coverage",
     "docs": "documentation readme src/parser.js --section=API",
-    "lint": "documentation lint src/parser.js",
-    "posttest": "markdown-doctest && npm run prepare",
-    "pretest": "rollup -c tests/rollup.config.js",
+    "lint": "documentation lint src/parser.mjs",
+    "posttest": "markdown-doctest",
     "test": "ava"
   },
   "dependencies": {},

diff --git a/rollup.config.js b/rollup.config.js
diff --git a/src/known-tokens.js → src/known-tokens.mjs b/src/known-tokens.js → src/known-tokens.mjs
diff --git a/src/parser.js → src/parser.mjs b/src/parser.js → src/parser.mjs
diff --git a/src/tokenizer.js → src/tokenizer.mjs b/src/tokenizer.js → src/tokenizer.mjs
diff --git a/tests/identifier-token-test.js → tests/identifier-token-test.mjs b/tests/identifier-token-test.js → tests/identifier-token-test.mjs
diff --git a/tests/json-parser-test.js → tests/json-parser-test.mjs b/tests/json-parser-test.js → tests/json-parser-test.mjs
diff --git a/tests/keyword-token-test.js → tests/keyword-token-test.mjs b/tests/keyword-token-test.js → tests/keyword-token-test.mjs
diff --git a/tests/line-comment-token-test.js → tests/line-comment-token-test.mjs b/tests/line-comment-token-test.js → tests/line-comment-token-test.mjs
diff --git a/tests/mini-lang-test.js → tests/mini-lang-test.mjs b/tests/mini-lang-test.js → tests/mini-lang-test.mjs
diff --git a/tests/simple-grammar-test.js → tests/simple-grammar-test.mjs b/tests/simple-grammar-test.js → tests/simple-grammar-test.mjs