jlex 1.0.0 → 1.0.1

package/README.md

@@ -1,85 +1,110 @@
-## Using jison-lex
+## Install
 
-I have written a small wrapper around `jison-lex`that allows you to use the script 
-`jlex` as standalone (`flex`like) processor.
-Here is an example:
+`npm i jlex`
+
+## Usage
 
 ```
-➜  only-lexer git:(main) ✗ ./jlex.js example
-Processing file: example
-Writing file: example.js
+npx jlex <package name>
 ```
 
+
+## Example
+
+`jlex` is  a tiny wrapper around `jison-lex` that allows you to use the script 
+`jlex` as standalone (`flex` like) processor.
+
+Assuming the following lexer in file `example.js`:
+
 ```
-➜  only-lexer git:(main) ✗ npx jison-lex example.l -o example.js
+%%
+\s+                   /* skip whitespace */
+[0-9]+                return 'NUMBER';
+"-"                   return '-';
+<<EOF>>               return 'EOF';
+.                     return 'INVALID';% 
 ```
 
-Modify `example.js` to export the generated value `example`:
+Compile it with:
 
-```js 
-module.exports = example;
 ```
+➜  jlex-test npx jlex example  
+Processing file: example
+Writing file: example.js
+``` 
 
-Then we can use it:
+This produces a Common.JS module `example.js` you can use with a simple `require` like in the file `main.js` below:
 
+```js
+const lex = require("./example");
+lex.setInput("2\n-\n3")
+
+const results = [];
+
+results.push({ type: lex.lex(), lexeme: lex.yytext, loc: lex.yylloc });
+results.push({ type: lex.lex(), lexeme: lex.yytext, loc: lex.yylloc });
+results.push({ type: lex.lex(), lexeme: lex.yytext, loc: lex.yylloc });
+results.push({ type: lex.lex(), lexeme: lex.yytext, loc: lex.yylloc });
+
+console.log(results);
+/*
+➜  examples git:(main) ✗ node main.js
+[
+  {
+    type: 'NUMBER',
+    lexeme: '2',
+    loc: { first_line: 1, last_line: 1, first_column: 0, last_column: 1 }
+  },
+  {
+    type: '-',
+    lexeme: '-',
+    loc: { first_line: 2, last_line: 2, first_column: 0, last_column: 1 }
+  },
+  {
+    type: 'NUMBER',
+    lexeme: '3',
+    loc: { first_line: 3, last_line: 3, first_column: 0, last_column: 1 }
+  },
+  {
+    type: 'EOF',
+    lexeme: '',
+    loc: { first_line: 3, last_line: 3, first_column: 1, last_column: 1 }
+  }
+]
+*/  
 ```
-➜  only-lexer git:(main) ✗ node
-Welcome to Node.js v25.6.0.
-Type ".help" for more information.
-> lex = require("./example.js")
-{
-  EOF: 1,
-  parseError: [Function: parseError],
-  setInput: [Function: setInput],
-  input: [Function: input],
-  unput: [Function: unput],
-  more: [Function: more],
-  reject: [Function: reject],
-  less: [Function: less],
-  pastInput: [Function: pastInput],
-  upcomingInput: [Function: upcomingInput],
-  showPosition: [Function: showPosition],
-  test_match: [Function: test_match],
-  next: [Function: next],
-  lex: [Function: lex],
-  begin: [Function: begin],
-  popState: [Function: popState],
-  _currentRules: [Function: _currentRules],
-  topState: [Function: topState],
-  pushState: [Function: pushState],
-  stateStackSize: [Function: stateStackSize],
-  options: { moduleName: 'example' },
-  performAction: [Function: anonymous],
-  rules: [ /^(?:\s+)/, /^(?:[0-9]+)/, /^(?:-)/, /^(?:$)/, /^(?:.)/ ],
-  conditions: { INITIAL: { rules: [Array], inclusive: true } }
-}
-```
+When you execute the former program, you get:
 
-Now:
 
 ```js
-> lex.setInput("2 - 3")
-{
-  ...
-  offset: 0
-}
-> lex.lex()
-'NUMBER'
-> lex.lex()
-'-'
-> lex.lex()
-'NUMBER'
-> lex.yytext
-'3'
-> lex.yylloc
-{ first_line: 1, last_line: 1, first_column: 4, last_column: 5 }
+➜  jlex-test node main.js 
+[
+  {
+    type: 'NUMBER',
+    lexeme: '2',
+    loc: { first_line: 1, last_line: 1, first_column: 0, last_column: 1 }
+  },
+  {
+    type: '-',
+    lexeme: '-',
+    loc: { first_line: 2, last_line: 2, first_column: 0, last_column: 1 }
+  },
+  {
+    type: 'NUMBER',
+    lexeme: '3',
+    loc: { first_line: 3, last_line: 3, first_column: 0, last_column: 1 }
+  },
+  {
+    type: 'EOF',
+    lexeme: '',
+    loc: { first_line: 3, last_line: 3, first_column: 1, last_column: 1 }
+  }
+]
 ```
 
-## The program `jlex.js`
-
+Here is a description of the lexer object:
 
-```
-> lex = require("./example")
+```js
 {
   EOF: 1,
   parseError: [Function: parseError],
@@ -106,12 +131,4 @@ Now:
   rules: [ /^(?:\s+)/, /^(?:[0-9]+)/, /^(?:-)/, /^(?:$)/, /^(?:.)/ ],
   conditions: { INITIAL: { rules: [Array], inclusive: true } }
 }
-> lex.setInput("2 - 3")
-> lex.lex()
-'NUMBER'
-> lex.yytext
-'2'
-> lex.yylloc
-{ first_line: 1, last_line: 1, first_column: 0, last_column: 1 }
-> 
 ```

package/package.json

@@ -1,19 +1,36 @@
 {
   "name": "jlex",
-  "version": "1.0.0",
-  "main": "jlex.js",
+  "version": "1.0.1",
   "description": "A wrapper around jison-lex to make it work as a standalone program like Flex",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "example": "cd examples && ../jlex.js example"
+  "keywords": [
+    "jison-lex",
+    "jison",
+    "flex"
+  ],
+  "homepage": "https://github.com/ULL-ESIT-PL/jlex#readme",
+  "bugs": {
+    "url": "https://github.com/ULL-ESIT-PL/jlex/issues"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ULL-ESIT-PL/jlex.git"
+  },
+  "license": "ISC",
+  "author": "Casiano Rodriguez Leon <crguezl@ull.edu.es> (https://crguezl.github.io/)",
+  "type": "commonjs",
+  "main": "jlex.js",
   "bin": {
     "jlex": "jlex.js"
   },
-  "keywords": ["jison-lex", "jison", "flex"],
-  "author": "Casiano Rodriguez Leon <crguezl@ull.edu.es> (https://crguezl.github.io/)",
-  "license": "ISC",
+  "directories": {
+    "example": "examples"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "example": "cd examples && ../jlex.js example"
+  },
   "dependencies": {
     "jison": "^0.4.18"
-  }
+  },
+  "devDependencies": {}
 }