@wedgekit/migrations
v1.6.0
Published
A CLI to painlessly™ migrate previous versions of metadata to the current version.
Downloads
25
Maintainers
Keywords
Readme
@wedgekit/migrations
A CLI to painlessly™ migrate previous versions of metadata to the current version.
@wedgekit/migrations
Getting Started
In order to keep your migrations ever-green, we recommend only ever running @wedgekit/migrations
via npx:
npx @wedgekit/migrations 0.4.0 ./settings.json
Usage
Description
A CLI to painlessly™ migrate previous versions of metadata to the current version.
Usage
$ @wedgekit/migrations <version> <src> [options]
Options
-o, --output Output file destination. This can be a directory or a file.
-v, --version Displays current version
-h, --help Displays this message
Examples
$ @wedgekit/migrations 0.4.1 ./settings.json -o ./settings.new.json
$ @wedgekit/migrations 0.4.2 params-bt.json params-rt.json
API
@wedgekit/migrations <version> <src> [options]
version
Type: string
Required: ✅
A qualified semver version without a v
prefix describing the version of the metadata document being migrated. @wedgekit/migrations
will always take documents to the current version of this package, which should always be in sync with the latest version of the metadata specification.
src
Type: string
Required: ✅
The source metadata document which you wish to migrate to a new version of the metadata spec.
This may be a single document or multiple.
options.output
Type: string
Alias: -o
Required: ❌
Default: <src>
The destination directory or file to write the migrated document to. If output
is a directory, the filename will be settings.json
and it WILL NOT check for an overwrite.
If you are including multiple sources, options.output
MUST be a directory or left blank.
If excluded, @wedgekit/migrations
will write back to the source document.