# vworp

> 'npm version' for timelords.

Latest version **1.0.4** (published 2015-04-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install vworp
pnpm add vworp
yarn add vworp
bun add vworp
```

Provides the command `vworp`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2015-04-17 |
| First published | 2015-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Alan Plum |
| Maintainers | pluma |

## Links

- npm: https://www.npmjs.com/package/vworp
- Repository: https://github.com/foss-haas/vworp
- Issues: https://github.com/foss-haas/vworp/issues
- npm.io page: https://npm.io/package/vworp

## Dependencies (5)

- [gift](https://npm.io/package/gift.md) ^0.6.0
- [yargs](https://npm.io/package/yargs.md) ^3.3.1
- [semver](https://npm.io/package/semver.md) ^4.3.2
- [es6-promise](https://npm.io/package/es6-promise.md) ^2.0.1
- [detect-json-indent](https://npm.io/package/detect-json-indent.md) 0.0.0

## Recent versions

- 1.0.4 (latest) — 2015-04-17
- 1.0.3 — 2015-04-17
- 1.0.2 — 2015-02-24
- 1.0.1 — 2015-02-24
- 1.0.0 — 2015-02-24

## README

# Synopsis

**vworp** is a tool for bumping the version number of projects and automagically creating git commits and tags for each version.

Basically, it's a substitute for `npm version` that supports updating multiple files and can be used in projects that don't have a `package.json`.

[![license - MIT](https://img.shields.io/npm/l/vworp.svg)](http://foss-haas.mit-license.org) [![Dependencies](https://img.shields.io/david/foss-haas/vworp.svg)](https://david-dm.org/foss-haas/vworp)

[![NPM status](https://nodei.co/npm/vworp.png?compact=true)](https://www.npmjs.com/package/vworp)

[![Codacy rating](https://img.shields.io/codacy/f3bd7f31c1f9436fa747f04c4937aa52.svg)](https://www.codacy.com/public/pluma/vworp)

# CLI

```
$ vworp --help

Modify a project's version number.
Usage: fworp <options> [ <newversion> | major | minor | patch | prerelease |
  prepatch | preminor | premajor ]

Options:
  --file, -f      Filename. This can be specified multiple times.
                                                       [default: "package.json"]
  --nogit, -n     Don't create a commit and tag in git.                         
  --version       Show the version number of fworp.                      
  --help, -h, -?  Show this help information. 
```

# API

```js
var vworp = require('vworp');
vworp('1.3.0', false, ['package.json', 'bower.json', 'component.json'])
.then(
  version => console.log('New version:', version),
  err => console.error('Error:', err.message)
);
```

## vworp([newversion[, noGit[, filename]]])

Bumps/sets the version number of the file in `filename` (default: `"package.json"`) to `newversion`.

If `noGit` is not set to `true`, modifying the version number will fail if the current git workspace is not empty and a new commit tagged with the version number (e.g. `v1.0.0`) will be created on success. If not in a git workspace, the option will have no effect.

If `newversion` is not set, the version number will not be modified and the promise will resolve to the current version number of the file or `"0.0.0"` if the file does not contain a `version` property. Otherwise the promise will resolve to the new version number.

If any errors occur, the promise will be rejected with that error.

# License

The MIT/Expat license. For more information, see http://foss-haas.mit-license.org/ or the accompanying [LICENSE](https://github.com/foss-haas/vworp/blob/master/LICENSE) file.

---
_Source: https://npm.io/package/vworp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._