Warhorse Commands

Warhorse is designed to be used as a command-line tool.

warhorse <command> <optional args>

It offers a fixed, but configurable, set of available commands to the developer:-

build ✅

A development build - just precompile templates and bundle code.

create ✅

Creates a new Warhorse project in a sub-directory below the current directory.

distribute ✅

A full production build - runs tests, runs linters, writes docs, packs assets and bundles code.

document ✅

Writes full documentation: API, test, coverage, lint reports.

lint ✅

Runs the various linters across the project source.

fix 🚫

Fixes 'auto-fixable' linting issues throughout the project source.,

pack ✅

Packs all static assets and moves them into place in the final distribution.

publish 🚫

Publishes the distribution, updating versions and tagging.

run 🚫

Runs a custom user-defined task script.

test ✅

Runs the unit tests and tests unit coverage.

watch 🚫

Actives the project watcher (and optionally, a linked development server).

For example to start an interactive project creation session:-

warhorse create module

Or, at the root of an existing project directory - to execute just the tests:-

warhorse test

And as the whole point of automating the routine project work is to... automate it! The most important command is:-

warhorse watch 🚫 

Now, feel free to focus on your own code! :)