Repository files navigation

This package contains a large set of examples of usingapg-js,the JavaScript version of APG, an ABNF Parser Generator.Each example is in its own directory and in that directory isa script,main.sh, which will execute the example. Each example hasmultiple options. Running the script withno arguments will display a desciption of the example and adetailed list of the options available.

npm scripts are also available for each of these examplesinpackage.json. For example,

./src/ast/main.sh

and

npm run ast

both run the AST test.

If executing the scripts directly or in with a debugger, they should beexcuted from the repository directory for correct relative path name alignment.

Each of the four libraries, apg-conv-api, apg-lib, apg-api and apg-exp,has been bundled for browser use. Consequently, the examples foreach of these libraries contains an example of browser usage.The browser-based example file names will have a "web-" prefix.

apg-js-examples version 4.2.3 adds a new example. Previously existing examples are unchanged.The new example is a complete and well-tested URI (RFC 3986) parser.

npm run uri

will display a brief description and the help screen.Any URI can be parsed with, for example:

npm run uri --http://user@example.com

A large number of unit tests covering many aspects of URI specifics are in thesrc/uri/__tests__ directory.To execute all of the unit tests run:

npm run jest

apg-js version 4.2.1 made a minor change to the parser and hence the parser generator.All of the grammars for all of the examples have been re-generated withapg-js 4.2.1.All of the updated examples run as expected.

This version has been tested for compliance withapg-js version 4.2.0.

An "all" option has been added to each example which will run allof the demonstrations for that example.Along with this is a new npm scriptnpm run all which will run all demonstrations for all examples.(Caveat: this will generate a lot of output.)

Even though the demonstrations are meant to be illustrative and not unit tests the "all" optionsand script have served as a crude means of insuring that nothing was broken with changes toapg-js.

npm

npm install apg-js-examplescd node_modules/apg-js-examplesnpm install

GitHub

mkdir node_modulescd node_modulesgit clone https://github.com/ldthomas/apg-js.gitgit clone https://github.com/ldthomas/apg-js-examples.gitcd apg-js-examplesnpm install

The code documentation is indocco format and can be generated with:

npm run docco

The documentation is then at./docs/index.html or see ithere at theAPG website.