more stuff

Author: grncdr

build.js

@@ -1,16 +1,52 @@
 var fs = require('fs')
 var pegjs = require('pegjs')
 var overrideAction = require('pegjs-override-action')
-var grammar = fs.readFileSync(__dirname + '/grammar.pegjs', 'utf8')
 
-var parserSource = pegjs.buildParser(grammar, {
-  output: "source",
-  plugins: [overrideAction],
-  overrideActionPlugin: require('./overrides')
-})
+var input     = __dirname + '/grammar.pegjs'
+var output    = __dirname + '/parser.js'
+var overrides = __dirname + '/overrides.js'
 
 if (require.main === module) {
-  console.log('module.exports=' + parserSource + '.parse')
-} else {
-  module.exports = eval(parserSource).parse
+  if (process.argv[2] == '-w') {
+    watch()
+  } else {
+    console.log(getSource())
+  }
+}
+
+function getSource () {
+  var grammar = fs.readFileSync(input, 'utf8')
+  var parserSource = pegjs.buildParser(grammar, {
+    output: "source",
+    /*
+    allowedStartRules: [
+      'commandList',
+      'command',
+      'argument'
+    ],
+   */
+    plugins: [overrideAction],
+    overrideActionPlugin: require('./overrides')
+  })
+  return [
+    'var parser=' + parserSource,
+    'parser.parse.SyntaxError = parser.SyntaxError',
+    'module.exports=parser.parse'
+  ].join('\n');
+}
+
+function watch () {
+  fs.watchFile(input, onChange)
+  fs.watchFile(overrides, onChange)
+
+  function onChange (curr, prev) {
+    if (curr.mtime > prev.mtime) {
+      try {
+        var source = getSource()
+        fs.writeFileSync(output, source)
+      } catch (err) {
+        console.error(err.message)
+      }
+    }
+  }
 }

grammar.pegjs

@@ -13,13 +13,7 @@ variableAssignment
  = writableVariableName '=' argToken
 
 commandToken "command name"
- = bareword
- / concatenation
- / doubleQuote
- / variableSubstitution
- / environmentVariable
- / subShell
- / backticks
+ = concatenation
 
 argToken "command argument"
  = commandToken
@@ -33,7 +27,7 @@ writableVariableName = [a-zA-Z0-9_]+
 readableVariableName = writableVariableName / '?'  /* todo, other special vars */
 
 bareword
