Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joemaller/version-everything
Use npm to version all kinds of projects, not just javascript.
https://github.com/joemaller/version-everything
npm semver
Last synced: 3 months ago
JSON representation
Use npm to version all kinds of projects, not just javascript.
- Host: GitHub
- URL: https://github.com/joemaller/version-everything
- Owner: joemaller
- License: mit
- Created: 2016-12-12T04:01:02.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T13:23:56.000Z (4 months ago)
- Last Synced: 2024-10-10T07:54:40.315Z (3 months ago)
- Topics: npm, semver
- Language: JavaScript
- Size: 1.47 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# version-everything
#### Version: 0.11.4
Use npm to version all kinds of projects, not just JavaScript
[](https://www.npmjs.com/package/version-everything)
[](https://codecov.io/gh/joemaller/version-everything)
[](https://coveralls.io/github/joemaller/version-everything)
[](https://codeclimate.com/github/joemaller/version-everything/maintainability)
[](https://prettier.io)
Synchronize versions from package.json into additional text or structured data files. When called from npm's **version** script, all versioned files in a project will be updated and committed with a single command.
```sh
npm install --save-dev version-everything
```
## How to version everything
There are several ways version-everything can be used, the only requirement is an array of files to synchronize versions into. The files can be text (php, css, markdown, whatever) or structured data (JSON, YAML, XML or plists).
The file list is an array specified in one of the following forms, in order of precedence:
1. Command line arguments
2. `files` key in a **version-everything.config.js** file
3. `version-everything.files` key in the parent project's **package.json** file
### npm lifecycle script in package.json
The simplest way to use _version-everything_ is to hook into npm's version event. Once set up, a single `npm` command will update, commit and tag all versioned files in a project.
Add something like the following to your project's package.json file:
```json
{
"version": "1.3.6",
"scripts": {
"version": "version-everything && git add -u"
},
"version-everything": {
"files": [
"README.md",
"example_wordpress_plugin.php",
"styles.css",
"manifest.json",
"sadness.xml"
]
}
}
```
Now running a command like `npm version minor` will bump the project version and update version strings in all listed files. It's that easy!
Some structured data files may be formatted using default settings.
### Replacing version strings
In text files, the following version strings will be updated.
- `Version: 1.2.34`
- `### Version: 2.34.5` (Markdown headings)
- `* @version 4.5.67` and `/** @version 4.5.67 */` ([PHPDoc tags](https://docs.phpdoc.org/guide/references/phpdoc/tags/version.html#version))
- `v0.6.0` (At end-of-line)
- `LABEL version="1.2.34"` (Dockerfiles)
_Notes:_ Colons are optional. Simple v-prefixed, [git-tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) style version strings must appear at the end of a line.
#### Additional Prefixes
Additional string or RegExp patterns can be added to the list of default patterns and will match against plain text files. When prefixes are specified, structured data files will be processed first as plain text, then again as structured data if no versions are found.
If a stuctured data file contains a comment and a version attribute, including an empty prefix will update both. (ref: [#15](https://github.com/joemaller/version-everything/issues/15#issuecomment-1685039468))
### version-everything config files
This project uses [cosmiconfig](https://www.npmjs.com/package/cosmiconfig) to load config files. The file-key should be `version-everything`, so files like `.version-everythingrc` or `.version-everythingrc.js` will work.
Config files should export a simple JS object and look something like this:
```js
module.exports = {
files: ["README.md", "example_wordpress_plugin.php", "styles.css"],
prefix: /* a string, regexp literal or mixed array of either */
json: {
/* optional json config object, keys pass directly to JSON.stringify */
},
yaml: {
/* optional yaml config object, passes directly to js-yaml */
},
xml: {
/* optional xml config object, passes directly to xml2js */
},
};
```
### Replacing xml attribute values
Version-everything can increment custom attributes in xml files when a keys array is set in the xml config object:
```js
{
"xml": {
"keys": [
"~project-version",
"root~project-version",
"element/hierarchy/relative/to/root~attribute-name"
]
}
}
```
This option will add the attribute when missing, set the value when attribute is present but has no value and modify the value when attribute exists and has value.
The `/` character is used to specify nesting of elements (based on element names). When using this syntax the first element is **always the root element**.
The `~` character is used to specify the end of the hierarchy and beginning of attribute name. When the `~` character is missing or is the first character the operation will be applied to the root element (regardless of its name). To perform the operation only on a specific root element specify its name before the `~` character.
### Plist files
Apple's plist files are parsed independently from standard XML. A `Version` key will be added to the root `` element. Following convention, all plist keys are title-case.
### ES Module Imports
Version-everything can be used like any other esm Node module. The version string will be pulled from package.json and should be treated as a global constant or envvar.
```js
import versionEverything from "./index.js";
versionEverything({ files: ["README.md", "file.json"], json: { space: 4 } });
```
This project is [pure ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
### Command Line Interface (CLI)
When run from the command line, all arguments following the command are assumed to be file paths. This command would sync versions into `readme.md` and `manifest.json`:
```sh
$ version-everything readme.md manifest.json
```
#### Other CLI flags
The following additional flags map to version-everything settings. Run `version-everything -h` for full usage info.
- `-p`, `--package-json` ``
Loads a specific package.json file. When present, this will also be used as the starting location for Cosmiconfig.
- `n`, `--dry-run`
Runs the command without modifying any files.
- `q`, `--quiet`
Run the command silently, without showing update messages.
- `--prefix `
One or more additional pattern prefixes to match against.
#### Conflicting arguments
If a **package.json** is specified, it will be loaded first, then any subsequent args will be applied on top. So if **package.json** were to contain a `version-everything.files` array, that array would be overwritten by any list of files provided to the command line.
### Recognized File Extensions
Files with the following extensions will be recognized as structured text and parsed accordingly.
- **JSON** - `.json`
- **XML** - `.xml`
- **YAML** - `.yml`, `.yaml`
- **PLIST** - `.plist`
- **TEXT** - `.markdown`, `.md`, `.mdown`, `.sh`, `.text`, `.txt`
## API
### versionEverything([options])
All keys are optional. `options.files` is _practically_ required, without a list of files there's nothing to do.
#### options
Type: `object`
All keys are optional.
##### options.files
Type: `array`
An array containing the files which will be versioned.
##### options.version
Type: `string`
A valid SemVer version.
##### options.prefix
Type: `string|RegExp|[string|RegExp]`
A string, RegExp, or a mixed array of either. Will be added to the list of standard version patterns to be replaced in plain-text files.
##### options.json
Type: `object`
Three keys from the `json` object will be passed directly to [`JSON.parse`][jsonparse] or [`JSON.stringify`][stringify]: **`space`** which sets indentation from an integer or string, a **[`reviver`][reviver]** function and a **[`replacer`][replacer]** function/array. See the [JSON docs][stringify] for more info.
Default JSON Options:
```js
{
space: 2,
replacer: null,
reviver: null,
}
```
##### options.xml
Type: `object`
Merged with a minimal set of defaults, then passed to the [xml-js `js2xml` converter][xml-js convert]. See [xml-js docs][] for available options.
Default XML Options:
```js
{
compact: false,
spaces: 2,
indentCdata: true,
}
```
##### options.yaml
Type: `object`
Passed directly to the [js-yaml safeDump method][safedump]. See [js-yaml][] docs for available options.
### Notes
**npm** may fail to commit/tag files when `package.json` is nested below the git repository root. Ref: [npm#18795][npm18795]
Enabling `push.followTags` in Git's global config is highly recommended: `git config --global push.followTags true`
Empty CData blocks `` will be removed from processed XML Documents. To preserve empty blocks, add one or more spaces: ``
[webpack]: https://webpack.github.io/docs/configuration.html
[eslint]: http://eslint.org/docs/user-guide/configuring#configuration-file-formats
[xml-js]: https://www.npmjs.com/package/xml-js
[xml-js convert]: https://www.npmjs.com/package/xml-js#convert-js-object--json-%E2%86%92-xml
[jsondocs]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON
[jsonparse]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse
[stringify]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
[reviver]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter
[replacer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter
[js-yaml]: https://www.npmjs.com/package/js-yaml
[safedump]: https://www.npmjs.com/package/js-yaml#safedump-object---options-
[npm18795]: https://github.com/npm/npm/issues/18795