# publishable

> Checks if a package is publishable to NPM registry

Latest version **1.0.1** (published 2018-08-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install publishable
pnpm add publishable
yarn add publishable
bun add publishable
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-08-31 |
| First published | 2018-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | MooYeol Prescott Lee |
| Maintainers | mooyoul |
| Keywords | npm, publish, ci, cd |

## Links

- npm: https://www.npmjs.com/package/publishable
- Repository: https://github.com/mooyoul/node-publishable
- Homepage: https://github.com/mooyoul/node-publishable#readme
- Issues: https://github.com/mooyoul/node-publishable/issues
- npm.io page: https://npm.io/package/publishable

## Dependencies (3)

- [rc](https://npm.io/package/rc.md) ^1.2.8
- [debug](https://npm.io/package/debug.md) ^3.1.0
- [pacote](https://npm.io/package/pacote.md) ^9.1.0

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2018-08-31
- 0.2.1 — 2018-08-31
- 0.1.0 — 2018-08-31

## README

# node-publishable

[![Build Status](https://travis-ci.org/mooyoul/node-publishable.svg?branch=master)](https://travis-ci.org/mooyoul/node-publishable)
[![Coverage Status](https://coveralls.io/repos/github/mooyoul/node-publishable/badge.svg?branch=master)](https://coveralls.io/github/mooyoul/node-publishable?branch=master)
[![codecov.io](https://codecov.io/github/mooyoul/node-publishable/coverage.svg?branch=master)](https://codecov.io/github/mooyoul/node-publishable?branch=master)
[![Dependency Status](https://david-dm.org/mooyoul/node-publishable.svg)](https://david-dm.org/mooyoul/node-publishable)
[![devDependency Status](https://david-dm.org/mooyoul/node-publishable/dev-status.svg)](https://david-dm.org/mooyoul/node-publishable#info=devDependencies)
[![Known Vulnerabilities](https://snyk.io/test/github/mooyoul/node-publishable/badge.svg)](https://snyk.io/test/github/mooyoul/node-publishable)
[![MIT license](http://img.shields.io/badge/license-MIT-blue.svg)](http://mooyoul.mit-license.org/)

Checks if a package is publishable to NPM registry (with private package support!)


## Sponsor

- [Vingle](https://www.vingle.net) - Vingle, Very Community. Love the things that you love. - [We're hiring!](https://careers.vingle.net/#/engineering/backend)


## Install

```bash
$ npm install publishable
```
 
 
## Usage

```typescript
import publishable = require("publishable");

await publishable("package-name", "version"); // returns `boolean`
```

# Related

- [mooyoul/node-publishable-cli](https://github.com/mooyoul/node-publishable-cli) - CLI for this module, made for CI/CD workflow 


## Changelog


#### 1.0.1

- Add missing changelog

#### 1.0.0

- Stable release

#### 0.2.1

- Add E404 error code handling

#### 0.2.0

- Add `.npmrc` support
- Add scoped package support
- Add private package support

#### 0.1.0

- Initial commit

## Debugging

Set `DEBUG` environment variable to `publishable`.
You will be able to see debug messages on your console.

> $ env DEBUG='publishable' node your-app.js
 

## Testing

```bash
$ npm run test
```

... OR

```bash
$ npm run lint # Check lint
$ npm run coverage # Run test & generate code coverage report
```



## Build

```bash
$ npm run build
```


## License
[MIT](LICENSE)

See full license on [mooyoul.mit-license.org](http://mooyoul.mit-license.org/)

---
_Source: https://npm.io/package/publishable · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._