[CS2] Add #! support for executable scripts on Linux.

documentation/sections/breaking_changes_argument_parsing_and_shebang_lines.md

@@ -11,6 +11,25 @@ Usage: coffee [options] [--] path/to/script.coffee [args]
 
 If called without options, `coffee` will run your script.
 
+  -b, --bare         compile without a top-level function wrapper
+  -c, --compile      compile to JavaScript and save as .js files
+  -e, --eval         pass a string from the command line as input
+  -h, --help         display this help message
+  -i, --interactive  run an interactive CoffeeScript REPL
+  -j, --join         concatenate the source CoffeeScript before compiling
+  -m, --map          generate source map and save as .js.map files
+  -M, --inline-map   generate source map and include it directly in output
+  -n, --nodes        print out the parse tree that the parser produces
+      --nodejs       pass options directly to the "node" binary
+      --no-header    suppress the "Generated by" header
+  -o, --output       set the output directory for compiled JavaScript
+  -p, --print        print out the compiled JavaScript
+  -r, --require      require the given module before eval or REPL
+  -s, --stdio        listen for and compile scripts over stdio
+  -l, --literate     treat stdio as literate style coffeescript
+  -t, --tokens       print out the tokens that the lexer/rewriter produce
+  -v, --version      display the version number
+  -w, --watch        watch scripts for changes and rerun commands
 
 ```
 
@@ -45,7 +64,7 @@ console.log x
 4
 ```
 
-Due to a bug in the argument parsing of previous CoffeeScript versions, this used to fail when trying to pass arguments to the script. Some users on OSX worked around the problem by using `#!/usr/bin/env coffee --` at the top of the file instead. However, that won't work on Linux, which cannot parse shebang lines with more than a single argument. While these scripts will still run on OSX, CoffeeScript will now display a warning before compiling or evaluating files that begin with a too-long shebang line:
+Due to a bug in the argument parsing of previous CoffeeScript versions, this used to fail when trying to pass arguments to the script. Some users on OS X worked around the problem by using `#!/usr/bin/env coffee --` at the top of the file instead. However, that won’t work on Linux, which cannot parse shebang lines with more than a single argument. While these scripts will still run on OSX, CoffeeScript will now display a warning before compiling or evaluating files that begin with a too-long shebang line:
 
 `invalid-executable-script.coffee`:
 ``` coffeescript
@@ -61,7 +80,7 @@ console.log x
 The script to be run begins with a shebang line with more than one
 argument. This script will fail on platforms such as Linux which only
 allow a single argument.
-The shebang line was: '#!/usr/bin/env coffee --' in file '/path/to/shebang-extra-args.coffee'
+The shebang line was: '#!/usr/bin/env coffee --' in file '/path/to/invalid-executable-script.coffee'
 The arguments were: ["coffee","--"]
 4
 ```

src/optparse.coffee

@@ -62,7 +62,7 @@ exports.OptionParser = class OptionParser
   help: ->
     lines = []
     lines.unshift "#{@banner}\n" if @banner
-    for rule in @rules
+    for rule in @rules.ruleList
       spaces  = 15 - rule.longFlag.length
       spaces  = if spaces > 0 then repeat ' ', spaces else ''
       letPart = if rule.shortFlag then rule.shortFlag + ', ' else '    '

test/invocation-argument-parsing.coffee → test/invocation_argument_parsing.coffee

@@ -10,9 +10,9 @@ patchedPath = "#{coffeeBinDir}:#{process.env.PATH}"
 patchedEnv = Object.assign {}, process.env, {PATH: patchedPath}
 
 shebangScript = require.resolve './importing/shebang.coffee'
-initialSpaceScript = require.resolve './importing/shebang-initial-space.coffee'
-extraArgsScript = require.resolve './importing/shebang-extra-args.coffee'
-initialSpaceExtraArgsScript = require.resolve './importing/shebang-initial-space-extra-args.coffee'
+initialSpaceScript = require.resolve './importing/shebang_initial_space.coffee'
+extraArgsScript = require.resolve './importing/shebang_extra_args.coffee'
+initialSpaceExtraArgsScript = require.resolve './importing/shebang_initial_space_extra_args.coffee'
 
 test "parse arguments for shebang scripts correctly (on unix platforms)", ->
   return if isWindows()

test/option_parser.coffee

@@ -5,12 +5,18 @@
 return unless require?
 {OptionParser} = require './../lib/coffeescript/optparse'
 
-opt = new OptionParser [
+flags = [
   ['-r', '--required [DIR]',  'desc required']
   ['-o', '--optional',        'desc optional']
   ['-l', '--list [FILES*]',   'desc list']
 ]
 
+banner = '''
+  banner text
+'''
+
+opt = new OptionParser flags, banner
+
 test "basic arguments", ->
   args = ['one', 'two', 'three', '-r', 'dir']
   result = opt.parse args
@@ -65,3 +71,37 @@ test "throw if multiple flags try to use the same short or long name", ->
     ['--just-long',       'desc']
     ['-j', '--just-long', 'another desc']
   ]
+
+reQuote = (str) -> (str ? '').replace /[.?*+^$[\]\\(){}|-]/g, "\\$&"
+
+flagPattern = (flag) ->
+  switch flag.length
+    when 2
+      shortFlag = null
+      [longFlag, desc] = flag
+    when 3
+      [shortFlag, longFlag, desc] = flag
+    else
+      throw new Error "invalid flag"
+  longFlagPat = reQuote longFlag.match(/--[^\s]+/)[0]
+  descPat = reQuote desc
+  if shortFlag?
+    joined = [reQuote(shortFlag), longFlagPat, descPat].join '.*'
+  else
+    joined = [longFlagPat, descPat].join '.*'
+  new RegExp "^.*#{joined}.*$", 'm'
+
+test "help text shows banner and all switches", ->
+  bannerHelp = opt.help()
+  bannerPattern = new RegExp reQuote(banner), 'g'
+  ok bannerHelp.match bannerPattern
+  for flag in flags
+    linePat = flagPattern flag
+    ok bannerHelp.match linePat
+
+test "help text shows switches, even without banner", ->
+  parser = new OptionParser flags
+  noBannerHelp = parser.help()
+  for flag in flags
+    linePat = flagPattern flag
+    ok noBannerHelp.match linePat