- = cs:(escapedMetaChar / [^$"';&<>\n()\[\]*?| ])+
+ = cs:(escapedMetaChar / [^$"';&<>\n()\[\]*?|` ])+
 
 escapedMetaChar
  = '\\' character:[$\\"&<> ]
@@ -43,10 +37,11 @@ variableSubstitution
 
 concatenation
  = pieces:( bareword
+          / singleQuote
           / doubleQuote
           / environmentVariable
           / variableSubstitution
-          / subShell
+          / subshell
           / backticks
           )+
 
@@ -69,13 +64,13 @@ expandsInQuotes
  = backticks
  / environmentVariable
  / variableSubstitution
- / subShell
+ / subshell
 
 backticks
- = '`' commands:commandList+ '`'
+ = '`' commands:(!backticks command)+ '`'
 
-subShell
- = '$(' commands:commandList+ ')'
+subshell
+ = '$(' commands:command+ ')'
 
 commandSubstitution
  = rw:[<>] '(' commands:commandList ')'

overrides.js

@@ -17,6 +17,7 @@ var rules = exports.rules = {}
 
 exports.initializer = [
   'var isArray = require("isarray")',
+  'var map = require("array-map")',
   function join (arr) {
     return arr.join("")
   },
@@ -32,15 +33,30 @@ exports.initializer = [
   function second (arr) {
     return arr[1]
   },
-  function flattenConcatenations (pieces) {
-    var results = []
-    pieces.forEach(function (piece) {
-      if (piece.type == 'concatenation')
-        results = results.concat(piece.pieces)
-      else
-        results.push(piece)
-    })
-    return results
+  function flattenConcatenation (pieces) {
+    var result = [pieces[0]]
+      , len = pieces.length
+      , prev = pieces[0]
+      , current
+
+    for (var i = 1; i < len; i++) {
+      current = pieces[i]
+      if (current.type == 'concatenation') {
+        current = flattenConcatenation(current)
+      }
+      if (current.type == 'literal' && prev.type == 'literal') {
+        // merge two literals
+        prev.value += current.value
+      }
+      else {
+        result.push(current)
+        prev = current
+      }
+    }
+    return result.length == 1 ? result[0] : {
+      type: 'concatenation',
+      pieces: result
+    }
   }
 ].join('\n')
 
@@ -53,7 +69,7 @@ rules.command = function (command, args, redirects, control) {
   return {
     type: 'command',
     command: command,
-    args: args.map(second),
+    args: map(args, second),
     redirects: redirects,
     control: control || ';',
     env: env
@@ -91,30 +107,23 @@ rules.bareword = function (cs) { return literal(cs) }
 rules.escapedMetaChar = function (character) { return character }
 
 rules.concatenation = function (pieces) {
-  pieces = flattenConcatenations(pieces)
-  return pieces.length == 1 ? pieces[0] : {
-    type: 'concatenation',
-    pieces: pieces
-  }
+  return flattenConcatenation(pieces)
 }
 
 rules.singleQuote = function (cs) { return literal(cs) }
 rules.doubleQuote = function (contents) {
   var pieces = contents.map(function (it) {
     return isArray(it) ?  literal(it) : it
   })
-  pieces = flattenConcatenations(pieces)
-  return pieces.length == 1 ? pieces[0] : {
-    type: 'concatenation',
-    pieces: pieces
-  }
+  return flattenConcatenation(pieces)
 }
 
 rules.escapedQuote = function (character) {
   return character
 }
 rules.backticks = function (commands) {
-  return {type: 'backticks', commands: commands}
+  debugger
+  return {type: 'backticks', commands: commands.map(second)}
 }
 
 rules.subshell = function (commands) {

package.json

@@ -4,25 +4,42 @@
   "description": "Parse bash scripts into AST's",
   "main": "parser.js",
   "dependencies": {
-    "isarray": "0.0.1"
+    "isarray": "0.0.1",
+    "array-map": "0.0.0"
+  },
+  "scripts": {
+    "test": "tape tests/*.js",
+    "watch-grammar": "node build.js -w &",
+    "prepublish": "node build.js > parser.js"
   },
   "testling": {
     "files": "tests/*.js",
     "browsers": {
-      "ie": [ 8, 9, 10 ],
-      "firefox": [ "3.5", "nightly" ],
-      "opera": [ 11, 17 ],
-      "safari": ["5.1"]
+      "ie": [
+        8,
+        9,
+        10
+      ],
+      "firefox": [
+        "3.5",
+        "nightly"
+      ],
+      "opera": [
+        11,
+        17
+      ],
+      "safari": [
+        "5.1"
+      ]
     }
   },
   "devDependencies": {
     "pegjs": "~0.8.0",
     "pegjs-override-action": "0.0.7",
-    "tape": "~2.3.2"
-  },
-  "scripts": {
-    "test": "tape tests/*.js",
-    "prepublish": "node build.js > parser.js"
+    "tape": "~2.3.2",
+    "watchify": "~0.5.0",
+    "catw": "~0.2.0",
+    "covert": "~0.2.0"
   },
   "repository": {
     "type": "git",

tests/concatenation.js

@@ -0,0 +1,29 @@
+var test = require('tape')
+var parse = require('../parser')
+
+test('concatenation', function (t) {
+  var ast = parse('echo "two "\' strings\'')
+  t.deepEqual(ast[0].args, [
+    { type: 'literal', value: 'two  strings' }
+  ], 'concatenated literals are flattened') 
+
+  var ast = parse('echo $var"and a string"')
+  t.deepEqual(ast[0].args, [
+    { type: 'concatenation',
+      pieces: [
+        { type: 'variable',
+          name: 'var' },
+        { type: 'literal',
+          value: 'and a string' }
+      ]
+    }
+  ], 'can concatenate $var and strings') 
+
+  var ast = parse('echo "it\'s easy to switch "\'"back"\'" and "\'"forth"\'')
+  t.deepEqual(ast[0].args, [
+    { type: 'literal',
+      value: 'it\'s easy to switch "back" and "forth"' }
+  ], 'can concatenate alternating quote contexts') 
+
+  t.end()
+})

tests/escaping-in-quotes.js

@@ -1,5 +1,5 @@
 var test = require('tape')
-var parse = require('../build')
+var parse = require('../parser')
 
 test('escaping in quotes', function (t) {
   var ast = parse('echo "An escaped double-quote: \\""')

tests/escaping-meta-chars.js

@@ -1,5 +1,5 @@
 var test = require('tape')
-var parse = require('../build')
+var parse = require('../parser')
 
 test('escaping meta characters in barewords', function (t) {
   var ast = parse('echo I\\ am\\ one\\ arg')[0]

tests/interpolation-in-quotes.js

@@ -0,0 +1,49 @@
+var test = require('tape')
+var parse = require('../parser')
+
+test('interpolating in quotes', function (t) {
+
+  var ast = parse('echo "interpolated `backtick command`"')
+  t.deepEqual(ast[0].args, [{
+    type: 'concatenation',
+    pieces: [
+      { type: "literal", value:"interpolated " },
+      { type: "backticks",
+        commands: [
+          { type: 'command',
+            command: { type: 'literal', value: 'backtick' },
+            args: [
+              {type: 'literal', value: 'command'}
+            ],
+            redirects: [],
+            env: {},
+            control: ';' }
+        ]
+      }]
+    }], "Can interpolate back-ticks (but you really shouldn't!)")
+
+
+  var ast = parse('echo "interpolated $(command1; command2)"')
+  t.deepEqual(ast[0].args, [{
+    type: 'concatenation',
+    pieces: [
+      { type: "literal", value:"interpolated " },
+      { type: "subshell",
+        commands: [
+          { type: 'command',
+            command: { type: 'literal', value: 'command1' },
+            args: [],
+            redirects: [],
+            env: {},
+            control: ';' },
+          { type: 'command',
+            command: { type: 'literal', value: 'command2' },
+            args: [],
+            redirects: [],
+            env: {},
+            control: ';' }
+        ]
+      }]
+    }], "Can interpolate subshells (better idea!)")
+  t.end()
+})

tests/multi-line-strings.js

@@ -1,5 +1,5 @@
 var test = require('tape')
-var parse = require('../build')
+var parse = require('../parser')
 
 test('Multi-line strings', function (t) {
   var input = [

tests/multiple-commands.js

@@ -1,5 +1,5 @@
 var test = require('tape')
-var parse = require('../build')
+var parse = require('../parser')
 
 test('Multiple commands', function (t) {
   var input = [

tests/npm-debug.log

@@ -0,0 +1,7 @@
+var test = require('tape')
+var parse = require('../parser')
+
+test('variable substitutions', function (t) {
+  t.skip('not yet')
+  t.end()
+})