Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

235 lines (201 sloc) 8.579 kb
File = require("fs")
Path = require("path")
HLJS = require("highlight/lib/vendor/highlight.js/highlight").hljs
{spawn, exec} = require("child_process")
stdout = process.stdout
# Use executables installed with npm bundle.
process.env["PATH"] = "node_modules/.bin:#{process.env["PATH"]}"
# ANSI Terminal Colors.
bold = "\033[0;1m"
red = "\033[0;31m"
green = "\033[0;32m"
reset = "\033[0m"
# Log a message with a color.
log = (message, color, explanation) ->
console.log color + message + reset + ' ' + (explanation or '')
# Handle error and kill the process.
onerror = (err)->
if err
process.stdout.write "#{red}#{err.stack}#{reset}\n"
process.exit -1
## Setup ##
# Setup development dependencies, not part of runtime dependencies.
task "setup", "Install development dependencies", ->
File.readFile "package.json", "utf8", (err, package)->
install = (dependencies, callback)->
if dep = dependencies.shift()
[name, version] = dep
log "Installing #{name} #{version}", green
exec "npm install \"#{name}@#{version}\"", (err)->
if err
onerror err
else
install dependencies, callback
else if callback
callback()
json = JSON.parse(package)
log "Need runtime dependencies, installing into node_modules ...", green
dependencies = []
dependencies.push [name, version] for name, version of json.dependencies
install dependencies, ->
log "Need development dependencies, installing ...", green
dependencies = []
dependencies.push [name, version] for name, version of json.devDependencies
install dependencies
task "install", "Install Zombie in your local repository", ->
generateMan (err)->
onerror err
log "Installing Zombie ...", green
exec "npm install", (err, stdout, stderr)->
process.stdout.write stderr
onerror err
clean = (callback)->
exec "rm -rf build html man7", callback
task "clean", "Remove temporary files and such", -> clean onerror
## Testing ##
runTests = (callback)->
log "Running test suite ...", green
exec "vows --spec spec/*_spec.coffee", (err, stdout, stderr)->
process.stdout.write stdout
process.stderr.write stderr
callback err if callback
task "test", "Run all tests", ->
runTests (err)->
process.stdout.on "drain", -> process.exit -1 if err
## Documentation ##
# HLJS can't guess the language (JavaScript) consistently, so we're going to help by limiting its choice of languages to
# JavaScript and XML (good pick for one of the dumps).
require("highlight/lib/vendor/highlight.js/languages/xml")(HLJS)
require("highlight/lib/vendor/highlight.js/languages/javascript")(HLJS)
# Syntax highlighting
highlight = (html)->
unescape = (html)->
return html.replace(/&quot;/g, "\"").replace(/&amp;/g, "&").replace(/&lt;/g, "<").replace(/&gt;/g, ">")
return html.replace(/<code>([\s\S]*?)<\/code>/gm, (_, source)-> "<code>#{HLJS.highlightText(unescape(source).replace(/\uffff/g,"\n"))}</code>")
# Markdown to HTML.
toHTML = (source, callback)->
target = "html/#{Path.basename(source, ".md").toLowerCase()}.html"
File.readFile "doc/layout/main.html", "utf8", (err, layout)->
onerror err
File.readFile source, "utf8", (err, text)->
onerror err
log "Creating #{target}", green
exec "ronn --html #{source}", (err, stdout, stderr)->
onerror err
[name, title] = stdout.match(/<h1>(.*)<\/h1>/)[1].split(" -- ")
name = name.replace(/\(\d\)/, "")
body = stdout.replace(/<h1>.*<\/h1>/, "")
html = layout.replace("{{body}}", body).replace(/{{title}}/g, title)
html = highlight(html)
File.writeFile target, html, "utf8", (err)->
callback err, target
documentPages = (callback)->
files = File.readdirSync(".").filter((file)-> Path.extname(file) == ".md").
concat(File.readdirSync("doc").filter((file)-> Path.extname(file) == ".md").map((file)-> "doc/#{file}"))
File.mkdir "html", 0777, ->
convert = ->
if file = files.pop()
toHTML file, (err)->
onerror err
convert()
else
process.stdout.write "\n"
File.readFile "html/readme.html", "utf8", (err, html)->
html = html.replace(/<h1>(.*)<\/h1>/, "<h1>Zombie.js</h1><b>$1</b>")
File.writeFile "html/index.html", html, "utf8", onerror
File.unlink "html/readme.html", onerror
exec "cp -fr doc/css doc/images html/", callback
convert()
documentSource = (callback)->
log "Documenting source files ...", green
exec "docco lib/**/*.coffee", (err, stdout, stderr)->
log stdout, green
onerror err
log "Copying to html/source", green
exec "mkdir -p html && cp -rf docs/ html/source && rm -rf docs", callback
generateMan = (callback)->
files = File.readdirSync(".").filter((file)-> Path.extname(file) == ".md").
concat(File.readdirSync("doc").filter((file)-> Path.extname(file) == ".md").map((file)-> "doc/#{file}"))
File.mkdir "man7", 0777, (err)->
log "Generating man file ...", green
convert = ->
if file = files.pop()
target = "man7/#{Path.basename(file, ".md").toLowerCase()}.7"
exec "ronn --roff #{file}", (err, stdout, stderr)->
onerror err
log "Creating #{target}", green
File.writeFile target, stdout, "utf8", onerror
convert()
else
exec "mv man7/readme.7 man7/zombie.7", onerror
process.stdout.write "\n"
callback()
convert()
generatePDF = (callback)->
log "Generating PDF documentation ...", green
files = "index api selectors troubleshoot".split(" ").map((f)-> "html/#{f}.html")
options = "--disable-javascript --outline --print-media-type --title Zombie.js --header-html doc/layout/header.html --allow doc/images"
margins = "--margin-left 30 --margin-right 30 --margin-top 30 --margin-bottom 30 --header-spacing 5"
outline = " --outline --outline-depth 2"
toc = "toc --disable-dotted-lines"
cover = "cover doc/layout/cover.html"
exec "wkhtmltopdf #{options} #{margins} #{cover} #{toc} #{files.join(" ")} html/zombie.pdf", callback
generateDocs = (callback)->
log "Generating documentation ...", green
documentPages (err)->
onerror err
documentSource (err)->
onerror err
generatePDF (err)->
onerror err
generateMan callback
task "doc:pages", "Generate documentation for main pages", -> documentPages onerror
task "doc:source", "Generate documentation from source files", -> documentSource onerror
task "doc:man", "Generate man pages", -> generateMan onerror
task "doc:pdf", "Generate PDF documentation", ->
documentPages (err)->
onerror err
generatePDF onerror
task "doc", "Generate all documentation", -> generateDocs onerror
## Publishing ##
publishDocs = (callback)->
log "Uploading documentation ...", green
exec "rsync -chr --del --stats html/ labnotes.org:/var/www/zombie/", (err, stdout, stderr)->
log stdout, green
callback err
task "doc:publish", "Publish documentation to site", ->
documentPages (err)->
onerror err
documentSource (err)->
onerror err
generatePDF (err)->
onerror err
publishDocs onerror
task "publish", "Publish new version (Git, NPM, site)", ->
# Run tests, don't publish unless tests pass.
runTests (err)->
onerror err
# Clean up temporary files and such, want to create everything from
# scratch, don't want generated files we no longer use, etc.
clean (err)->
onerror err
exec "git push", (err)->
onerror err
File.readFile "package.json", "utf8", (err, package)->
package = JSON.parse(package)
# Publish documentation, need these first to generate man pages,
# inclusion on NPM package.
generateDocs (err)->
onerror err
log "Publishing to NPM ...", green
exec "npm publish", (err, stdout, stderr)->
log stdout, green
onerror err
# Create a tag for this version and push changes to Github.
log "Tagging v#{package.version} ...", green
exec "git tag v#{package.version}", (err, stdout, stderr)->
log stdout, green
exec "git push --tags origin master", (err, stdout, stderr)->
log stdout, green
# We can do this in parallel.
publishDocs onerror
Jump to Line
Something went wrong with that request. Please try again.