bash-parser

Standard compliant bash parser

Usage no npm install needed!

<script type="module">
  import bashParser from 'https://cdn.skypack.dev/bash-parser';
</script>

README

bash-parser

Parses bash source code to produce an AST

Travis Build Status Coveralls NPM module NPM downloads Try online

Installation

npm install --save bash-parser

Usage

  const parse = require('bash-parser');
  const ast = parse('echo ciao');

ast result is:

{
        type: "Script",
        commands: [
            {
                type: "SimpleCommand",
                name: {
                    text: "echo",
                    type: "Word"
                },
                suffix: [
                    {
                        text: "ciao",
                        type: "Word"
                    }
                ]
            }
        ]
    }

Related projects

  • cash - This parser should become the parser used by cash (and also vorpal)
  • nsh - This parser should become the parser used by nsh
  • js-shell-parse - bash-parser was born as a fork of js-shell-parse, but was rewritten to use a jison grammar
  • jison - Bison in JavaScript.

Documentation

Look in documents folder

License

The MIT License (MIT)

Copyright (c) 2016 vorpaljs