Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQuim Calpe <quim@kalpe.com>2013-11-23 03:31:43 +0400
committerDomenic Denicola <domenic@domenicdenicola.com>2013-11-26 10:03:45 +0400
commitfd3017fc3e9d42acf6394a5285122edb4dc16106 (patch)
tree586d66bc79af12563f31a50c75cafab4d698b7fb /node_modules/ansistyles/README.md
parentec2c50f9bc926c3034ac8c5e166cdaf2c42e53e9 (diff)
Make `npm outdated` output prettier.
Fixes #4176. Uses ansicolors, ansistyles, and text-table.
Diffstat (limited to 'node_modules/ansistyles/README.md')
-rw-r--r--node_modules/ansistyles/README.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/node_modules/ansistyles/README.md b/node_modules/ansistyles/README.md
new file mode 100644
index 000000000..e39b8dfb6
--- /dev/null
+++ b/node_modules/ansistyles/README.md
@@ -0,0 +1,71 @@
+# ansistyles [![build status](https://secure.travis-ci.org/thlorenz/ansistyles.png)](http://next.travis-ci.org/thlorenz/ansistyles)
+
+Functions that surround a string with ansistyle codes so it prints in style.
+
+In case you need colors, like `red`, have a look at [ansicolors](https://github.com/thlorenz/ansicolors).
+
+## Installation
+
+ npm install ansistyles
+
+## Usage
+
+```js
+var styles = require('ansistyles');
+
+console.log(styles.bright('hello world')); // prints hello world in 'bright' white
+console.log(styles.underline('hello world')); // prints hello world underlined
+console.log(styles.inverse('hello world')); // prints hello world black on white
+```
+
+## Combining with ansicolors
+
+Get the ansicolors module:
+
+ npm install ansicolors
+
+```js
+var styles = require('ansistyles')
+ , colors = require('ansicolors');
+
+ console.log(
+ // prints hello world underlined in blue on a green background
+ colors.bgGreen(colors.blue(styles.underline('hello world')))
+ );
+```
+
+## Tests
+
+Look at the [tests](https://github.com/thlorenz/ansistyles/blob/master/test/ansistyles.js) to see more examples and/or run them via:
+
+ npm explore ansistyles && npm test
+
+## More Styles
+
+As you can see from [here](https://github.com/thlorenz/ansistyles/blob/master/ansistyles.js#L4-L15), more styles are available,
+but didn't have any effect on the terminals that I tested on Mac Lion and Ubuntu Linux.
+
+I included them for completeness, but didn't show them in the examples because they seem to have no effect.
+
+### reset
+
+A style reset function is also included, please note however that this is not nestable.
+
+Therefore the below only underlines `hell` only, but not `world`.
+
+```js
+console.log(styles.underline('hell' + styles.reset('o') + ' world'));
+```
+
+It is essentially the same as:
+
+```js
+console.log(styles.underline('hell') + styles.reset('') + 'o world');
+```
+
+
+
+## Alternatives
+
+**ansistyles** tries to meet simple use cases with a very simple API. However, if you need a more powerful ansi formatting tool,
+I'd suggest to look at the [features](https://github.com/TooTallNate/ansi.js#features) of the [ansi module](https://github.com/TooTallNate/ansi.js).