appology / nearley-template

Your own DSL, in javascript, in a nice reusable package!

Crafted with ♡ by Appology

Made possible by the super awesome nearley parser toolkit.

Before you install...

Please keep in mind that this project is not yet battle tested.

Issues?

You can submit new issues using GitHub Issues

Install:

npm i -g nearley-template

Init:

mkdir my_project && cd my_project
nearleyt init

After a few short questions, you'll be ready to hack with:

• A sample nearley grammar that emulates a calculator
• Unit testing with ava
• Modern javascript via babel
• Continuous integration via Travis-CI
• Rapid testing via Wallaby.js
• Watch support via npm-watch
• Visual Studio Code support (settings.json)

Some helpful commands:

# compile the grammar and javascript files
# under /src into /lib
npm run build

# run all tests manually
npm test

# when using a test runner like Wallaby.js,
# recompiles /src/grammar.ne as you save
npm run watch nearley