/bash-parser

Parses bash into an AST; fork of vorpaljs/bash-parser offering dependency maintenance

Primary LanguageJavaScriptMIT LicenseMIT

bash-parser

A fork of vorpaljs/bash-parser - Parses bash source code to produce an AST

This fork is focussed at dependency maintenance and will not receive any updates beyond that. No new features, no bug (nor security) fixes.

All (relevant) changes of this fork are being upstreamed at vorpaljs#66.

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