# produce-package-keywords

> Produces keywords for your node.js package so that users can better find your package on npm

Latest version **1.3.2** (published 2017-02-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install produce-package-keywords
pnpm add produce-package-keywords
yarn add produce-package-keywords
bun add produce-package-keywords
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2017-02-03 |
| First published | 2017-01-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | mrzmmr |
| Maintainers | mrzmmr |
| Keywords | produce-package-keywords, produce-keywords, package-keywords, produce, package, keywords |

## Links

- npm: https://www.npmjs.com/package/produce-package-keywords
- Repository: https://github.com/mrzmmr/produce-package-keywords
- Homepage: https://github.com/mrzmmr/produce-package-keywords#readme
- Issues: https://github.com/mrzmmr/produce-package-keywords/issues
- npm.io page: https://npm.io/package/produce-package-keywords

## Dependencies (5)

- [retext](https://npm.io/package/retext.md) ^4.0.0
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^2.0.0
- [call-me-maybe](https://npm.io/package/call-me-maybe.md) ^1.0.1
- [nlcst-to-string](https://npm.io/package/nlcst-to-string.md) ^2.0.0
- [retext-keywords](https://npm.io/package/retext-keywords.md) ^3.1.0

## Recent versions

- 1.3.2 (latest) — 2017-02-03
- 1.3.0 — 2017-02-03
- 1.2.0 — 2017-01-31
- 1.1.7 — 2017-01-24
- 1.1.5 — 2017-01-24
- 1.1.4 — 2017-01-24
- 1.0.3 — 2017-01-24
- 1.0.2 — 2017-01-24
- 1.0.1 — 2017-01-24
- 1.0.0 — 2017-01-24

## README

# produce-package-keywords

[![CircleCI](https://img.shields.io/circleci/project/github/mrzmmr/produce-package-keywords.svg)](https://circleci.com/gh/mrzmmr/produce-package-keywords)
[![Codecov](https://img.shields.io/codecov/c/github/mrzmmr/produce-package-keywords.svg)](https://codecov.io/gh/mrzmmr/produce-package-keywords)
[![npm](https://img.shields.io/npm/v/produce-package-keywords.svg)](https://www.npmjs.com/package/produce-package-keywords)

> Produces keywords for a package by analyzing its package.json, a string, or
> file.

## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [Api](#api)
- [Contribute](#contribute)
- [License](#license)

## Install

```sh
npm install produce-package-keywords --save
```

## Usage

```js
const ppk = require('produce-package-keywords')

```

produce keywords given a file

```js
ppk.fromFile('path/to/file.txt', (error, result) => {
  if (error) {
    ...
  }

  ...
})
```

produce keywords given a string

```js
ppk.process(string, callback)

// alias

ppk(string, callback)
```

```js
ppk(string, (error, result) => {
  if (error) {
    ...
  }

  ...
})
```

or from package.json's name and description fields

```js
ppk.process(callback)

// alias

ppk(callback)
```

```js
ppk((error, result) => {
  if (error) {
    ...
  }

  ...
})
```

## Api

### producePackageKeywords([string], callback)

Returns an error first callback with an array of extracted keywords from string
if given, otherwise from package.json's name and description fields.

#### options

**[string]** - optional string argument

**callback** - error first callback
  
### producePackageKeywords.fromFile(file, callback)

Returns an error first callback with an array of extracted keywords from the
given file

#### options

**file** - file to extract from

**callback** - error first callback

## Tests

```sh
npm install
npm test
```

[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![David](https://img.shields.io/david/mrzmmr/produce-package-keywords.svg)](https://david-dm.org/)
[![David](https://img.shields.io/david/dev/mrzmmr/produce-package-keywords.svg)](https://david-dm.org/)

## Contribute

PRs accepted and greatly appreciated.

## Dependencies

- [nlcst-to-string](https://github.com/wooorm/nlcst-to-string): Stringify NLCST
- [read-pkg-up](https://github.com/sindresorhus/read-pkg-up): Read the closest package.json file
- [retext](https://github.com/wooorm/retext/tree/master/packages): Natural language processor powered by plugins
- [retext-keywords](https://github.com/wooorm/retext-keywords): Keyword extraction with Retext

## Dev Dependencies

- [codecov](https://github.com/codecov/codecov-node): Uploading report to Codecov: https://codecov.io
- [nyc](https://github.com/istanbuljs/nyc): the Istanbul command line interface
- [rimraf](https://github.com/isaacs/rimraf): A deep deletion module for node (like `rm -rf`)
- [tap-spec](https://github.com/scottcorgan/tap-spec): Formatted TAP output like Mocha's spec reporter
- [tape](https://github.com/substack/tape): tap-producing test harness for node and browsers

## License

MIT © mrzmmr

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