Package Exports
- ascli
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 (ascli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
A uniform foundation for unobtrusive (ASCII art in) cli apps.
Why? Some of us are not only programmers but also part-time artist. So am I. This is good. However, to limit myself a bit to a straight look of my CLI apps, I've created ascli based on the thought of not making things too fancy but still looking good. So, basically, this package is meant to be used by me but if you like my interpretation of unobtrusiveness and ease-of-use ... You are welcome!
Installation
npm install ascli
Usage
var ascli = require("ascli").app("myApp");
ascli.banner(ascli.name.green.bold, "v1.0.0 by Foo Bar <foobar@example.com>");
console.log("Hello!");
// If it worked:
ascli.ok("It worked!");
// If it didn't:
ascli.fail("Nope, sorry.", /* exit code */ 1);Using another alphabet
By default ascli uses a modified version of the straight ASCII alphabet. If you don't like it, you are free to replace it:
ascli.use("/path/to/my/alphabet.json");
// or
var myAlphabet = { ... };
ascli.use(myAlphabet);See the alphabet/ directory for an example.
Using colors
ascli automatically looks up and translates ANSI terminal colors applied to the title string. For that it depends on
colour.js which is also exposed as a property of the ascli namespace:
ascli.colour / ascli.colors. Also means: You don't need another ANSI terminal colors dependency.
Indentation
ascli automatically indents all console output by one space just because it looks better with the banner.
Parsing command line arguments
opt.js is included as ascli.opt().
License
Apache License, Version 2.0