Fetching contributors…
Cannot retrieve contributors at this time
177 lines (143 sloc) 6.89 KB
util = require "util"
fs = require "fs"
path = require "path"
child_process = require "child_process"
spawn = (procName, optArray, silent = false, sync = false) ->
if process.platform is "win32"
# if win32, prefix arguments with "/c {original command}"
# e.g. "coffee -c c:\git\vimium" becomes "cmd.exe /c coffee -c c:\git\vimium"
optArray.unshift "/c", procName
procName = "cmd.exe"
if sync
proc = child_process.spawnSync procName, optArray, {
stdio: [undefined, process.stdout, process.stderr]
proc = child_process.spawn procName, optArray
unless silent
proc.stdout.on 'data', (data) -> process.stdout.write data
proc.stderr.on 'data', (data) -> process.stderr.write data
optArrayFromDict = (opts) ->
result = []
for own key, value of opts
if value instanceof Array
result.push "--#{key}=#{v}" for v in value
result.push "--#{key}=#{value}"
# visitor will get passed the file path as a parameter
visitDirectory = (directory, visitor) ->
fs.readdirSync(directory).forEach (filename) ->
filepath = path.join directory, filename
if (fs.statSync filepath).isDirectory()
return visitDirectory filepath, visitor
return unless (fs.statSync filepath).isFile()
task "build", "compile all coffeescript files to javascript", ->
coffee = spawn "coffee", ["-c", __dirname]
coffee.on 'exit', (returnCode) -> process.exit returnCode
task "clean", "removes any js files which were compiled from coffeescript", ->
visitDirectory __dirname, (filepath) ->
return unless (path.extname filepath) == ".js"
directory = path.dirname filepath
# Check if there exists a corresponding .coffee file
coffeeFile = fs.statSync path.join directory, "#{path.basename filepath, ".js"}.coffee"
catch _
fs.unlinkSync filepath if coffeeFile.isFile()
task "autobuild", "continually rebuild coffeescript files using coffee --watch", ->
coffee = spawn "coffee", ["-cw", __dirname]
task "package", "Builds a zip file for submission to the Chrome store. The output is in dist/", ->
vimium_version = JSON.parse(fs.readFileSync("manifest.json").toString())["version"]
invoke "build"
spawn "rm", ["-rf", "dist/vimium"], false, true
spawn "mkdir", ["-p", "dist/vimium"], false, true
blacklist = [".*", "*.coffee", "*.md", "reference", "test_harnesses", "tests", "dist", "git_hooks",
"CREDITS", "node_modules", "MIT-LICENSE.txt", "Cakefile"]
rsyncOptions = [].concat.apply(
["-r", ".", "dist/vimium"], -> ["--exclude", "#{item}"]))
spawn "rsync", rsyncOptions, false, true
distManifest = "dist/vimium/manifest.json"
manifest = JSON.parse fs.readFileSync(distManifest).toString()
# Build the Chrome Store package; this does not require the clipboardWrite permission.
manifest.permissions = (permission for permission in manifest.permissions when permission != "clipboardWrite")
fs.writeFileSync distManifest, JSON.stringify manifest, null, 2
spawn "zip", ["-r", "dist/vimium-chrome-store-#{vimium_version}.zip", "dist/vimium"], false, true
# Build the Chrome Store dev package. = "Vimium Canary"
manifest.description = "This is the development branch of Vimium (it is beta software)."
fs.writeFileSync distManifest, JSON.stringify manifest, null, 2
spawn "zip", ["-r", "dist/vimium-canary-#{vimium_version}.zip", "dist/vimium"], false, true
# Build Firefox release.
spawn "zip", "-r -FS dist/vimium-ff-#{vimium_version}.zip background_scripts Cakefile content_scripts CREDITS icons lib
manifest.json MIT-LICENSE.txt pages -x *.coffee -x Cakefile -x CREDITS -x *.md".split(/\s+/), false, true
# This builds a CRX that's distributable outside of the Chrome web store. Is this used by folks who fork
# Vimium and want to distribute their fork?
task "package-custom-crx", "build .crx file", ->
# To get crxmake, use `sudo gem install crxmake`.
invoke "build"
# ugly hack to modify our manifest file on-the-fly
origManifestText = fs.readFileSync "manifest.json"
manifest = JSON.parse origManifestText
# Update manifest fields that you would like to override here. If
# distributing your CRX outside the Chrome webstore in a fork, please follow
# the instructions available at
# manifest.update_url = ""
fs.writeFileSync "manifest.json", JSON.stringify manifest
pem = process.env.VIMIUM_CRX_PEM ? "vimium.pem"
target = "vimium-latest.crx"
console.log "Building crx file..."
console.log " using pem-file: #{pem}"
console.log " target: #{target}"
crxmake = spawn "crxmake", optArrayFromDict
"pack-extension": "."
"pack-extension-key": pem
"extension-output": target
"ignore-file": "(^\\.|\\.(coffee|crx|pem|un~)$)"
"ignore-dir": "^(\\.|test)"
crxmake.on "exit", -> fs.writeFileSync "manifest.json", origManifestText
runUnitTests = (projectDir=".", testNameFilter) ->
console.log "Running unit tests..."
basedir = path.join projectDir, "/tests/unit_tests/"
test_files = fs.readdirSync(basedir).filter((filename) -> filename.indexOf("_test.js") > 0)
test_files = -> basedir + filename)
test_files.forEach (file) -> require (if file[0] == '/' then '' else './') + file
return Tests.testsFailed
option '', '--filter-tests [string]', 'filter tests by matching string'
task "test", "run all tests", (options) ->
unitTestsFailed = runUnitTests('.', options['filter-tests'])
console.log "Running DOM tests..."
phantom = spawn "phantomjs", ["./tests/dom_tests/phantom_runner.js"]
phantom.on 'exit', (returnCode) ->
if returnCode > 0 or unitTestsFailed > 0
process.exit 1
process.exit 0
task "coverage", "generate coverage report", ->
{Utils} = require './lib/utils'
temp = require 'temp'
tmpDir = temp.mkdirSync null
jscoverage = spawn "jscoverage", [".", tmpDir].concat optArrayFromDict
"exclude": [".git", "node_modules"]
"no-instrument": "tests"
jscoverage.on 'exit', (returnCode) ->
process.exit 1 unless returnCode == 0
console.log "Running DOM tests..."
phantom = spawn "phantomjs", [path.join(tmpDir, "tests/dom_tests/phantom_runner.js"), "--coverage"]
phantom.on 'exit', ->
# merge the coverage counts from the DOM tests with those from the unit tests
global._$jscoverage = JSON.parse fs.readFileSync path.join(tmpDir,
# marshal the counts into a form that the JSCoverage front-end expects
result = {}
for own fname, coverage of _$jscoverage
result[fname] =
coverage: coverage
source: (Utils.escapeHtml fs.readFileSync fname, 'utf-8').split '\n'
fs.writeFileSync 'jscoverage.json', JSON.stringify(result)