Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Tools to make componentized javascript easier

branch: master
readme.md

kbuild

Helper to make using Google Closure Tools easier.
By Kevin Moore

tl;dr

The Closure Tools let you build dependency files, compile your javascript, lint* and fix*.

...but you end up passing a lot of command line parameters to each.

kbuild lets you define a single yaml file (config.kb) in the root of your project to make using these tools a lot easier.

* If you install closure_linter. See below.

kbuild --help

usage: kbuild [-h] [--buildfile BUILDFILE] [--debug]
              [--language_in {ECMASCRIPT3,ECMASCRIPT5,ECMASCRIPT5_STRICT}]
              [--show_command]
              [{deps,compile,build,fix,lint,fb}]

Prepare a closure-based javascript set.

positional arguments:
  {deps,compile,build,fix,lint,fb}
                        Specify to either create a [deps] file, generate
                        [compile]d output, run [fix]jsstyle, run gjs[lint],
                        [build] deps then compile, or [fb] to fix then build.
                        (default: deps)

optional arguments:
  -h, --help            show this help message and exit
  --buildfile BUILDFILE
                        The yaml config file to use. (default: config.kb)
  --debug, -d           Enable debug output when in compile mode. (default:
                        False)
  --language_in {ECMASCRIPT3,ECMASCRIPT5,ECMASCRIPT5_STRICT}
                        Sets what language spec that input sources conform.
                        (default: ECMASCRIPT5_STRICT)
  --show_command, -sc   Show the command line that is run for the given
                        options. (default: False)

Requirements

  • java - Tested with 1.6
  • python - 2.7 is required
    • yaml - pip install PyYAML - for parsing the config file
    • termcolor - pip install termcolor - to enable pretty output of info and errors
    • closure_linter (optional) - pip install http://closure-linter.googlecode.com/files/closure_linter-2.3.5.tar.gz
      • enables kbuild fix and kbuild lint

Show me an example

kbuild is used in these OSS projects by Pixel Lab.

ThinkQR is the easiest to start with.
If you're cloning these locally, make sure you sync up all of the submodules before you try kbuild.

config.kb file from ThinkQR

# kbuild file - https://github.com/kevmoo/kbuild
closure_path: js/closure
inputs:
  - js/app/application.js
js_paths:
  - js/app
  - js/pl/src
deps_path: js/deps.js
compile_path: js/compiled.js
externs:
  - js/externs/jquery-1.6.js
fix_paths:
  - js/app
  - js/pl/src/
  - js/loader.js
Something went wrong with that request. Please try again.