For more information on the flavor of ABNF (Augmented Backus-Naur Form) supported by this project, see RFC 5234 and RFC 7405.

npm install -g abnf

import { parseFile } from "abnf";
const rules = await parseFile("myfile.abnf");

There are a few binaries included:

Check the given ABNF file for correctness.

Output the generated abstract syntax tree for the ABNF input. This output is mostly diagnostic in nature, not really meant to be parsed.

Generate a Peggy grammar from the ABNF. The idea is that you could then annotate this grammar with actions in order to create a useful parser.

Using an ABNF, test inputs to see if they match. Returns the Peggy parse tree, which will likely be somewhat confusing until you're familiar with Peggy.

$ cat << EOF > foo.abnf
f = "abc"
EOF
$ abnf_gen foo.abnf
$ cat foo.peggy
f
  = "abc"i
$ abnf_test foo.abnf -t abc
'abc'
$ abnf_test foo.peggy -t ab
Error: Expected "abc" but "a" found.
 --> command line:1:1
  |
1 | ab
  | ^

Parse the file with the given name, returning a promise for a Rules object.

Parse the given string and return a Rules object. The grammarSource is the name of the file that the input came from.

Read the stream, parse it, and return a promise for a Rules object. The grammarSource is the name of the file that the input came from.

The name of the first rule in the input grammar.

A hash of Rule objects indexed by uppercase rulename.

An array of RuleRef objects.

The name of the rule

The Peggy location in the input file where the rule name was defined

The definition of the rule. More information forthcoming.

The name of the rule that was referenced

The Peggy location in the input file where the rule name was referenced.