improve testing and cli

.gitignore

@@ -1,4 +1,6 @@
 node_modules/
-dist/
-out/
+/dist/
+/out/
+/test/out/
+# for running with @swc/register
 src/rion.js

.mocharc.json

@@ -1,5 +1,5 @@
 {
     "extension": ["ts"],
-    "spec": "test/**/*.test.ts",
-    "require": "@swc/register"
-}
+    "spec": "test/**/*.spec.ts",
+    "require": ["@swc/register"]
+}

bin/cli.js → bin/iro.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const { createCommand } = require("../dist/cli");
 
 createCommand(true).parse();

package.json

@@ -3,7 +3,7 @@
     "version": "0.1.0",
     "main": "dist/index.js",
     "bin": {
-        "iro": "dist/cli.js"
+        "iro": "dist/iro.js"
     },
     "author": "FireBlast",
     "license": "MIT",

src/cli.ts

@@ -1,5 +1,3 @@
-#!/usr/bin/env node
-
 import * as fs from "fs";
 import { parse, compile, IroError, nodes, getParser } from "./index";
 import * as chalk from "chalk";

src/compiler.ts

@@ -127,13 +127,16 @@ function getRegexGroups(regex: string) {
     return list;
 }
 
-interface CompileOptions {
-    textmate?: boolean;
-    ace?: boolean;
-    aceDefaultToken?: boolean;
+export interface CompileOptions {
+    /**Compíle to textmate format */
+    textmate: boolean;
+    /**Compíle to ace format */
+    ace: boolean;
+    /**Emit default token when compiling to ace */
+    aceDefaultToken: boolean;
 }
 
-export function compile(ast: N.Grammar, options?: CompileOptions) {
+export function compile(ast: N.Grammar, options?: Partial<CompileOptions>) {
     options = Object.assign(
         <CompileOptions>{
             textmate: true,
@@ -640,6 +643,7 @@ export function compile(ast: N.Grammar, options?: CompileOptions) {
     }
 
     traverse(ast);
+
     if (!errors.find((e) => e.fatal)) {
         // Expand includes
         for (let r in aceGrammar.rules) {

src/index.ts

@@ -1,5 +1,5 @@
 import * as nearley from "nearley";
-import { compile as _compile, IroError } from "./compiler";
+import { compile as _compile, CompileOptions, IroError } from "./compiler";
 import { Grammar, SourceLocationPosition } from "./nodes";
 import { NearleyError, isNearleyError } from "./utils";
 
@@ -36,7 +36,7 @@ export function parse(input: string): Grammar {
 }
 export function compile(
     input: string | Grammar,
-    options?: Parameters<typeof _compile>[1]
+    options?: Partial<CompileOptions>
 ): ReturnType<typeof _compile> {
     var ast: Grammar;
     if (typeof input == "string") {

src/test.ts

@@ -2,7 +2,7 @@ import * as fs from "fs";
 import { parse, compile, IroError, nodes } from "./index";
 import { prettyError } from "./utils";
 
-var input = fs.readFileSync("./test/test.iro", "utf8");
+var input = fs.readFileSync("./test/grammars/test.iro", "utf8");
 var parsingError = false;
 console.time("parsing took");
 try {

test/cli.spec.ts

@@ -0,0 +1,53 @@
+import { expect } from "chai";
+import * as fs from "fs/promises";
+import * as path from "path";
+import { createCommand } from "../src/cli";
+
+const OUT_PATH = path.join(__dirname, "out");
+
+//TODO: use in-memory fs?
+
+const noop = () => {};
+function runCLI(args: string[], output: (out: string) => void = noop) {
+    const _log = console.log;
+    console.log = output;
+
+    var cli = createCommand();
+    cli.parse([process.argv[0], process.argv[1], ...args]);
+
+    console.log = _log;
+}
+
+async function cleanOutput() {
+    await Promise.all(
+        (await fs.readdir(OUT_PATH)).map((fname) => fs.rm(path.join(OUT_PATH, fname), { recursive: true, force: true }))
+    );
+}
+
+before(async () => {
+    await fs.mkdir(OUT_PATH, { recursive: true });
+    await cleanOutput();
+});
+
+describe("CLI", function () {
+    beforeEach(async function () {
+        await cleanOutput();
+    });
+    it("should output all targets", async function () {
+        runCLI(["compile", path.join(__dirname, "grammars/rion.iro"), "-o", OUT_PATH, "-t", "all"]);
+        expect(await fs.readdir(OUT_PATH)).to.have.members(
+            [
+                //
+                "rion.ace.js",
+                "rion.ace.json",
+                "rion.tmlanguage",
+                "rion.tmlanguage.json",
+            ],
+            "expected output directory to have all target files"
+        );
+    });
+    it("should not output files on fail", async function () {
+        runCLI(["compile", path.join(__dirname, "grammars/should_fail/fail_parser.iro"), "-o", OUT_PATH, "-t", "all"]);
+        expect(await fs.readdir(OUT_PATH)).to.be.empty;
+    });
+});

test/inline_style.iro → test/grammars/inline_style.iro

@@ -1,66 +1,66 @@
-name = mylang
-file_extensions []= hello, world;
-#__rec1 \= $${__rec2}
-#__rec2 \= $${__rec1}
-
-__Identifier \= [a-z0-1_]+
-
-contexts [] {
-
-
-
-main : context {
-   : push {
-      regex         \= (")
-      styles []      = .punctuation;
-      context []     = inside_quotes;
-   }
-}
-
-inside_quotes : context {
-   : pop {
-      regex      \= (")
-      styles []   = .punctuation;
-   }
-   : pattern {
-      regex      \= (\\(?:\\|"))
-      styles [] = .escaped_text;
-   }
-   : pattern {
-      regex      \= ([^"\\]+)
-      styles [] = .quoted_text;
-   }
-}
-
-
-
-}
-
-styles [] {
-
-.punctuation : style {
-   color                 = brown
-   ace_scope             = punctuation
-   textmate_scope        = punctuation
-   pygments_scope        = Punctuation
-}
-.escaped_text : style {
-   color                 = white
-   ace_scope             = punctuation
-   textmate_scope        = punctuation
-   pygments_scope        = Punctuation
-}
-.keyword : style {
-   color                 = cyan
-   ace_scope             = keyword
-   textmate_scope        = keywordd
-   pygments_scope        = Keyword
-}
-.quoted_text : style {
-   color                 = yellow
-   ace_scope             = text
-   textmate_scope        = text
-   pygments_scope        = String
-}
-
+name = mylang
+file_extensions []= hello, world;
+#__rec1 \= $${__rec2}
+#__rec2 \= $${__rec1}
+
+__Identifier \= [a-z0-1_]+
+
+contexts [] {
+
+
+
+main : context {
+   : push {
+      regex         \= (")
+      styles []      = .punctuation;
+      context []     = inside_quotes;
+   }
+}
+
+inside_quotes : context {
+   : pop {
+      regex      \= (")
+      styles []   = .punctuation;
+   }
+   : pattern {
+      regex      \= (\\(?:\\|"))
+      styles [] = .escaped_text;
+   }
+   : pattern {
+      regex      \= ([^"\\]+)
+      styles [] = .quoted_text;
+   }
+}
+
+
+
+}
+
+styles [] {
+
+.punctuation : style {
+   color                 = brown
+   ace_scope             = punctuation
+   textmate_scope        = punctuation
+   pygments_scope        = Punctuation
+}
+.escaped_text : style {
+   color                 = white
+   ace_scope             = punctuation
+   textmate_scope        = punctuation
+   pygments_scope        = Punctuation
+}
+.keyword : style {
+   color                 = cyan
+   ace_scope             = keyword
+   textmate_scope        = keywordd
+   pygments_scope        = Keyword
+}
+.quoted_text : style {
+   color                 = yellow
+   ace_scope             = text
+   textmate_scope        = text
+   pygments_scope        = String
+}
+
 }

test/push_pop.iro → test/grammars/push_pop.iro

@@ -1,49 +1,49 @@
-name = mylang
-file_extensions []= hello, world;
-__rec1 \= $${__rec2}
-__rec2 \= $${__rec1}
-
-__Identifier \= [a-z0-1_]+
-
-contexts [] {
-
-
-
-main : context {
-   : push {
-      regex         \= (")
-      styles []      = .punctuation;
-      context []     = inside_quotes;
-   }
-}
-
-inside_quotes : context {
-   : pop {
-      regex      \= (")
-      styles []   = .punctuation;
-   }
-   : pattern {
-      regex      \= (\\(?:\\|"))
-      styles [] = .punctuation;
-   }
-   : pattern {
-      regex      \= ([^"\\]+)
-      styles [] = .quoted_text;
-   }
-}
-
-
-
-}
-
-styles [] {
-
-.punctuation : style {
-   color                 = brown
-}
-.quoted_text : style {
-   color                 = yellow
-   pygments_scope        = String
-}
-
+name = mylang
+file_extensions []= hello, world;
+__rec1 \= $${__rec2}
+__rec2 \= $${__rec1}
+
+__Identifier \= [a-z0-1_]+
+
+contexts [] {
+
+
+
+main : context {
+   : push {
+      regex         \= (")
+      styles []      = .punctuation;
+      context []     = inside_quotes;
+   }
+}
+
+inside_quotes : context {
+   : pop {
+      regex      \= (")
+      styles []   = .punctuation;
+   }
+   : pattern {
+      regex      \= (\\(?:\\|"))
+      styles [] = .punctuation;
+   }
+   : pattern {
+      regex      \= ([^"\\]+)
+      styles [] = .quoted_text;
+   }
+}
+
+
+
+}
+
+styles [] {
+
+.punctuation : style {
+   color                 = brown
+}
+.quoted_text : style {
+   color                 = yellow
+   pygments_scope        = String
+}
+
 }