jlex 1.0.0

package/README.md

@@ -0,0 +1,117 @@
+## Using jison-lex
+
+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:
+
+```
+➜  only-lexer git:(main) ✗ ./jlex.js example
+Processing file: example
+Writing file: example.js
+```
+
+```
+➜  only-lexer git:(main) ✗ npx jison-lex example.l -o example.js
+```
+
+Modify `example.js` to export the generated value `example`:
+
+```js 
+module.exports = example;
+```
+
+Then we can use it:
+
+```
+➜  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 } }
+}
+```
+
+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 }
+```
+
+## The program `jlex.js`
+
+
+```
+> lex = require("./example")
+{
+  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 } }
+}
+> 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/examples/example.l

@@ -0,0 +1,6 @@
+%%
+\s+                   /* skip whitespace */
+[0-9]+                return 'NUMBER';
+"-"                   return '-';
+<<EOF>>               return 'EOF';
+.                     return 'INVALID';

package/examples/main.js

@@ -0,0 +1,36 @@
+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 }
+  }
+]
+*/

package/jlex.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+// replace example by the name of the generated module
+const fs = require("fs");
+const { execSync } = require('child_process');
+const fileName = process.argv[2];
+console.log("Processing file:", fileName);
+execSync(`npx jison-lex ${fileName}.l`, { encoding: 'utf-8' });
+let lexerStr = fs.readFileSync(`${fileName}.js`, "utf8").toString();
+//console.log("Processing file:", lexerStr);
+let lexerModule = lexerStr.replace(new RegExp(`var ${fileName} =`, 'g'), `\nmodule.exports =`);
+console.log("Writing file:", `${fileName}.js`);
+fs.writeFileSync(`${fileName}.js`, lexerModule);

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "jlex",
+  "version": "1.0.0",
+  "main": "jlex.js",
+  "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"
+  },
+  "bin": {
+    "jlex": "jlex.js"
+  },
+  "keywords": ["jison-lex", "jison", "flex"],
+  "author": "Casiano Rodriguez Leon <crguezl@ull.edu.es> (https://crguezl.github.io/)",
+  "license": "ISC",
+  "dependencies": {
+    "jison": "^0.4.18"
+  }
+}