An open API service indexing awesome lists of open source software.

https://github.com/markthethomas/favorites

Easily install your favorite npm modules
https://github.com/markthethomas/favorites

Last synced: 4 months ago
JSON representation

Easily install your favorite npm modules

Awesome Lists containing this project

README

          

[![Coverage Status](https://coveralls.io/repos/markthethomas/favorites/badge.svg?branch=master&service=github)](https://coveralls.io/github/markthethomas/favorites?branch=master) [![Build Status](https://travis-ci.org/markthethomas/favorites.svg?branch=master)](https://travis-ci.org/markthethomas/favorites) [![Code Climate](https://codeclimate.com/github/markthethomas/favorites/badges/gpa.svg)](https://codeclimate.com/github/markthethomas/favorites)

# favorites

Simple cli util to install your commonly-used packages globally or in a project you're just starting on

## Installation

Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.

```sh
npm install favorites -g
```

## Usage

`favorites install [options] `

You can use a local favorites.json file or just use one that you host. You just need two objects with your `dependencies` and `devDependencies` under a `global` and `project` object.

*Schema Example*

```JSON
{
"global": {
"devDependencies": {
"babel": "^6.0.14",
"eslint": "^1.8.0",
"mocha": "^2.3.3",
"pm2": "^0.15.8",
"bluebird": "^3.0.5"
},
"dependencies": {
"commander": "^2.9.0"
}
},
"project": {
"devDependencies": {
"babel": "^6.0.14",
"eslint": "^1.8.0",
"mocha": "^2.3.3",
"lodash": "^3.10.1"
},
"dependencies": {
"commander": "^2.9.0"
}
}
}
```
[Example schema](https://raw.githubusercontent.com/markthethomas/npmFavorites/master/favorites.json)

*CLI Usage*

```sh
Commands:

install install your favorites

Options:

-h, --help output usage information
-V, --version output the version number
-v, --verbose Show parsed favorites to be installed
-p, --project Install your favorites into a local project
-g, --global Install your favorites globally
```

## Tests

```sh
npm install
npm test
```

## Dependencies

- [bluebird](https://github.com/petkaantonov/bluebird): Full featured Promises/A+ implementation with exceptionally good performance
- [chalk](https://github.com/chalk/chalk): Terminal string styling done right. Much color.
- [commander](https://github.com/tj/commander.js): the complete solution for node.js command-line programs
- [is-my-json-valid](https://github.com/mafintosh/is-my-json-valid): A JSONSchema validator that uses code generation to be extremely fast
- [request-promise](https://github.com/request/request-promise): The world-famous HTTP client 'Request' now Promises/A+ compliant. Powered by Bluebird.
- [validator](https://github.com/chriso/validator.js): String validation and sanitization

## Dev Dependencies

- [ava](https://github.com/sindresorhus/ava): Futuristic test runner
- [babel](https://github.com/babel/babel/tree/master/packages): Turn ES6 code into readable vanilla ES5 with source maps
- [babel-core](https://github.com/babel/babel/tree/master/packages): Babel compiler core.
- [babel-eslint](https://github.com/babel/babel-eslint): **babel-eslint** allows you to lint **ALL** valid Babel code with the fantastic [ESLint](https://github.com/eslint/eslint).
- [eslint](https://github.com/eslint/eslint): An AST-based pattern checker for JavaScript.
- [eslint-config-airbnb](https://github.com/airbnb/javascript): Airbnb's ESLint config, following our styleguide
- [lodash](https://github.com/lodash/lodash): The modern build of lodash modular utilities.
- [mocha](https://github.com/mochajs/mocha): simple, flexible, fun test framework

## License

MIT

_Generated by [package-json-to-readme](https://github.com/zeke/package-json-to-readme)_