generates and compares OCLIF plugins snapshot files
npm install @oclif/plugin-command-snapshotGenerates and compares OCLIF plugins snapshot files
* @oclif/plugin-command-snapshot
* Usage
* generates a snapshot file that has a list or commands and flags in the current CLI or plugin
* compare the current CLI or plugin commands and flags with a snapshot file to identify changes
* Contributing
This plugin is used to take snapshot of commands and flags in OCLIF plugins. These snapshots can be used to enforce a deprecation policy or to keep track of changes.
To include it in your plugin, add it to the devPlugins section in your package.json.
``json`
"oclif": {
...
"devPlugins": [
"@oclif/plugin-command-snapshot"
...
]
Use the snapshot:generate command in your development process.
`sh-session`generates a snapshot file that has a list or commands and flags in the current CLI or plugin
$ ./bin/run.js snapshot:generate
Use the snapshot:compare command in your continuos integration. This command will fail if changes are detected. The snapshot file should be updated and committed to the repository when legitimate changes are made.
`sh-session``compare the current CLI or plugin commands and flags with a snapshot file to identify changes
$ ./bin/run.js snapshot:compare