npm-add-engines

Add engines field to your package.json file in current working directory or user-defined directory

You might also be interested in github-clone-labels.

Table of Contents

• Install
• Usage
• CLI
• API
  • npmAddEngines
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install npm-add-engines --global

or install using yarn

$ yarn global add npm-add-engines

Usage

For more use-cases see the tests

const npmAddEngines = require('npm-add-engines')

CLI

Just run npm-add-engines in the terminal

$ npm-add-engines
Successfully updated!
Path: /home/charlike/code/path/to/your/module/package.json

API

npmAddEngines

Update package.json file of dir or current working directory, using load-pkg behind.

Params

• [dir] {String|Function}: optional, can be cb
• <cb> {Function}: required, callback function

Example

const add = require('npm-add-engines')
 
add((err, pkg) => {
  console.log(err) // => if error
  console.log(pkg.engines) // => { node: '>=4', npm: '>=2' }
})
 
add('~/foo/bar/dir', (err, pkg) => {
  console.log(err) // => if error
  console.log(pkg.name) // => my-foo-pkg
  console.log(pkg.engines) // => { node: '>=4', npm: '>=2' }
})

Related

• create-readdir-stream: Streaming fs.readdir, extensible with smart plugins. No recursion and no globs by default - use plugins. Does not stat and… more | homepage
• function-arguments: Get arguments of a function, useful for and used in dependency injectors. Works for regular functions, generator functions and arrow… more | homepage
• gruu: Modern, small and powerful testing with TAP output and support for async/await, promises, callbacks, streams and observables, built on always-done. | homepage
• is-async-function: Is function really asynchronous function? Trying to guess that based on check if common-callback-names exists as function arguments names or… more | homepage
• minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
• npm-pkgs: List user npm packages from the npmjs.com! | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use npm run release, which is standard-version and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb command like that

$ npm install verbose/verb#dev verb-generate-readme --global && verb

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

Charlike Mike Reagent

• github/tunnckoCore
• twitter/tunnckoCore
• codementor/tunnckoCore

License

Copyright © 2016, Charlike Mike Reagent. Released under the MIT license.

---

This file was generated by verb-generate-readme, v0.2.0, on December 11, 2016.
Project scaffolded using charlike cli.