NFVM - Node File Version Manager

Concept

While writing code I often run into problem of fast switching between versions of local files which are ignored by git. This files for security reason can't be in repository or they are individual for each server. So when I want to start/test app in needed config (with specific set of files) the switching process is too slow.

The nfvm tool - is the first try to solve the problem of my daily pain.

Terminology

Pack

Is a set of files for the project or the part of it. Every file in this pack can have as many versions as you want.
For comfort controll of file versioning you can apply version ONLY for the pack. So when version of pack changes, all files in this pack switches to version of pack.

| Parameter | Type | Description | Default Value| |---------------|---------|------------------------------------------|--------------| |name|String|pack name|''| |defaultVersion|String|name of default version|default| |currentVersion|String|name of current version|default| |versions|String[]|array of registered pack versions|[]| |files|File[]|array of File objects|[]|

File

| Parameter | Type | Description | Default Value| |---------------|---------|------------------------------------------|--------------| |filename|String|the name of file in destination folder|''| |destinationPath|String|full path to destination folder|''| |removeFileIfVersionNotExists|Boolean|if true then when file version does not exists removes the old version of file from the destination directory. Otherwise the old version stays.|true| |symlink|Boolean|if true then creates symlink to file version in destination directory instead of replacing it.|true| |versions|FileVersion[]|array of File Version objects|[]|

File Version

| Parameter | Type | Description | Default Value| |---------------|---------|------------------------------------------|--------------| |name|String|file version name (also should be in Pack.versions)|''| |path|String|full path to file|''|

Installing nfvm

$ npm i nfvm -g

CLI Commands

• init - create local .nfvmrc.json config file
• create <packname>
  • -f, --file <filename> - create file
  • -v <version> - create version of pack or file
  • -g, --global - create in global
• remove <packname> - remove pack
  • -f, --file <filename> - remove file
  • -v <version> - remove version of pack or file
  • -g, --global - remove from global
• set <packname> <version>
  • -g, --global - sets in global
• list
  • -p, --pack <packname> - files list in pack
  • -g, --global - list from global

Resources

User Guide
TODO List

Examples

Create pack example

nfvm create example

Create version default for pack example

nfvm create example -v default

Create file 1 for pack example

nfvm create example -f 1

Create version default for file 1 for pack example

nfvm create example -f 1 -v default

Remove pack example

nfvm remove example

Remove version default for pack example

nfvm remove example -v default

Remove file 1 for pack example

nfvm remove example -f 1

Remove version default for file 1 for pack example

nfvm remove example -f 1 -v default

Set default version for example pack

nfvm set example default

List of all packs

nfvm list

List of all files in example pack

nfvm list -p example

Config File

Config file name is .nfvmrc.json with structure:

{
  "packs": [{
    "name": "String",
    "defaultVersion": "String",
    "currentVersion": "String",
    "versions": "String[]",
    "files": [{
      "filename": "String",
      "destinationPath": "String",
      "removeFileIfVersionNotExists": "Boolean",
      "symlink": "Boolean",
      "versions": [{
        "name": "String",
        "path": "String",
      }]
    }]
  }]
}