Be scalable! Update is a new, open source developer framework and CLI for automating updates of any kind in code projects.
You might also be interested in:
Install Update's CLI and an example updater globally:
$ npm install --global update && updater-example
$ update init
All updating is accomplished using plugins called updaters, which are run by command line or API, and can be installed globally, locally, or created in a local
eslintor the other way around, or any other detail)
update init, then projects under your maintenance will convert to the the conventions you prefer within milliseconds after running
Here are some random example commits after running
Project/Commit | Updaters used
.destto read and write globs of files.
To use Update's CLI,
update must first be installed globally with npm:
$ npm install --global update
This adds the
update command to your system path, allowing it to be run from anywhere.
Updaters can be found on npm, but if you're not familiar with how Update works, we recommend installing
$ npm install --global updater-example
In the current working directory, create an empty file named
As a habit, when using
update make sure your work is committed, then run:
$ update example
This appends the string
foo to the contents of
example.txt. Visit the updater-example project for additional steps and guidance.
Select the updaters to run every time
update is run. Use
--add to add additional updaters, and
--remove to remove them. You can run this command whenever you want to update your preferences, like after installing new updaters.
$ update init
Display a list of currently installed updaters.
$ update defaults:list# aliased as$ update list
Display a help menu of available commands and flags.
$ update defaults:help# aliased as$ update help
Show the list of updaters that are registered to run on the current project.
$ update defaults:show# aliased as$ update show
Default task for the built-in
$ update help
$ update helpUsage: update <command> [options]Command: updater or tasks to runOptions:--config, -c Save a configuration value to the `update` object in package.json--cwd Set or display the current working directory--help, -h Display this help menu--init, -i Prompts you to choose the updaters to automatically run (your "queue")--add Add updaters to your queue--remove Remove updaters from your queue--run Force tasks to run regardless of command line flags used--silent, -S Silence all tasks and updaters in the terminal--show <key> Display the value of <key>--version, -V Display the current version of update--verbose, -v Display all verbose logging messagesExamples:# run updater "foo"$ update foo# run task "bar" from updater "foo"$ update foo:bar# run multiple tasks from updater "foo"$ update foo:bar,baz,qux# run a sub-generator from updater "foo"$ update foo.abc# run task "xyz" from sub-generator "foo.abc"$ update foo.abc:xyzUpdate attempts to automatically determine if "foo" is a task or updater.If there is a conflict, you can force update to run updater "foo"by specifying its default task. Example: `$ update foo:default`
Plugins from any applications built on base should work with Update (and can be used in your updater):
Visit the updater documentation guide to learn how to use, author and publish updaters.
Customize settings and default behavior using the
update property in package.json. These values will override global defaults.
"update":"updaters": "package" "license" "keywords"
The following options may be defined in package.json.
The updaters to run on the current project.
updater-package on the current project:
"update":"updaters": "package" "license"
Changelog entries are classified using the following labels from keep-a-changelog:
added: for new features
changed: for changes in existing functionality
deprecated: for once-stable features removed in upcoming releases
removed: for deprecated features removed in this release
fixed: for any bug fixes
Custom labels used in this changelog:
dependencies: bumps dependencies
housekeeping: code re-organization, minor edits, or other changes that don't fit in one of the other categories.
Please let us know if any of the following heading links are broken. Thanks!
app.cwdin the current instance is the cwd defined by the user on the options or argv.
app.home(), which resolves to
~/or the user-defined
options.homedir. This directory is used to determine the base directory for user-defined templates.
homeupdater. If an
updatefile.jsexists in the
~/updatedirectory (this will be customizable, but it's not yet), this file will be loaded and
.use()d as a plugin before other updaters are loaded. You can use this to set options, add defaults, etc. But you can also run it explictly via commandline with the
app.cwdso that it's updated when
--dest) is set
First stable release!
(Changelog generated by helper-changelog)
Here are some suggestions!
@generatejsor use the
generatejstag in questions)
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for avice on opening issues, pull requests, and coding standards.
Install dev dependencies:
$ npm install -d && npm test
This file was generated by verb-generate-readme, v0.1.30, on September 01, 2016.