https://github.com/flet/can-haz-package
:hamburger: Check if an npm package name is valid and does not currently exist.
https://github.com/flet/can-haz-package
Last synced: over 1 year ago
JSON representation
:hamburger: Check if an npm package name is valid and does not currently exist.
- Host: GitHub
- URL: https://github.com/flet/can-haz-package
- Owner: Flet
- License: isc
- Created: 2015-08-03T23:02:48.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-08-05T19:47:16.000Z (almost 11 years ago)
- Last Synced: 2024-10-09T09:50:53.627Z (over 1 year ago)
- Language: JavaScript
- Size: 118 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# can-haz-package
[![npm][npm-image]][npm-url]
[![travis][travis-image]][travis-url]
[npm-image]: https://img.shields.io/npm/v/can-haz-package.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/can-haz-package
[travis-image]: https://img.shields.io/travis/Flet/can-haz-package.svg?style=flat-square
[travis-url]: https://travis-ci.org/Flet/can-haz-package
Check if an npm package name is valid and does not currently exist.
uses [validate-npm-package-name](https://www.npmjs.com/package/validate-npm-package-name) to check naming rules and uses `npm view` (via [shelljs](https://www.npmjs.com/package/shelljs)) to check if the package exists.
The return values are set up to conform to [inquirer](https://www.npmjs.com/package/inquirer)'s validate function expectations.
Because of the reliance on `shelljs` and `npm`, this package will not work in the browser, sorry!
## Install
```
npm install can-haz-package
```
## Usage
```js
var canHazPackage = require('can-haz-package')
canHazPackage('this-should-never-be-taken-omg-whaaaat-999')
// reurns true
canHazPackage('standard')
// returns 'Sorry, that package name is taken! :('
canHazPackage(' ¯\_(ツ)_/¯ ')
// returns 'Package name does not conform to naming rules.'
```
## Contributing
Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.
## License
[ISC](LICENSE.md)