diff options
Diffstat (limited to 'node_modules/has-yarn/readme.md')
-rw-r--r-- | node_modules/has-yarn/readme.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/node_modules/has-yarn/readme.md b/node_modules/has-yarn/readme.md new file mode 100644 index 0000000..0315c20 --- /dev/null +++ b/node_modules/has-yarn/readme.md @@ -0,0 +1,60 @@ +# has-yarn [![Build Status](https://travis-ci.org/sindresorhus/has-yarn.svg?branch=master)](https://travis-ci.org/sindresorhus/has-yarn) + +> Check if a project is using [Yarn](https://yarnpkg.com) + +Useful for tools that needs to know whether to use `yarn` or `npm` to install dependencies. + +It checks if a `yarn.lock` file is present in the working directory. + + +## Install + +``` +$ npm install has-yarn +``` + + +## Usage + +``` +. +├── foo +│ └── package.json +└── bar + ├── package.json + └── yarn.lock +``` + +```js +const hasYarn = require('has-yarn'); + +hasYarn('foo'); +//=> false + +hasYarn('bar'); +//=> true +``` + + +## API + +### hasYarn([cwd]) + +Returns a `boolean` of whether the project uses Yarn. + +#### cwd + +Type: `string`<br> +Default: `process.cwd()` + +Current working directory. + + +## Related + +- [has-yarn-cli](https://github.com/sindresorhus/has-yarn-cli) - CLI for this module + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |