https://github.com/mysticatea/uptodate

A CLI tool to update dependencies in your package.json.
https://github.com/mysticatea/uptodate

Last synced: about 2 months ago
JSON representation

A CLI tool to update dependencies in your package.json.

• Host: GitHub
• URL: https://github.com/mysticatea/uptodate
• Owner: mysticatea
• License: mit
• Created: 2015-04-22T08:16:54.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-05-08T06:18:14.000Z (over 9 years ago)
• Last Synced: 2024-10-16T00:31:34.141Z (3 months ago)
• Language: JavaScript
• Size: 263 KB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# uptodate

[![Build Status](https://travis-ci.org/mysticatea/uptodate.svg?branch=master)](https://travis-ci.org/mysticatea/uptodate)

[![Coverage Status](https://coveralls.io/repos/mysticatea/uptodate/badge.svg?branch=master)](https://coveralls.io/r/mysticatea/uptodate?branch=master)

[![npm version](https://badge.fury.io/js/uptodate.svg)](http://badge.fury.io/js/uptodate)

A CLI tool to update dependencies in your package.json.

## Installation

```

npm install -g uptodate

```

## Usage

```

Usage: uptodate [OPTIONS]

  It opens a package.json and checks its dependencies/devDependencies.

  If there are out-dated packages, it updates them and rewrites the package.json

  Lastly, it takes changelogs from GitHub if is possible, and shows summary of

  them in a browser.

Options:

  -h, --help            Print this text.

  -v, --version         Print the version number.

  --ignore       Ignore package names (comma separated).

  --no-save             Don't rewrite package.json.

  --no-show-changelog   Don't show changelogs in a browser.

```

## Example

```

uptodate

```

```

uptodate --ignore foo,bar,yay --no-show-changelog

```

## Node API

```

var uptodate = require("uptodate");

```

### uptodate(options, callback)

It opens a package.json and checks its dependencies/devDependencies.

If there are out-dated packages, it updates them and rewrites the package.json.

- **options** `object` -- Optional.

  - **options.cwd** `string` -- A directory path. This opens package.json of here.

    By default, `process.cwd()`.

  - **options.ignore** `string[]` -- Package names. This ignores the packages

    even if is out-dated.

  - **options.noSave** `boolean` -- A flag that to not rewrite package.json.

- **callback** `(err: Error|null, result: object[]|null) => void` -- Optional.

  A callback that will be called at done.

  `err` is not `null` if failed.

  `result` is an array. Its each value is an instance of

  `{name: string, current: string, latest: string}`.

  - `name` is the package name.

  - `current` is a version text before updating.

  - `latest` is a version text after updating probably.