UNPKG

canonical

Version:

Canonical code style linter and formatter for JavaScript, SCSS and CSS.

72 lines (71 loc) 3.52 kB
{ "_args": [ [ "readline2@https://registry.npmjs.org/readline2/-/readline2-1.0.1.tgz", "/Users/gajus/Documents/dev/canonical-code-style/canonical" ] ], "_from": "readline2@>=1.0.1 <2.0.0", "_id": "readline2@1.0.1", "_inCache": true, "_location": "/readline2", "_phantomChildren": {}, "_requested": { "name": "readline2", "raw": "readline2@https://registry.npmjs.org/readline2/-/readline2-1.0.1.tgz", "rawSpec": "https://registry.npmjs.org/readline2/-/readline2-1.0.1.tgz", "scope": null, "spec": "https://registry.npmjs.org/readline2/-/readline2-1.0.1.tgz", "type": "remote" }, "_requiredBy": [ "/inquirer" ], "_resolved": "https://registry.npmjs.org/readline2/-/readline2-1.0.1.tgz", "_shasum": "41059608ffc154757b715d9989d199ffbf372e35", "_shrinkwrap": null, "_spec": "readline2@https://registry.npmjs.org/readline2/-/readline2-1.0.1.tgz", "_where": "/Users/gajus/Documents/dev/canonical-code-style/canonical", "author": { "email": "admin@simonboudrias.com", "name": "Simon Boudrias" }, "bugs": { "url": "https://github.com/sboudrias/readline2/issues" }, "dependencies": { "code-point-at": "^1.0.0", "is-fullwidth-code-point": "^1.0.0", "mute-stream": "0.0.5" }, "description": "Readline Façade fixing bugs and issues found in releases 0.8 and 0.10", "devDependencies": { "chalk": "^1.1.0", "mocha": "^2.1.0", "sinon": "^1.7.3" }, "files": [ "index.js" ], "homepage": "https://github.com/sboudrias/readline2#readme", "keywords": [ "ansi", "cli", "readline", "terminal", "tty" ], "license": "MIT", "name": "readline2", "optionalDependencies": {}, "readme": "readline2 [![Build Status](https://travis-ci.org/SBoudrias/readline2.png?branch=master)](https://travis-ci.org/SBoudrias/readline2)\n=========\n\nNode.js (v0.8 and v0.10) had some bugs and issues with the default [Readline](http://nodejs.org/api/readline.html) module.\n\nThis module include fixes seen in later version (0.11-0.12 and iojs) and ease some undesirable behavior one could see using the readline to create interatives prompts. This means `readline2` change some behaviors and as so is **not** meant to be an exact drop-in replacement.\n\nThis project is extracted from the core of [Inquirer.js interactive prompt interface](https://github.com/SBoudrias/Inquirer.js) to be available as a standalone module.\n\n\nDocumentation\n-------------\n\n**Installation**: `npm install --save readline2`\n\n### readline2.createInterface(options); -> {Interface}\n\nPresent the same API as [Node.js `readline.createInterface()`](http://nodejs.org/api/readline.html)\n\n#### Improvements\n- Default `options.input` as `process.stdin`\n- Default `options.output` as `process.stdout`\n- `interface.stdout` is wrapped in a [MuteStream](https://github.com/isaacs/mute-stream)\n- Prevent `up` and `down` keys from moving through history inside the readline\n- Fix cursor position after a line refresh when the `Interface` prompt contains ANSI colors\n- Correctly return the cursor position when faced with implicit line returns\n\n\nLicense\n-------------\n\nCopyright (c) 2012 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart))\nLicensed under the MIT license.\n", "readmeFilename": "README.md", "repository": { "type": "git", "url": "git+https://github.com/sboudrias/readline2.git" }, "scripts": { "test": "mocha -R spec" }, "version": "1.0.1" }