bin/validate

Author: stasm

bin/format.ts

@@ -1,13 +1,14 @@
 import parseArgs from "minimist";
 import {Resource} from "../format/resource";
 import {fromFile, fromStdin} from "../lib/input";
-import {formatResource} from "../lib/tools";
+import {formatMessage, formatResource} from "../lib/tools";
 
 const argv = parseArgs(process.argv.slice(2), {
-    boolean: ["help", "group"],
+    boolean: ["help"],
+    string: ["message"],
     alias: {
         help: "h",
-        group: "g",
+        message: "m",
     },
 });
 
@@ -38,13 +39,19 @@ function exitHelp(exitCode: number) {
 
     Options:
 
-        -h, --help      Display help and quit.
+        -h, --help         Display help and quit.
+        -m, --message ID   Format only the message called ID.
 `);
     process.exit(exitCode);
 }
 
 function print(source: string) {
     let resource = new Resource(source);
-    let results = formatResource(resource, new Map());
+    let results;
+    if (argv.message) {
+        results = formatMessage(resource, new Map(), argv.message);
+    } else {
+        results = formatResource(resource, new Map());
+    }
     console.log(JSON.stringify(results, null, 4));
 }

bin/validate.ts

@@ -0,0 +1,34 @@
+import parseArgs from "minimist";
+import {fromFile} from "../lib/input";
+import {validate} from "../lib/validate";
+
+const argv = parseArgs(process.argv.slice(2), {
+    boolean: ["help"],
+    alias: {
+        help: "h",
+    },
+});
+
+let [exePath, mdPath] = argv._;
+if (exePath && mdPath) {
+    fromFile(mdPath, source => validate(exePath, mdPath, source));
+} else if (argv.help) {
+    exitHelp(0);
+} else {
+    exitHelp(1);
+}
+
+function exitHelp(exitCode: number) {
+    console.log(`
+    Usage: node validate.js <EXECUTABLE> <SPEC>
+
+    Examples:
+
+        node validate.js build/bin/format.js spec/format/text_element.md
+
+    Options:
+
+        -h, --help      Display help and quit.
+`);
+    process.exit(exitCode);
+}

lib/tools.ts

@@ -31,3 +31,13 @@ export function formatResource(resource: Resource, variables: Variables) {
     }
     return results;
 }
+
+export function formatMessage(resource: Resource, variables: Variables, id: string) {
+    let bundle = new Bundle();
+    bundle.addResource(resource);
+
+    let message = bundle.getMessage(id);
+    if (message && message.value) {
+        return bundle.formatPattern(message.value, variables);
+    }
+}

lib/types.d.ts

@@ -0,0 +1,3 @@
+declare module "json-diff" {
+    export function diffString(actual: string, expected: string): string;
+}

lib/validate.ts

@@ -0,0 +1,37 @@
+import {deepStrictEqual} from "assert";
+import {execSync} from "child_process";
+import {Parser as MarkdownParser} from "commonmark";
+import {diffString} from "json-diff";
+
+export function validate(exe: string, spec: string, source: string) {
+    // https://github.com/commonmark/commonmark.js/blob/master/README.md#usage
+    let reader = new MarkdownParser();
+    let parsed = reader.parse(source);
+    let walker = parsed.walker();
+
+    let counter = 1;
+    let actual = null;
+    let current;
+    while ((current = walker.next())) {
+        let {entering, node} = current;
+        if (entering && node.type === "code_block" && node.literal !== null) {
+            if (node.info === "properties") {
+                actual = execSync(exe, {
+                    input: node.literal,
+                    encoding: "utf8",
+                });
+            } else if (node.info === "json" && actual) {
+                let expected = node.literal;
+
+                try {
+                    deepStrictEqual(JSON.parse(actual), JSON.parse(expected));
+                    console.log(`${spec} Example ${counter++} PASS`);
+                } catch (err) {
+                    console.log(`${spec} Example ${counter++} FAIL`);
+                    console.log(diffString(err.actual, err.expected));
+                }
+                actual = null;
+            }
+        }
+    }
+}

package-lock.json

@@ -33,24 +33,24 @@
         "url": "https://github.com/projectfluent/fluent/issues"
     },
     "devDependencies": {
+        "@types/commonmark": "^0.27.4",
         "@types/minimist": "^1.2.0",
         "@types/mocha": "^5.2.7",
         "@types/node": "^12.0.4",
         "babylon": "^6.18.0",
         "cli-color": "^1.2.0",
+        "commonmark": "^0.29.0",
         "difflib": "^0.2.4",
+        "esm": "^3.2.25",
         "fluent": "^0.6.4",
         "fluent-syntax": "^0.7.0",
         "gh-pages": "^1.1.0",
         "gitbook-cli": "^2.3.0",
         "json-diff": "^0.5.2",
+        "minimist": "^1.2.0",
         "prettier": "^1.17.1",
         "mocha": "^6.1.4",
         "ts-node": "^8.2.0",
         "typescript": "^3.5.1"
-    },
-    "dependencies": {
-        "esm": "^3.2.25",
-        "minimist": "^1.2.0"
     }
 }

package.json

@@ -0,0 +1,32 @@
+# TextElement
+
+Patterns are composed of `PatternElements`, which can be `TextElements` or
+`Placeables`. `TextElements` represent the verbatim content of the
+translation.
+
+```properties
+test = Text
+```
+
+```json
+{
+    "value": "Text",
+    "errors": []
+}
+```
+
+Multiline `TextElements` must be formatted without changes to newlines and
+whitespace.
+
+```properties
+test =
+    Multiline
+      Content
+```
+
+```json
+{
+    "value": "Multiline\n  Content",
+    "errors": []
+}
+```