https://github.com/krasimir/syncher

Node.js module for updating dependencies
https://github.com/krasimir/syncher

Last synced: about 2 months ago
JSON representation

Node.js module for updating dependencies

• Host: GitHub
• URL: https://github.com/krasimir/syncher
• Owner: krasimir
• License: mit
• Created: 2015-01-06T11:02:45.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-06T12:25:17.000Z (about 10 years ago)
• Last Synced: 2024-12-22T17:46:29.406Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 145 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Syncher

If you are interested in having the latest version of particular Node.js module as dependency Syncher will help you out.

## Installation

`npm install syncher`

## Usage

The module normally starts a timer and checks if there is a new version of particular module. Check out the configuration section to modify the default behavior.

```js

var syncher = require('../lib');

syncher({

  modules: [

    { name: 'atomus' }

  ]

});

```

Updating the [atomus](https://www.npmjs.com/package/atomus) dependency to the latest version. Have in mind that Syncher updates your `package.json` file too so you don't have to care about that manually.

## Configuration

The module accepts its configuration as an object in the following format:

```js

{

  modules: [

    { name: '[a name of module registered to the registry]' },

    { name: '[a name of module registered to the registry]', once: true },

    { name: '[a name of module]', url: '[url to a private repository]' }

  ],

  root: '[string]', // Optional. By default `process.cwd() + '/node_modules'`

  packagejson: '[string]', // Optional. By default `process.cwd() + '/package.json'`

  suppressErrors: [Boolean], // Optional. By default `true`

  checkingInterval: [Number], // Optional. By default `1000 * 4`

}

```

If the `once` flag is set to `true` Syncher will perform a check only once and it will everyntually install the module. There is no timer started in this case.

## Testing

```

cd ./test

npm install

node ./test.js

```