@bablr/cli 0.8.0 → 0.10.0

package/README.md

@@ -2,26 +2,9 @@
 
 This is the CLI runner for BABLR. If you have a BABLR grammar for a computer language, this tool allows you to use it to do streaming parsing. Parse results are presented in CSTML.
 
-## Usage
-
-This package has no built-in language support, but rather expects you to supply a valid import specifier referring to a BABLR language. This likely means that you will likely need to start by installing both the parser and the language you wish to use.
-
-```
-Usage: bablr [options]
-
-Options:
-  -l, --language [URL]     The URL of the top BABLR language
-  -p, --production [type]  The name of the top production type
-  -f, --format             Pretty-format CSTML output (default: true)
-  -F, --no-format
-  -v, --verbose            Prints debugging information to stderr
-  -c, --color [WHEN]       When to use ANSI escape colors
-    WHEN: "auto" | "always" | "never" (default: "auto")
-  -e, --embedded           Requires quoted input but enables gap parsing
-  -h, --help               display help for command
-```
+For complete information see the [bablr-cli reference documentation](https://docs.bablr.org/reference/bablr-cli)
 
-## Example
+## Usage
 
 ```bash
 bablr -l @bablr/language-en-json -p Expression -f << 'EOF'
@@ -32,46 +15,3 @@ bablr -l @bablr/language-en-json -p Expression -f << 'EOF'
 ]
 EOF
 ```
-
-Running the above command produces the following output. Note that this is a stream parse so lines of output will appear one by one as fast as the input can be read and parsed.
-
-```cstml
-<!0:cstml bablr-language='https://github.com/bablr-lang/language-en-json'>
-<>
-  .:
-  <Array>
-    openToken: <*Punctuator '[' balanced=']' />
-    <#*Space:Space '\n  ' />
-    separators[]: []
-    elements[]: []
-    elements[]:
-    <Number span='Number'>
-      wholePart:
-      <Integer>
-        signToken: null
-        value: <*UnsignedInteger '1' />
-      </>
-      fractionalSeparatorToken: null
-      fractionalPart: null
-      exponentSeparatorToken: null
-      exponentPart: null
-    </>
-    separators[]: <*Punctuator ',' />
-    <#*Space:Space '\n  ' />
-    elements[]:
-    <Boolean>
-      sigilToken: <*Keyword 'true' />
-    </>
-    separators[]: <*Punctuator ',' />
-    <#*Space:Space '\n  ' />
-    elements[]:
-    <String>
-      openToken: <*Punctuator '"' balanced='"' balancedSpan='String' />
-      content: <*StringContent '3' />
-      closeToken: <*Punctuator '"' balancer />
-      <#*Space:Space '\n' />
-    </>
-    closeToken: <*Punctuator ']' balancer />
-  </>
-</>
-```

package/bin/index.js

@@ -3,7 +3,7 @@
 /* global process */
 
 import { program } from 'commander';
-import { streamParse, Context } from 'bablr';
+import { streamParse } from 'bablr';
 import { embeddedSourceFrom, readFromStream, stripTrailingNewline } from '@bablr/helpers/source';
 import { debugEnhancers } from '@bablr/helpers/enhancers';
 import colorSupport from 'color-support';
@@ -11,6 +11,7 @@ import { evaluateIO } from '@bablr/io-vm-node';
 import { generateCSTML } from '../lib/syntax.js';
 import {
   buildBasicNodeMatcher,
+  buildNodeFlags,
   buildOpenNodeMatcher,
   buildPropertyMatcher,
 } from '@bablr/helpers/builders';
@@ -23,7 +24,10 @@ program
   .option('-l, --language [URL]', 'The URL of the top BABLR language')
   .option('-p, --production [type]', 'The name of the top production type')
   .option('-f, --format', 'Pretty-format CSTML output', true)
-  .option('-g, --gaps', 'The source and resulting tree may contain gaps')
+  .option('-g, --gaps', 'Sets hasGap flag on root matcher')
+  .option('-r, --fragment', 'Sets fragment flag on root matcher')
+  .option('-t --token', 'Sets token flag on root matcher')
+  .option('-o --cover', 'Sets cover flag on root matcher')
   .option('-F, --no-format')
   .option('-v, --verbose', 'Prints debugging information to stderr')
   .option(
@@ -49,14 +53,25 @@ const options = {
 
 const language = await import(options.language);
 
-const matcher = buildEmbeddedMatcher(
-  buildPropertyMatcher(
-    null,
-    buildBasicNodeMatcher(
-      buildOpenNodeMatcher({ hasGap: options.gaps }, language.canonicalURL, options.production),
-    ),
-  ),
-);
+const matcher = options.production
+  ? buildEmbeddedMatcher(
+      buildPropertyMatcher(
+        null,
+        null,
+        buildBasicNodeMatcher(
+          buildOpenNodeMatcher(
+            buildNodeFlags({
+              hasGap: options.gaps,
+              fragment: options.fragment,
+              token: options.token,
+              cover: options.cover,
+            }),
+            options.production,
+          ),
+        ),
+      ),
+    )
+  : language.defaultMatcher;
 
 const logStderr = (...args) => {
   process.stderr.write(args.join(' ') + '\n');
@@ -64,23 +79,25 @@ const logStderr = (...args) => {
 
 const enhancers = options.verbose ? { ...debugEnhancers, agast: null } : {};
 
-const ctx = Context.from(language, enhancers.bablrProduction);
-
 const rawStream = process.stdin.setEncoding('utf-8');
 
 const output = evaluateIO(() =>
   generateCSTML(
     streamParse(
-      ctx,
+      language,
       matcher,
       options.embedded
         ? embeddedSourceFrom(readFromStream(rawStream))
         : stripTrailingNewline(readFromStream(rawStream)),
       o({}),
-      { enhancers, emitEffects: true },
+      {
+        enhancers,
+        emitEffects: true,
+        holdShiftedNodes: !options.gaps,
+        holdUndefinedAttributes: !options.gaps,
+      },
     ),
     {
-      ctx,
       color: options.color,
       format: options.format,
       emitEffects: true,

package/lib/syntax.js

@@ -3,7 +3,7 @@
 import emptyStack from '@iter-tools/imm-stack';
 import * as cstml from '@bablr/language-en-cstml';
 import * as verboseOutput from '@bablr/language-en-bablr-cli-verbose-output';
-import { streamParse, Context } from 'bablr/enhanceable';
+import { streamParse } from 'bablr/enhanceable';
 import { Coroutine } from '@bablr/coroutine';
 import { StreamIterable, getStreamIterator } from '@bablr/agast-helpers/stream';
 import {
@@ -20,9 +20,13 @@ import {
 import { OpenNodeTag, CloseNodeTag, ReferenceTag, LiteralTag } from '@bablr/agast-helpers/symbols';
 import {
   buildBasicNodeMatcher,
+  buildNodeFlags,
   buildOpenNodeMatcher,
   buildPropertyMatcher,
 } from '@bablr/helpers/builders';
+import { getFlagsWithGap, nodeFlags } from '@bablr/agast-helpers/builders';
+
+let gapNodeFlags = getFlagsWithGap(nodeFlags);
 
 function* __higlightStrategy(tags) {
   const co = new Coroutine(getStreamIterator(tags));
@@ -50,7 +54,7 @@ function* __higlightStrategy(tags) {
 
       if (
         tagType === Symbol.for('LiteralTag') ||
-        (tagType === Symbol.for('String') && currentRef.name === 'intrinsicValue')
+        (tagType === Symbol.for('String') && currentRef.name === 'literalValue')
       ) {
         if (tagType === Symbol.for('LiteralTag') || currentType === Symbol.for('OpenNodeTag')) {
           yield buildAnsiPushEffect('bold green');
@@ -59,13 +63,16 @@ function* __higlightStrategy(tags) {
         } else {
           yield buildAnsiPushEffect();
         }
-      } else if (
-        tagType === Symbol.for('Pattern') &&
-        tag.value.language !== 'https://bablr.org/languages/core/en/spamex'
-      ) {
+      } else if (tagType === Symbol.for('Pattern')) {
         yield buildAnsiPushEffect('bold orange');
       } else if (tagType === Symbol.for('EscapeSequence')) {
         yield buildAnsiPushEffect('bold cyan');
+      } else if (tagType === Symbol.for('Punctuator')) {
+        if (currentType === Symbol.for('ReferenceTag')) {
+          yield buildAnsiPushEffect('bold gray');
+        } else {
+          yield buildAnsiPushEffect();
+        }
       } else if (tagType === Symbol.for('Identifier')) {
         if (currentType === Symbol.for('ReferenceTag')) {
           yield buildAnsiPushEffect('bold gray');
@@ -96,20 +103,19 @@ function* __higlightStrategy(tags) {
       currentRef = tag.value;
     }
 
-    if (tag.type === CloseNodeTag) {
-      types = types.pop();
-      yield buildAnsiPopEffect();
-    }
-
     if (tag.type === LiteralTag) {
       yield buildWriteEffect(tag.value);
-    } else if (tag.type === OpenNodeTag && tag.value.intrinsicValue) {
-      yield buildWriteEffect(tag.value.intrinsicValue);
-      yield buildAnsiPopEffect();
+    } else if (tag.type === OpenNodeTag && tag.value.literalValue) {
+      yield buildWriteEffect(tag.value.literalValue);
     }
 
     yield tag;
 
+    if (tag.type === CloseNodeTag || (tag.type === OpenNodeTag && tag.value.selfClosing)) {
+      types = types.pop();
+      yield buildAnsiPopEffect();
+    }
+
     co.advance();
   }
 }
@@ -119,30 +125,28 @@ export const higlightStrategy = (tags) => {
 };
 
 export const generateCSTML = (tags, options = {}) => {
-  const strategyOptions = { ctx: options.ctx };
   const outputInstructions = options.format
-    ? writePrettyCSTMLStrategy(tags, strategyOptions)
-    : writeCSTMLStrategy(tags, strategyOptions);
+    ? writePrettyCSTMLStrategy(tags)
+    : writeCSTMLStrategy(tags);
 
   if (options.color) {
     const input = generateAllOutput(outputInstructions);
     const language = options.emitEffects ? verboseOutput : cstml;
     const type = options.emitEffects ? 'Output' : 'Document';
 
-    const context = Context.from(language);
-
     const tags = streamParse(
-      context,
+      language,
       buildEmbeddedMatcher(
         buildPropertyMatcher(
           null,
-          buildBasicNodeMatcher(buildOpenNodeMatcher({}, language.canonicalURL, type)),
+          null,
+          buildBasicNodeMatcher(buildOpenNodeMatcher(buildNodeFlags(gapNodeFlags), type)),
         ),
       ),
       input,
     );
 
-    return higlightStrategy(tags, { ctx: context });
+    return higlightStrategy(tags);
   } else {
     return outputInstructions;
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bablr/cli",
   "description": "CLI for running BABLR parsers",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "author": "Conrad Buck<conartist6@gmail.com>",
   "type": "module",
   "files": [
@@ -17,21 +17,21 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@bablr/agast-helpers": "0.7.1",
-    "@bablr/agast-vm-helpers": "0.7.1",
-    "@bablr/io-vm-node": "0.7.0",
-    "@bablr/boot": "0.8.1",
+    "@bablr/agast-helpers": "0.9.0",
+    "@bablr/agast-vm-helpers": "0.9.0",
+    "@bablr/io-vm-node": "0.8.0",
+    "@bablr/boot": "0.10.0",
     "@bablr/coroutine": "0.1.0",
-    "@bablr/helpers": "0.22.1",
-    "@bablr/language-en-cstml": "0.9.0",
-    "@bablr/language-en-bablr-cli-verbose-output": "0.7.0",
-    "@iter-tools/imm-stack": "1.1.0",
-    "bablr": "0.8.1",
+    "@bablr/helpers": "0.24.0",
+    "@bablr/language-en-cstml": "0.11.0",
+    "@bablr/language-en-bablr-cli-verbose-output": "0.9.0",
+    "@iter-tools/imm-stack": "1.2.0",
+    "bablr": "0.10.0",
     "color-support": "1.1.3",
     "commander": "^12.0.0"
   },
   "devDependencies": {
-    "@bablr/eslint-config-base": "github:bablr-lang/eslint-config-base#49f5952efed27f94ee9b94340eb1563c440bf64e",
+    "@bablr/eslint-config-base": "github:bablr-lang/eslint-config-base#c97bfa4b3663f8378e9b3e42bb5a41e685406cf9",
     "enhanced-resolve": "^5.12.0",
     "eslint": "^8.32.0",
     "eslint-import-resolver-enhanced-resolve": "^1.0.5",