Package Exports

liftoff

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (liftoff) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

liftoff

Launch your command line tool with ease.

What?

Say you're writing a CLI tool. Let's call it hacker. You want to configure it using a Hackfile. This is node, so you install hacker locally for each project you use it in. But, in order to get the hacker command in your PATH, you also install it globally.

Now, when you run the hacker command, you want it to use the Hackfile in your current directory, and the local installation of hacker next to it. It'd be nice if it traversed up your folders until it found a Hackfile, for those times when you're not in the root directory of your project. Heck, you might even want to launch it from a folder outside of your project by manually specifying a working directory. Liftoff manages this for you.

So, everything is working great. Now you can find your local hacker and Hackfile with ease. Unfortunately, it turns out you've authored your Hackfile in coffee-script, or some other JS variant. In order to support that, you have to load the compiler for it, and then register the extension for it with node. Good news, Liftoff can do that too.

Examples

Check out the hacker project to see how you might use this.

Try it now

Want to see how the above example works?

Install the sample project hacker with npm install -g hacker
Make a Hackfile.js with some arbitrary javascript it.
Run hacker while in the same parent folder.

For extra credit, try writing your Hackfile in coffeescript. Then, run hacker --require coffee-script. Make sure you install coffee-script locally, though!