coffee 實用程式。處理 CoffeeScript 的指令列編譯成各種形式：儲存到 .js 檔案或列印到 stdout，或在每次儲存來源時重新編譯，列印為代幣串流或語法樹，或啟動互動式 REPL。
外部依賴項。
fs = require 'fs'
path = require 'path'
helpers = require './helpers'
optparse = require './optparse'
CoffeeScript = require './coffee-script'
{spawn, exec} = require 'child_process'
{EventEmitter} = require 'events'
useWinPathSep = path.sep is '\\'允許 CoffeeScript 發出 Node.js 事件。
helpers.extend CoffeeScript, new EventEmitter
printLine = (line) -> process.stdout.write line + '\n'
printWarn = (line) -> process.stderr.write line + '\n'
hidden = (file) -> /^\.|~$/.test file與 -h/--help 結合列印的說明標語。
BANNER = '''
Usage: coffee [options] path/to/script.coffee -- [args]
If called without options, `coffee` will run your script.
'''coffee 知道如何處理的所有有效選項旗標清單。
SWITCHES = [
['-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 [FILE]', '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 [ARGS]', 'pass options directly to the "node" binary']
[ '--no-header', 'suppress the "Generated by" header']
['-o', '--output [DIR]', 'set the output directory for compiled JavaScript']
['-p', '--print', 'print out the compiled JavaScript']
['-r', '--require [MODULE*]', 'require the given module before eval or REPL']
['-s', '--stdio', 'listen for and compile scripts over stdio']
['-l', '--literate', 'treat stdio as literate style coffee-script']
['-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']
]所有函數共用的頂層物件。
opts = {}
sources = []
sourceCode = []
notSources = {}
watchedDirs = {}
optionParser = null透過解析傳遞的選項並決定要執行的動作來執行 coffee。許多旗標會導致我們在編譯任何內容之前轉移。在 -- 之後傳遞的旗標將逐字傳遞給您的指令碼作為 process.argv 中的引數。
exports.run = ->
parseOptions()讓 REPL CLI 使用全域環境，以便 (a) 與 node REPL CLI 保持一致，因此，(b) 使修改原生原型 (例如「顏色」和「糖」) 的套件按預期工作。
replCliOpts = useGlobal: yes
opts.prelude = makePrelude opts.require if opts.require
replCliOpts.prelude = opts.prelude
return forkNode() if opts.nodejs
return usage() if opts.help
return version() if opts.version
return require('./repl').start(replCliOpts) if opts.interactive
return compileStdio() if opts.stdio
return compileScript null, opts.arguments[0] if opts.eval
return require('./repl').start(replCliOpts) unless opts.arguments.length
literals = if opts.run then opts.arguments.splice 1 else []
process.argv = process.argv[0..1].concat literals
process.argv[0] = 'coffee'
opts.output = path.resolve opts.output if opts.output
if opts.join
opts.join = path.resolve opts.join
console.error '''
The --join option is deprecated and will be removed in a future version.
If for some reason it's necessary to share local variables between files,
replace...
$ coffee --compile --join bundle.js -- a.coffee b.coffee c.coffee
with...
$ cat a.coffee b.coffee c.coffee | coffee --compile --stdio > bundle.js
'''
for source in opts.arguments
source = path.resolve source
compilePath source, yes, source
makePrelude = (requires) ->
requires.map (module) ->
[_, name, module] = match if match = module.match(/^(.*)=(.*)$/)
name ||= helpers.baseFileName module, yes, useWinPathSep
"#{name} = require('#{module}')"
.join ';'編譯路徑，可以是指令碼或目錄。如果傳遞目錄，則遞迴編譯其中的所有「.coffee」、「.litcoffee」和「.coffee.md」延伸來源檔案以及所有子目錄。
compilePath = (source, topLevel, base) ->
return if source in sources or
watchedDirs[source] or
not topLevel and (notSources[source] or hidden source)
try
stats = fs.statSync source
catch err
if err.code is 'ENOENT'
console.error "File not found: #{source}"
process.exit 1
throw err
if stats.isDirectory()
if path.basename(source) is 'node_modules'
notSources[source] = yes
return
if opts.run
compilePath findDirectoryIndex(source), topLevel, base
return
watchDir source, base if opts.watch
try
files = fs.readdirSync source
catch err
if err.code is 'ENOENT' then return else throw err
for file in files
compilePath (path.join source, file), no, base
else if topLevel or helpers.isCoffee source
sources.push source
sourceCode.push null
delete notSources[source]
watch source, base if opts.watch
try
code = fs.readFileSync source
catch err
if err.code is 'ENOENT' then return else throw err
compileScript(source, code.toString(), base)
else
notSources[source] = yes
findDirectoryIndex = (source) ->
for ext in CoffeeScript.FILE_EXTENSIONS
index = path.join source, "index#{ext}"
try
return index if (fs.statSync index).isFile()
catch err
throw err unless err.code is 'ENOENT'
console.error "Missing index.coffee or index.litcoffee in #{source}"
process.exit 1根據請求的選項，編譯包含給定程式碼的單一來源指令碼。如果直接評估指令碼，會將 __filename、__dirname 和 module.filename 設定為相對於指令碼路徑正確的內容。
compileScript = (file, input, base = null) ->
o = opts
options = compileOptions file, base
try
t = task = {file, input, options}
CoffeeScript.emit 'compile', task
if o.tokens
printTokens CoffeeScript.tokens t.input, t.options
else if o.nodes
printLine CoffeeScript.nodes(t.input, t.options).toString().trim()
else if o.run
CoffeeScript.register()
CoffeeScript.eval opts.prelude, t.options if opts.prelude
CoffeeScript.run t.input, t.options
else if o.join and t.file isnt o.join
t.input = helpers.invertLiterate t.input if helpers.isLiterate file
sourceCode[sources.indexOf(t.file)] = t.input
compileJoin()
else
compiled = CoffeeScript.compile t.input, t.options
t.output = compiled
if o.map
t.output = compiled.js
t.sourceMap = compiled.v3SourceMap
CoffeeScript.emit 'success', task
if o.print
printLine t.output.trim()
else if o.compile or o.map
writeJs base, t.file, t.output, options.jsPath, t.sourceMap
catch err
CoffeeScript.emit 'failure', err, task
return if CoffeeScript.listeners('failure').length
message = err?.stack or "#{err}"
if o.watch
printLine message + '\x07'
else
printWarn message
process.exit 1附加適當的監聽器，以編譯透過 stdin 進來的指令碼，並將其寫回 stdout。
compileStdio = ->
buffers = []
stdin = process.openStdin()
stdin.on 'data', (buffer) ->
buffers.push buffer if buffer
stdin.on 'end', ->
compileScript null, Buffer.concat(buffers).toString()如果所有來源檔案都已讀取完畢，請將它們串聯並編譯在一起。
joinTimeout = null
compileJoin = ->
return unless opts.join
unless sourceCode.some((code) -> code is null)
clearTimeout joinTimeout
joinTimeout = wait 100, ->
compileScript opts.join, sourceCode.join('\n'), opts.join使用 fs.watch 監控來源 CoffeeScript 檔案，每次檔案更新時重新編譯。可以與其他選項搭配使用，例如 --print。
watch = (source, base) ->
watcher = null
prevStats = null
compileTimeout = null
watchErr = (err) ->
throw err unless err.code is 'ENOENT'
return unless source in sources
try
rewatch()
compile()
catch
removeSource source, base
compileJoin()
compile = ->
clearTimeout compileTimeout
compileTimeout = wait 25, ->
fs.stat source, (err, stats) ->
return watchErr err if err
return rewatch() if prevStats and
stats.size is prevStats.size and
stats.mtime.getTime() is prevStats.mtime.getTime()
prevStats = stats
fs.readFile source, (err, code) ->
return watchErr err if err
compileScript(source, code.toString(), base)
rewatch()
startWatcher = ->
watcher = fs.watch source
.on 'change', compile
.on 'error', (err) ->
throw err unless err.code is 'EPERM'
removeSource source, base
rewatch = ->
watcher?.close()
startWatcher()
try
startWatcher()
catch err
watchErr err監控目錄中的檔案是否有新增內容。
watchDir = (source, base) ->
watcher = null
readdirTimeout = null
startWatcher = ->
watcher = fs.watch source
.on 'error', (err) ->
throw err unless err.code is 'EPERM'
stopWatcher()
.on 'change', ->
clearTimeout readdirTimeout
readdirTimeout = wait 25, ->
try
files = fs.readdirSync source
catch err
throw err unless err.code is 'ENOENT'
return stopWatcher()
for file in files
compilePath (path.join source, file), no, base
stopWatcher = ->
watcher.close()
removeSourceDir source, base
watchedDirs[source] = yes
try
startWatcher()
catch err
throw err unless err.code is 'ENOENT'
removeSourceDir = (source, base) ->
delete watchedDirs[source]
sourcesChanged = no
for file in sources when source is path.dirname file
removeSource file, base
sourcesChanged = yes
compileJoin() if sourcesChanged從我們的來源清單和來源程式碼快取中移除檔案。選擇性地移除已編譯的 JS 版本。
removeSource = (source, base) ->
index = sources.indexOf source
sources.splice index, 1
sourceCode.splice index, 1
unless opts.join
silentUnlink outputPath source, base
silentUnlink outputPath source, base, '.js.map'
timeLog "removed #{source}"
silentUnlink = (path) ->
try
fs.unlinkSync path
catch err
throw err unless err.code in ['ENOENT', 'EPERM']取得來源檔案對應的輸出 JavaScript 路徑。
outputPath = (source, base, extension=".js") ->
basename = helpers.baseFileName source, yes, useWinPathSep
srcDir = path.dirname source
if not opts.output
dir = srcDir
else if source is base
dir = opts.output
else
dir = path.join opts.output, path.relative base, srcDir
path.join dir, basename + extension遞迴 mkdir，就像 mkdir -p。
mkdirp = (dir, fn) ->
mode = 0o777 & ~process.umask()
do mkdirs = (p = dir, fn) ->
fs.exists p, (exists) ->
if exists
fn()
else
mkdirs path.dirname(p), ->
fs.mkdir p, mode, (err) ->
return fn err if err
fn()使用已編譯程式碼寫出 JavaScript 來源檔案。預設情況下，檔案會以 .js 檔案的形式寫入 cwd，且名稱相同，但輸出目錄可以使用 --output 自訂。
如果提供了 generatedSourceMap，這會在與 .js 檔案相同的目錄中寫入 .js.map 檔案。
writeJs = (base, sourcePath, js, jsPath, generatedSourceMap = null) ->
sourceMapPath = outputPath sourcePath, base, ".js.map"
jsDir = path.dirname jsPath
compile = ->
if opts.compile
js = ' ' if js.length <= 0
if generatedSourceMap then js = "#{js}\n//# sourceMappingURL=#{helpers.baseFileName sourceMapPath, no, useWinPathSep}\n"
fs.writeFile jsPath, js, (err) ->
if err
printLine err.message
process.exit 1
else if opts.compile and opts.watch
timeLog "compiled #{sourcePath}"
if generatedSourceMap
fs.writeFile sourceMapPath, generatedSourceMap, (err) ->
if err
printLine "Could not write source map: #{err.message}"
process.exit 1
fs.exists jsDir, (itExists) ->
if itExists then compile() else mkdirp jsDir, compile方便更乾淨的 setTimeouts。
wait = (milliseconds, func) -> setTimeout func, milliseconds觀看腳本時，使用時間戳記記錄變更很有用。
timeLog = (message) ->
console.log "#{(new Date).toLocaleTimeString()} - #{message}"漂亮列印一串代幣，不含位置資料。
printTokens = (tokens) ->
strings = for token in tokens
tag = token[0]
value = token[1].toString().replace(/\n/, '\\n')
"[#{tag} #{value}]"
printLine strings.join(' ')使用 OptionParser 模組 從 process.argv 中擷取 SWITCHES 中指定的全部選項。
parseOptions = ->
optionParser = new optparse.OptionParser SWITCHES, BANNER
o = opts = optionParser.parse process.argv[2..]
o.compile or= !!o.output
o.run = not (o.compile or o.print or o.map)
o.print = !! (o.print or (o.eval or o.stdio and o.compile))傳遞給 CoffeeScript 編譯器的編譯時間選項。
compileOptions = (filename, base) ->
answer = {
filename
literate: opts.literate or helpers.isLiterate(filename)
bare: opts.bare
header: opts.compile and not opts['no-header']
sourceMap: opts.map
inlineMap: opts['inline-map']
}
if filename
if base
cwd = process.cwd()
jsPath = outputPath filename, base
jsDir = path.dirname jsPath
answer = helpers.merge answer, {
jsPath
sourceRoot: path.relative jsDir, cwd
sourceFiles: [path.relative cwd, filename]
generatedFile: helpers.baseFileName(jsPath, no, useWinPathSep)
}
else
answer = helpers.merge answer,
sourceRoot: ""
sourceFiles: [helpers.baseFileName filename, no, useWinPathSep]
generatedFile: helpers.baseFileName(filename, yes, useWinPathSep) + ".js"
answer使用傳遞給 node 二進位檔的 --nodejs 中的引數啟動新的 Node.js 實例，保留其他選項。
forkNode = ->
nodeArgs = opts.nodejs.split /\s+/
args = process.argv[1..]
args.splice args.indexOf('--nodejs'), 2
p = spawn process.execPath, nodeArgs.concat(args),
cwd: process.cwd()
env: process.env
stdio: [0, 1, 2]
p.on 'exit', (code) -> process.exit code列印 --help 使用訊息並結束。不顯示已棄用的開關。
usage = ->
printLine (new optparse.OptionParser SWITCHES, BANNER).help()列印 --version 訊息並結束。
version = ->
printLine "CoffeeScript version #{CoffeeScript.VERSION}"