Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/base/base-yarn
Plugin for adding yarn methods to your Base application.
https://github.com/base/base-yarn
api base install plugin yarn
Last synced: about 2 months ago
JSON representation
Plugin for adding yarn methods to your Base application.
- Host: GitHub
- URL: https://github.com/base/base-yarn
- Owner: base
- License: mit
- Created: 2017-04-27T05:48:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-04-27T05:52:41.000Z (over 7 years ago)
- Last Synced: 2024-10-13T02:41:00.661Z (3 months ago)
- Topics: api, base, install, plugin, yarn
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 7.81 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# base-yarn [](https://www.npmjs.com/package/base-yarn) [](https://npmjs.org/package/base-yarn) [](https://npmjs.org/package/base-yarn)
> Plugin for adding yarn methods to your Base application.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save base-yarn
```
Install with [yarn](https://yarnpkg.com):
```sh
$ yarn add base-yarn
```
## Usage
```js
var Base = require('base');
var base = new Base({isApp: true});
var yarn = require('..');
base.use(yarn());
```
## Examples
See the [examples directory](./examples) for code examples that can be run.
```js
base.yarn.add(['isobject', 'micromatch'], function(err) {
if (err) throw err;
console.log('done');
});
// custom arguments
base.yarn(['why', 'find-pkg'], function(err) {
if (err) throw err;
console.log('done');
});
```
## API
This plugin exposes the full API from the [yarn-api](https://github.com/jonschlinkert/yarn-api) library. See that project for all available methods and documentation.
## About
### Related projects
* [base-plugins](https://www.npmjs.com/package/base-plugins): Adds 'smart plugin' support to your base application. | [homepage](https://github.com/node-base/base-plugins "Adds 'smart plugin' support to your base application.")
* [base](https://www.npmjs.com/package/base): Framework for rapidly creating high quality node.js applications, using plugins like building blocks | [homepage](https://github.com/node-base/base "Framework for rapidly creating high quality node.js applications, using plugins like building blocks")
* [yarn-api](https://www.npmjs.com/package/yarn-api): Basic API for yarn. | [homepage](https://github.com/jonschlinkert/yarn-api "Basic API for yarn.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on April 27, 2017._