You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
7 years ago
|
# better-peg-tracer
|
||
|
|
|
||
|
|
A better terminal-based tracer for debugging PEG.js. Better documentation coming soon.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[WTFPL](http://www.wtfpl.net/txt/copying/) or [CC0](https://creativecommons.org/publicdomain/zero/1.0/), whichever you prefer. A donation and/or attribution are appreciated, but not required.
|
||
|
|
|
||
|
|
## Donate
|
||
|
|
|
||
|
|
Maintaining open-source projects takes a lot of time, and the more donations I receive, the more time I can dedicate to open-source. If this module is useful to you, consider [making a donation](http://cryto.net/~joepie91/donate.html)!
|
||
|
|
|
||
|
|
You can donate using Bitcoin, PayPal, Flattr, cash-in-mail, SEPA transfers, and pretty much anything else. Thank you!
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Pull requests welcome. Please make sure your modifications are in line with the overall code style, and ensure that you're editing the files in `src/`, not those in `lib/`.
|
||
|
|
|
||
|
|
Build tool of choice is `gulp`; simply run `gulp` while developing, and it will watch for changes.
|
||
|
|
|
||
|
|
Be aware that by making a pull request, you agree to release your modifications under the licenses stated above.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
const pegjs = require("pegjs");
|
||
|
|
const createBetterPegTracer = require("better-peg-tracer");
|
||
|
|
|
||
|
|
let stringToParse = `
|
||
|
|
foo{{{}}
|
||
|
|
{{align:center}bar
|
||
|
|
qux {class:test1,test2}baz{/class}{/align}}
|
||
|
|
`.trim();
|
||
|
|
|
||
|
|
let parser = pegjs.buildParser(pegGrammar, {
|
||
|
|
trace: true
|
||
|
|
});
|
||
|
|
|
||
|
|
let results = parser.parse(stringToParse, {
|
||
|
|
tracer: createBetterPegTracer(stringToParse)
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### createBetterPegTracer(inputString)
|
||
|
|
|
||
|
|
Creates a tracer for the specified `inputString`.
|
||
|
|
|
||
|
|
* __inputString__: The string that is going to be parsed. This is necessary for snippet display to work.
|