version-management

Version Manager

This project aims to simplify the versioning increments and updating that version across various types of files (json / regex text replacement)

Changelog

To install from npm:

npm i --save version-management

Save the following somewhere (preferably not project root directory)

following example: [project]/developer/scripts/version.js

changelog location: [project]/developer/documentation/CHANGELOG.md

dotenv file: [project]/.env with APP_VERSION=1.0.0 as an env variable in there.

"use strict";

// Usage: node ./version.js -abcf
// -a = bump major by 1
// -b = bump minor by 1
// -c = bump patch by 1
// -f = set to specific version.

const VersionManager        = require("version-management"),
    GenericVersionTemplate  = require("version-management/Templates/GenericVersionTemplate"),
    ComposerTemplateModule  = require("version-management/Templates/Modules/PHP/ComposerTemplateModule"),
    NodeTemplateModule      = require("version-management/Templates/Modules/NodeJS/NodeTemplateModule"),
    DeveloperTemplateModule = require("version-management/Templates/Modules/DeveloperTemplateModule");

// This is based on version.js being at `[project]/developer/scripts/`
const projectRoot = require("path").join(__dirname, '..', '..'); 

// Bumps file
let Version = new VersionManager.VersionProgram(__filename+'on');

// Run Templates
VersionManager
    .VersionTemplates
    .addTemplate(ComposerTemplateModule.standard(projectRoot))
    .addTemplate(NodeTemplateModule.standard(projectRoot))
    .addTemplate(DeveloperTemplateModule.dotenv(projectRoot))
    .addTemplate(DeveloperTemplateModule.changelog_hotfixUrls_NodePackage(projectRoot, 'developer/documentation/CHANGELOG.md'))
    .addTemplate(GenericVersionTemplate.simpleReplace(
        projectRoot, 
        ['files/relative/to/projectRoot/1','files/relative/to/projectRoot/2.txt'],
        { ["search_string="+VersionManager.statics.format.searchers.dots]
            : "search_string="+VersionManager.statics.format.replacers.dots },
        "Unique-Key-For-This-Template"
    ))
    .addTemplate(GenericVersionTemplate.jsonReplace(
        projectRoot, 
        ['json/relative/to/projectRoot/1.json','json/relative/to/projectRoot/2.json'],
        "Unique-Key-For-This-Template-2",
        [
            {
                key: "version",
                value: VersionManager.statics.format.replacers.dots
            },
            {
                key: ["child", "version"], // for { child: { version: "1-0-0" }}
                value: VersionManager.statics.format.replacers.dash
            }
        ]
    ))
    .runTemplate(Version.getUpdated());

Running

• Force version: node developer/scripts/version -f 1.0.0 becomes 1.0.0
• Bump major by 1: node developer/scripts/version -a 1.0.0 => 2.0.0
• Bump minor by 2: node developer/scripts/version -bb 2.0.0 => 2.2.0
• Bump patch by 3: node developer/scripts/version -ccc 2.2.0 => 2.2.3
• Unique bump: node developer/scripts/version -abbbcc 2.2.3 => 3.3.2

Once version changes the configured templates will be ran using the updated value.