A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://github.com/update/update below:

update/update: Update is a new developer framework and CLI for automating updates of any kind in code projects. If you know how to use assemble, generate or verb, you'll know how to use update.

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

Initialize update:

Run update:

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 updatefile.js.

You can create your own updaters using Update's API, or install updaters using npm, to do things like:

Here are some random example commits after running $ update.

Install update

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 updater-example:

$ npm install --global updater-example

Create "example.txt"

In the current working directory, create an empty file named example.txt.

Run

As a habit, when using update make sure your work is committed, then run:

This appends the string foo to the contents of example.txt. Visit the updater-example project for additional steps and guidance.

Update ships with the following built-in tasks. These will be externalized to an updater or generate generator at some point.

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.

Example

Display a list of currently installed updaters.

Example

$ update defaults:list
# aliased as
$ update list

Display a help menu of available commands and flags.

Example

$ update defaults:help
# aliased as
$ update help

Show the list of updaters that are registered to run on the current project.

Example

$ update defaults:show
# aliased as
$ update show

Default task for the built-in defaults generator.

Example

$ update help

  Usage: update <command> [options]

  Command: updater or tasks to run

  Options:

    --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 messages

  Examples:

    # 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:xyz

    Update 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.

Example

Run updater-license and updater-package on the current project:

{
  "update": {
    "updaters": ["package", "license"]
  }
}

Changelog entries are classified using the following labels from keep-a-changelog:

Custom labels used in this changelog:

Heads up!

Please let us know if any of the following heading links are broken. Thanks!

fixed

added

fixed

First stable release!

(Changelog generated by helper-changelog)

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!

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

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

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

Jon Schlinkert

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

This file was generated by verb-generate-readme, v0.6.0, on January 23, 2018.


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4