Skip to content
Build automation engine by launchdeck.io
JavaScript Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
.codeclimate.yml
.eslintrc.js
.gitignore
.istanbul.yml
.travis.yml
LICENSE
README.md
constants.json
index.js
link-shipment.sh
package.json
yarn.lock

README.md

katapult

Build automation tool by launchdeck.io

Build Status NPM Version

Install

$ npm install -g katapult

Usage

$ katapult --help

katapult <command> [args]

Commands:
  katapult.js runInstall  Run the install commands
  katapult.js runBuild    Run the build commands
  katapult.js purge       Delete all files matching "purge" globs
  katapult.js clearCache  Empty cached results from install/build
  katapult.js package     "runInstall", "runBuild" and "purge" serially

Options:
  --version           Show version number                              [boolean]
  -b, --buildPath     Build "root" directory                            [string]
  -w, --workspace     Metadata storage path                             [string]
  -m, --maxCacheSize  Max allowed cache size                            [string]
  -d, --disableCache  Disable caching                                  [boolean]
  -v, --verbose       Extra chatty mode                                  [count]
  -h, --help          Show help                                        [boolean]

.katapult.yml

You can automate installation, testing and build routines through the use of .katapult.yml files. When packaging a build, katapult will recursively search the root directory for .katapult.yml files and run the directives they contain.

install

Allows the specification of one or more commands that are run before any of the build commands are run. install commands are run by traversing the build tree, starting at the root directory. If any of the commands exits with a code other than 0, the deployment is cancelled.

After execution of the install commands in any directory, the build tree is rescanned - install commands may thus produce subfolders in turn containing .katapult.yml files which will be processed in a same way.

build

build commands are run by traversing the build tree, ending at the root directory. If any of the commands exits with a code other than 0, the deployment is cancelled.

command caching

Commands can be specified using two different types of syntax: plain and simple

  - npm install

or using a more verbose (associative) syntax. The latter allows you to define additional options on a per-command basis, for example: command caching. Command caching can significantly increase build speeds.

  - cmd: npm install
    input: package.json
    output: node_modules

Katapult will use johnnycache and store the resulting files of the operation (in this case, the entire contents of node_modules after running npm install) to a .tar.gz archive in .katapult/cache.

purge

Allows the specification of one or more globs that will be used to delete unnecessary files; a blacklist, if you will. This allows you to, for example, remove the node_modules bloat after bundling a script with browserify. It is also possible to define a "negating glob array" -- meaning all globs start with !. Katapult will treat such an array as a whitelist and remove all other files in the directory.

Example .katapult.yml

install:
  - cmd: composer install
    input: composer.lock
    output: vendor

purge:
  - "!config"
  - "!vendor"
  - "!web"

.katapultignore

Directories that match any of the globs specified in a .katapultignore file will not be traversed in the process of scanning for .katapult.yml files. You can also configure globs globally by creating ~/.katapultignore_global:

**/node_modules
**/vendor

License

GNU AGPL v3 © sgtlambda

dependency Status devDependency Status

You can’t perform that action at this time.