produce-package-keywords
Produces keywords for your node.js package so that users can better find your package on npm
Last updated 3 years ago by mrzmmr .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install produce-package-keywords 
SYNC missed versions from official npm registry.

produce-package-keywords

CircleCI Codecov npm

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

Table of Contents

Install

npm install produce-package-keywords --save

Usage

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

produce keywords given a file

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

  ...
})

produce keywords given a string

ppk.process(string, callback)

// alias

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

  ...
})

or from package.json's name and description fields

ppk.process(callback)

// alias

ppk(callback)
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

npm install
npm test

standard-readme compliant David David

Contribute

PRs accepted and greatly appreciated.

Dependencies

Dev Dependencies

License

MIT © mrzmmr

Current Tags

  • 1.3.2                                ...           latest (3 years ago)

10 Versions

  • 1.3.2                                ...           3 years ago
  • 1.3.0                                ...           3 years ago
  • 1.2.0                                ...           3 years ago
  • 1.1.7                                ...           3 years ago
  • 1.1.5                                ...           3 years ago
  • 1.1.4                                ...           3 years ago
  • 1.0.3                                ...           3 years ago
  • 1.0.2                                ...           3 years ago
  • 1.0.1                                ...           3 years ago
  • 1.0.0                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 1
Last Month 50
Dependencies (5)
Dev Dependencies (7)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |