_js

mvdan-sh

This package is a JavaScript version of a shell package written in Go, available at https://github.com/mvdan/sh.

It is transpiled from Go to JS using GopherJS, available at https://github.com/gopherjs/gopherjs

Sample usage

const sh = require('mvdan-sh')
const syntax = sh.syntax

var parser = syntax.NewParser()
var printer = syntax.NewPrinter()

var src = "echo 'foo'"
var f = parser.Parse(src, "src.sh")

// print out the syntax tree
syntax.DebugPrint(f)
console.log()

// replace all single quoted string values
syntax.Walk(f, function(node) {
        if (syntax.NodeType(node) == "SglQuoted") {
                node.Value = "bar"
        }
        return true
})

// print the code back out
console.log(printer.Print(f)) // echo 'bar'

Available APIs

The APIs listed below are wrapped to be usable in JavaScript, such as replacing Go's io.Writer with string return parameters. Follow the links to read their documentation.

• syntax.NewParser
  • Parser.Parse
• syntax.DebugPrint
• syntax.Walk
• syntax.NewPrinter
  • Printer.Print

The nodes you will find in the syntax tree are all equivalent to the nodes you will see on the Go API. To get the type of a node, use syntax.NodeType as the example above shows. Some of the most common node types include:

• syntax.File
• syntax.Stmt
• syntax.CallExpr
• syntax.Word
• syntax.Lit

The five above will show up in your syntax tree if you parse a echo foo command, which you can see if you use syntax.DebugPrint to inspect the syntax tree.