--allowed-start-rule=\* documented for CLI. Fixes peggyjs#386.

hildjj · Mar 19, 2023 · 180a004 · 180a004
1 parent 6ed53e0
commit 180a004
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,8 +17,10 @@ Released: TBD
 - [#371](https://github.com/peggyjs/peggy/issues/371) Error using online Peggy - Can't find variable: util
 - [#374](https://github.com/peggyjs/peggy/issues/374) CLI throws exception
   on grammar errors. From @hildjj
-= [#381](https://github.com/peggyjs/peggy/issues/381) Repetitions with code blocks
+- [#381](https://github.com/peggyjs/peggy/issues/381) Repetitions with code blocks
   for min or max not handling non-integer returns correctly.
+- [#386](https://github.com/peggyjs/peggy/issues/381) Ensure '*' as
+  allowed-start-rule is documented for CLI.
 
 3.0.1
 -----

diff --git a/bin/peggy-cli.js b/bin/peggy-cli.js
@@ -106,7 +106,7 @@ class PeggyCLI extends Command {
       .addOption(
         new Option(
           "--allowed-start-rules <rules>",
-          "Comma-separated list of rules the generated parser will be allowed to start parsing from.  (Can be specified multiple times)"
+          "Comma-separated list of rules the generated parser will be allowed to start parsing from.  Use '*' if you want any rule to be allowed as a start rule.  (Can be specified multiple times)"
         )
           .default([], "the first rule in the grammar")
           .argParser(commaArg)

diff --git a/docs/documentation.html b/docs/documentation.html
@@ -118,7 +118,8 @@ <h3 id="generating-a-parser-command-line">Command Line</h3>
 <dl>
   <dt><code>--allowed-start-rules &lt;rules&gt;</code></dt>
   <dd>Comma-separated list of rules the parser will be allowed to start parsing
-    from (default: only the first rule in the grammar).</dd>
+    from.  Use '*' if you want any rule to be allowed as a start rule.
+    (default: only the first rule in the grammar).</dd>
 
   <dt><code>--ast</code></dt>
   <dd>Outputting an internal AST representation of the grammar after

diff --git a/test/cli/run.spec.ts b/test/cli/run.spec.ts
@@ -320,8 +320,10 @@ Options:
   -v, --version                    output the version number
   --allowed-start-rules <rules>    Comma-separated list of rules the generated
                                    parser will be allowed to start parsing
-                                   from.  (Can be specified multiple times)
-                                   (default: the first rule in the grammar)
+                                   from.  Use '*' if you want any rule to be
+                                   allowed as a start rule.  (Can be specified
+                                   multiple times) (default: the first rule in
+                                   the grammar)
   --ast                            Output a grammar AST instead of a parser
                                    code (default: false)
   --cache                          Make generated parser cache results