updater-package

Update a package.json based on globally stored preferences.

{{#block "logo"}}

{{/block}}

{{#block "community" heading="### Community"}} Are you using Update in your project? Have you published an updater and want to share your Update project with the world?

Here are some suggestions!

• If you get like Update and want to tweet about it, please use the hashtag #updatejs (not @)
• Show your love by starring Update and updater-package
• Get implementation help on StackOverflow (please use the updatejs tag in questions)
• Gitter Discuss Update with us on Gitter
• If you publish an updater, thank you! To make your project as discoverable as possible, please add the keyword updateupdater to package.json.

{{/block}}

What does updater-package do?

Most updaters do one specific thing. This updater updates package.json in the current working directory using normalize-pkg.

Getting started

Install

Installing the CLI

To run updater-package from the command line, you'll need to install Update globally first. You can do that now with the following command:

$ npm install --global update

This adds the update command to your system path, allowing it to be run from any directory.

Install updater-package

Install this module with the following command:

$ npm install --global updater-package

Usage

Make sure your work is committed, then run the updater's default task with the following command:

$ update package

What will happen?

Upon running $ update package command, this updater's default task will update the package.json in the current working directory using the default settings and schema in normalize-pkg.

Learn how to automatically run this updater with the update command.

Tasks

Visit the documentation for tasks.

Release history

v1.0.0

Bugfixes

• fixes how contributors are updated to ensure that any existing contributors (on the package.json contributors array) are retained and merged with the contributors from github's API
• fixes package.json license when an invalid value exists (from an old bug that has been fixed in verb)

About

Related projects

• updater-eslint: Update a .eslintrc.json file based on a template and preferences. This updater can be used… more | homepage
• updater-license: Update the copyright statement and year in a MIT LICENSE file. | homepage
• updater-travis: Update .travis.yml based on preferences. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on May 14, 2017.