node package manager
Stop writing boring code. Discover, share, and reuse within your team. Create a free org ยป

unicorn-tool

Unicorn

travis Dependency Status devDependency Status

Simple build platform for wria2 and sheath projects.

Features:
  • Wrap the code with YUI().use(), YUI.add() or nothing depending on the module configuration.
  • Rollup creation.
  • Linting with JS linter (JSHint or ESLint) and CSSLint.
  • Minification for JS, CSS and i18n files.
  • Watch functionality to build on demand.
Usage
Usage: unicorn [options]

Options:

  -h, --help               output usage information
  -V, --version            output the version number
  --watch                  Starts the watcher
  -g, --gallop             Starts a full build
  -w, --whisper            Sets logger to error only
  -r, --roar               Adds verbose
  -s, --sprint             Disable jshint and csslint
  --jumpjs, --no-lint      Disable jshint
  --jumpcss, --no-csslint  Disable csslint
  -d, --dry                Dry run
  -c, --combo              The application will use combo loader to fetch the depenencies
  --cwd <path>             Sets the base path for the build
  -u, --unique             Builds the rollup at the end
Examples
  • Build a module

    unicorn
    
  • Build a module skipping linting and setting the logger to error

    unicorn -s -w
    
  • Building the whole project

    unicorn -g --cwd <path to the root of the project>
    
  • Run watch command

    unicorn --watch --cwd <path to the root of the project>
    
JShint or ESLint

JSHint is the linter used by default.

The linters are not manually selected. The tool searches for the configuration files on the working directory:

  • ESLint uses .eslintrc.
  • JSHint uses .jshintrc.

ESlint has higher priority. This means that if the file .eslintrc is found ESLint is used, otherwise JSHint is used.

Development

Contributing to the projects is simple. Follow these steps:

  • Clone the repository
  • Run npm install . on the root level.
  • Run grunt on the root level.
  • Run npm link . to get global access to unicorn.
  • Run grunt test to run the unit tests.

Once the changes are complete, create a pull request.