bump-cli 2.5.0 → 2.7.0

package/README.md

@@ -47,16 +47,16 @@ $ bump --help
 The Bump CLI is used to interact with your API documentation hosted on Bump by using the API of developers.bump.sh
 
 VERSION
-  bump-cli/2.1.1 linux-x64 node-v15.12.0
+  bump-cli/2.5.0 linux-x64 node-v16.14.0
 
 USAGE
   $ bump [COMMAND]
 
 COMMANDS
-  deploy   create a new version of your documentation from the given file or URL
-  diff     Get a comparaison diff with your documentation from the given file or URL
-  help     display help for bump
-  preview  create a documentation preview from the given file or URL
+  deploy   Create a new version of your documentation from the given file or URL.
+  diff     Get a comparison diff with your documentation from the given file or URL.
+  help     Display help for bump.
+  preview  Create a documentation preview from the given file or URL.
 ```
 
 Please check the [Bump CLI help page](https://help.bump.sh/bump-cli) for more CLI usage details.
@@ -92,12 +92,24 @@ Deploy the definition file as the current version of the documentation with the
 $ bump deploy path/to/your/file.yml --doc DOC_ID_OR_SLUG --token DOC_TOKEN
 ```
 
+Deploy the definition file to the `staging` branch of the documentation:
+
+```sh-session
+$ bump deploy path/to/your/file.yml --doc DOC_ID_OR_SLUG --token DOC_TOKEN --branch staging
+```
+
 If you already have a hub in your [Bump.sh](https://bump.sh) account, you can automatically create a documentation inside it and deploy to it with:
 
 ```sh-session
 $ bump deploy path/to/your/file.yml --auto-create --doc DOC_SLUG --hub HUB_ID_OR_SLUG --token HUB_TOKEN
 ```
 
+Within a Hub, you can also deploy a whole directory containing multiple API definitions in a single command:
+
+```sh-session
+$ bump deploy path/to/your/apis/ --auto-create --hub HUB_ID_OR_SLUG --token HUB_TOKEN
+```
+
 Simulate a deployment of your definition file to make sure it is valid with the `--dry-run` flag, it is particularly useful in a Continuous Integration environment running a test deployment outside your main branch:
 
 ```sh-session
@@ -136,7 +148,7 @@ _Note: You can also test this feature in our dedicated web application at <https
 
 #### Authenticated diffs attached to your Bump documentation
 
-From a Bump documentation, the `diff` command will retrieve a comparaison changelog between your existing documentation and the given file or URL:
+From a Bump documentation, the `diff` command will retrieve a comparison changelog between your existing documentation and the given file or URL:
 
 ```sh-session
 $ bump diff path/to/your/file.yml --doc DOC_ID_OR_SLUG --token DOC_TOKEN
@@ -146,7 +158,7 @@ Updated: POST /validations
   Body attribute modified: documentation
 ```
 
-If you want to compare two unpublished versions of your definition file, the `diff` command can retrieve a comparaison changelog between two given file or URL, “as simple as `git diff`”:
+If you want to compare two unpublished versions of your definition file, the `diff` command can retrieve a comparison changelog between two given file or URL, “as simple as `git diff`”:
 
 ```sh-session
 $ bump diff path/to/your/file.yml path/to/your/next-file.yml --doc <doc_slug> --token <your_doc_token>
@@ -156,8 +168,6 @@ Updated: POST /versions
   Body attribute added: previous_version_id
 ```
 
-_Note: you can use the `--open` flag to open the visual diff URL in your browser directly._
-
 Please check `bump diff --help` for full usage details.
 
 ## Development

package/lib/api/error.js

@@ -39,7 +39,7 @@ class APIError extends errors_1.CLIError {
         return [
             [
                 genericMessage,
-                `Please check the given ${chalk_1.default.underline('--documentation')}, ${chalk_1.default.underline('--token')} or ${chalk_1.default.underline('--hub')} flags`,
+                `In a hub context you might want to try the ${chalk_1.default.dim('--auto-create')} flag.\nOtherwise, please check the given ${chalk_1.default.dim('--documentation')}, ${chalk_1.default.dim('--token')} or ${chalk_1.default.dim('--hub')} flags`,
             ],
             104,
         ];

package/lib/args.js

@@ -4,7 +4,7 @@ exports.otherFileArg = exports.fileArg = void 0;
 const fileArg = {
     name: 'FILE',
     required: true,
-    description: 'Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.',
+    description: 'Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.\nPath can also be a directory when deploying to a Hub.',
 };
 exports.fileArg = fileArg;
 const otherFileArg = {

package/lib/commands/deploy.d.ts

@@ -1,16 +1,18 @@
 import Command from '../command';
-import * as flags from '../flags';
+import * as flagsBuilder from '../flags';
 export default class Deploy extends Command {
     static description: string;
     static examples: string[];
     static flags: {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-        doc: flags.IOptionFlag<string | undefined>;
-        'doc-name': flags.IOptionFlag<string | undefined>;
-        hub: flags.IOptionFlag<string | undefined>;
-        branch: flags.IOptionFlag<string | undefined>;
-        token: flags.IOptionFlag<string | undefined>;
+        doc: flagsBuilder.IOptionFlag<string | undefined>;
+        'doc-name': flagsBuilder.IOptionFlag<string | undefined>;
+        hub: flagsBuilder.IOptionFlag<string | undefined>;
+        branch: flagsBuilder.IOptionFlag<string | undefined>;
+        token: flagsBuilder.IOptionFlag<string | undefined>;
         'auto-create': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        interactive: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        'filename-pattern': flagsBuilder.IOptionFlag<string | undefined>;
         'dry-run': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
     };
     static args: {
@@ -19,4 +21,6 @@ export default class Deploy extends Command {
         description: string;
     }[];
     run(): Promise<void>;
+    private deployDirectory;
+    private deploySingleFile;
 }

package/lib/commands/deploy.js

@@ -1,11 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const definition_1 = require("../definition");
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const fs_1 = require("fs");
+const errors_1 = require("@oclif/parser/lib/errors");
+const errors_2 = require("@oclif/errors");
 const command_1 = (0, tslib_1.__importDefault)(require("../command"));
-const flags = (0, tslib_1.__importStar)(require("../flags"));
+const flagsBuilder = (0, tslib_1.__importStar)(require("../flags"));
+const definition_directory_1 = require("../core/definition_directory");
+const deploy_1 = require("../core/deploy");
+const prompts_1 = require("../core/utils/prompts");
 const args_1 = require("../args");
 const cli_1 = require("../cli");
+const definition_1 = require("../definition");
 class Deploy extends command_1.default {
     /*
       Oclif doesn't type parsed args & flags correctly and especially
@@ -15,73 +22,142 @@ class Deploy extends command_1.default {
     */
     async run() {
         const { args, flags } = this.parse(Deploy);
-        const api = await definition_1.API.load(args.FILE);
-        const [definition, references] = api.extractDefinition();
-        const action = flags['dry-run'] ? 'validate' : 'deploy';
-        /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
-        const [documentation, token] = [flags.doc, flags.token];
-        this.d(`${args.FILE} looks like an ${api.specName} spec version ${api.version}`);
-        cli_1.cli.action.start(`* Let's ${action} a new documentation version on Bump`);
-        const request = {
-            documentation,
-            hub: flags.hub,
-            documentation_name: flags['doc-name'],
-            auto_create_documentation: flags['auto-create'] && !flags['dry-run'],
-            definition,
-            references,
-            branch_name: flags.branch,
-        };
-        const response = flags['dry-run']
-            ? await this.bump.postValidation(request, token)
-            : await this.bump.postVersion(request, token);
-        cli_1.cli.action.stop();
-        switch (response.status) {
-            case 200:
-                cli_1.cli.styledSuccess('Definition is valid');
-                break;
-            case 201:
-                const version = response.data
-                    ? response.data
-                    : { id: '', doc_public_url: 'https://bump.sh' };
-                cli_1.cli.styledSuccess(`Your new documentation version will soon be ready at ${version.doc_public_url}`);
-                break;
-            case 204:
-                this.warn('Your documentation has not changed');
-                break;
+        const [dryRun, documentation, token, hub, autoCreate, interactive, filenamePattern, documentationName, branch,] = [
+            flags['dry-run'],
+            flags.doc,
+            /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
+            flags.token,
+            flags.hub,
+            flags['auto-create'],
+            flags.interactive,
+            /* Flags.filenamePattern has a default value, so it's always defined. But
+             * oclif types doesn't detect it */
+            /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
+            flags['filename-pattern'],
+            flags['doc-name'],
+            flags.branch,
+        ];
+        const file = await (0, fs_1.statSync)(args.FILE);
+        if (file.isDirectory()) {
+            if (hub) {
+                await this.deployDirectory(args.FILE, dryRun, token, hub, autoCreate, interactive, filenamePattern, documentationName, branch);
+            }
+            else {
+                throw new errors_1.RequiredFlagError({ flag: Deploy.flags.hub, parse: {} });
+            }
+        }
+        else {
+            if (documentation) {
+                const api = await definition_1.API.load(args.FILE);
+                this.d(`${args.FILE} looks like an ${api.specName} spec version ${api.version}`);
+                await this.deploySingleFile(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch);
+            }
+            else {
+                throw new errors_1.RequiredFlagError({ flag: Deploy.flags.doc, parse: {} });
+            }
         }
         return;
     }
+    async deployDirectory(dir, dryRun, token, hub, autoCreate, interactive, filenamePattern, documentationName, branch) {
+        const definitionDirectory = new definition_directory_1.DefinitionDirectory(dir, filenamePattern);
+        const action = dryRun ? 'validate' : 'deploy';
+        await definitionDirectory.readDefinitions();
+        // In “interactive” mode we ask the user if he wants to add more
+        // definitions to deploy. He is thus presented a form to select
+        // some files from the target directory.
+        if (interactive) {
+            let confirm = true;
+            if (definitionDirectory.definitionsExists()) {
+                await (0, prompts_1.confirm)('Do you want to add more files to deploy?').catch(() => {
+                    confirm = false;
+                });
+            }
+            if (confirm) {
+                await definitionDirectory.interactiveSelection();
+            }
+        }
+        if (definitionDirectory.definitionsExists()) {
+            cli_1.cli.info(chalk_1.default.underline(`Let's ${action} those documentations to your ${hub} hub on Bump.sh`));
+            await definitionDirectory.sequentialMap(async (definition) => {
+                if (interactive) {
+                    await definitionDirectory.renameToConvention(definition);
+                }
+                await this.deploySingleFile(definition.definition, dryRun, definition.slug, token, hub, autoCreate, definition.slug || documentationName, branch);
+                return definition;
+            });
+        }
+        else {
+            throw new errors_2.CLIError(`No documentations found in ${dir}.\nYou should check the ${chalk_1.default.dim('--filename-pattern')} flag to select your files from your naming convention.\nIf you don't have a naming convention we can help naming your API definition files:\nTry the ${chalk_1.default.dim('--interactive')} flag for that.`);
+        }
+        return;
+    }
+    async deploySingleFile(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch) {
+        const action = dryRun ? 'validate' : 'deploy';
+        cli_1.cli.action.start(`Let's ${action} a new version to your ${documentation} documentation on Bump.sh`);
+        const response = await new deploy_1.Deploy(this.config).run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch);
+        if (dryRun) {
+            await cli_1.cli.styledSuccess('Definition is valid');
+        }
+        else {
+            if (response) {
+                await cli_1.cli.styledSuccess(`Your new documentation version will soon be ready at ${response.doc_public_url}`);
+            }
+            else {
+                await cli_1.cli.warn('Your documentation has not changed');
+            }
+        }
+        cli_1.cli.action.stop();
+        return;
+    }
 }
 exports.default = Deploy;
-Deploy.description = 'create a new version of your documentation from the given file or URL';
+Deploy.description = 'Create a new version of your documentation from the given file or URL.';
 Deploy.examples = [
-    `Deploy a new version of an existing documentation
+    `Deploy a new version of ${chalk_1.default.underline('an existing documentation')}
 
-$ bump deploy FILE --doc <your_doc_id_or_slug> --token <your_doc_token>
+${chalk_1.default.dim('$ bump deploy FILE --doc <your_doc_id_or_slug> --token <your_doc_token>')}
 * Let's deploy a new documentation version on Bump... done
 * Your new documentation version will soon be ready
 `,
-    `Deploy a new version of an existing documentation attached to a hub
+    `Deploy a new version of ${chalk_1.default.underline('an existing documentation attached to a hub')}
 
-$ bump deploy FILE --doc <doc_slug> --hub <your_hub_id_or_slug> --token <your_doc_token>
+${chalk_1.default.dim('$ bump deploy FILE --doc <doc_slug> --hub <your_hub_id_or_slug> --token <your_doc_token>')}
 * Let's deploy a new documentation version on Bump... done
 * Your new documentation version will soon be ready
 `,
-    `Validate a new documentation version before deploying it
+    `Deploy a whole directory of ${chalk_1.default.underline('API definitions files to a hub')}
+
+${chalk_1.default.dim('$ bump deploy DIR --filename-pattern *-{slug}-api --hub <hub_slug> --token <hub_token>')}
+We've found 2 valid API definitions to deploy
+└─ DIR
+   └─ source-my-service-api.yml (OpenAPI spec version 3.1.0)
+   └─ source-my-jobs-service-api.yml (AsyncAPI spec version 2.6.0)
+
+Let's deploy those documentations to your <hub_slug> hub on Bump.sh
+
+* Your new documentation version will soon be ready
+Let's deploy a new version to your my-service documentation on Bump.sh... done
+
+* Your new documentation version will soon be ready
+Let's deploy a new version to your my-jobs-service documentation on Bump.sh... done
+`,
+    `${chalk_1.default.underline('Validate a new documentation version')} before deploying it
 
-$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_token>
+${chalk_1.default.dim('$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_token>')}
 * Let's validate a new documentation version on Bump... done
 * Definition is valid
 `,
 ];
 Deploy.flags = {
-    help: flags.help({ char: 'h' }),
-    doc: flags.doc(),
-    'doc-name': flags.docName(),
-    hub: flags.hub(),
-    branch: flags.branch(),
-    token: flags.token(),
-    'auto-create': flags.autoCreate(),
-    'dry-run': flags.dryRun(),
+    help: flagsBuilder.help({ char: 'h' }),
+    doc: flagsBuilder.doc(),
+    'doc-name': flagsBuilder.docName(),
+    hub: flagsBuilder.hub(),
+    branch: flagsBuilder.branch(),
+    token: flagsBuilder.token(),
+    'auto-create': flagsBuilder.autoCreate(),
+    interactive: flagsBuilder.interactive(),
+    'filename-pattern': flagsBuilder.filenamePattern(),
+    'dry-run': flagsBuilder.dryRun(),
 };
 Deploy.args = [args_1.fileArg];

package/lib/commands/diff.d.ts

@@ -1,23 +1,24 @@
 import Command from '../command';
-import * as flags from '../flags';
+import * as flagsBuilder from '../flags';
 import { DiffResponse } from '../api/models';
 export default class Diff extends Command {
     static description: string;
     static examples: string[];
     static flags: {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-        doc: flags.IOptionFlag<string | undefined>;
-        hub: flags.IOptionFlag<string | undefined>;
-        branch: flags.IOptionFlag<string | undefined>;
-        token: flags.IOptionFlag<string | undefined>;
+        doc: flagsBuilder.IOptionFlag<string | undefined>;
+        hub: flagsBuilder.IOptionFlag<string | undefined>;
+        branch: flagsBuilder.IOptionFlag<string | undefined>;
+        token: flagsBuilder.IOptionFlag<string | undefined>;
         open: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        format: flags.IOptionFlag<string | undefined>;
-        expires: flags.IOptionFlag<string | undefined>;
+        'fail-on-breaking': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        format: flagsBuilder.IOptionFlag<string | undefined>;
+        expires: flagsBuilder.IOptionFlag<string | undefined>;
     };
     static args: {
         name: string;
         description: string;
     }[];
     run(): Promise<void>;
-    displayCompareResult(result: DiffResponse, format: string, open: boolean): Promise<void>;
+    displayCompareResult(result: DiffResponse, format: string, open: boolean, failOnBreaking: boolean): Promise<void>;
 }

package/lib/commands/diff.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const errors_1 = require("@oclif/errors");
 const command_1 = (0, tslib_1.__importDefault)(require("../command"));
-const flags = (0, tslib_1.__importStar)(require("../flags"));
+const flagsBuilder = (0, tslib_1.__importStar)(require("../flags"));
 const diff_1 = require("../core/diff");
 const args_1 = require("../args");
 const cli_1 = require("../cli");
@@ -41,14 +41,14 @@ class Diff extends command_1.default {
         const diff = await new diff_1.Diff(this.config).run(args.FILE, args.FILE2, documentation, hub, branch, token, format, expires);
         cli_1.cli.action.stop();
         if (diff) {
-            await this.displayCompareResult(diff, format, flags.open);
+            await this.displayCompareResult(diff, format, flags.open, flags['fail-on-breaking']);
         }
         else {
             await cli_1.cli.log('No changes detected.');
         }
         return;
     }
-    async displayCompareResult(result, format, open) {
+    async displayCompareResult(result, format, open, failOnBreaking) {
         if (format == 'text' && result.text) {
             await cli_1.cli.log(result.text);
         }
@@ -67,10 +67,13 @@ class Diff extends command_1.default {
         if (open && result.public_url) {
             await cli_1.cli.open(result.public_url);
         }
+        if (failOnBreaking && result.breaking) {
+            this.exit(1);
+        }
     }
 }
 exports.default = Diff;
-Diff.description = 'Get a comparaison diff with your documentation from the given file or URL';
+Diff.description = 'Get a comparison diff with your documentation from the given file or URL.';
 Diff.examples = [
     `Compare a potential new version with the currently published one:
 
@@ -103,13 +106,14 @@ Diff.examples = [
 `,
 ];
 Diff.flags = {
-    help: flags.help({ char: 'h' }),
-    doc: flags.doc({ required: false }),
-    hub: flags.hub(),
-    branch: flags.branch(),
-    token: flags.token({ required: false }),
-    open: flags.open({ description: 'Open the visual diff in your browser' }),
-    format: flags.format(),
-    expires: flags.expires(),
+    help: flagsBuilder.help({ char: 'h' }),
+    doc: flagsBuilder.doc(),
+    hub: flagsBuilder.hub(),
+    branch: flagsBuilder.branch(),
+    token: flagsBuilder.token({ required: false }),
+    open: flagsBuilder.open({ description: 'Open the visual diff in your browser' }),
+    'fail-on-breaking': flagsBuilder.failOnBreaking(),
+    format: flagsBuilder.format(),
+    expires: flagsBuilder.expires(),
 };
 Diff.args = [args_1.fileArg, args_1.otherFileArg];

package/lib/commands/preview.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const definition_1 = require("../definition");
 const command_1 = (0, tslib_1.__importDefault)(require("../command"));
-const flags = (0, tslib_1.__importStar)(require("../flags"));
+const flagsBuilder = (0, tslib_1.__importStar)(require("../flags"));
 const args_1 = require("../args");
 const cli_1 = require("../cli");
 const fs_1 = require("fs");
@@ -11,12 +11,10 @@ const async_mutex_1 = require("async-mutex");
 class Preview extends command_1.default {
     async run() {
         const { args, flags } = this.parse(Preview);
+        await this.preview(args.FILE, flags.open);
         if (flags.live) {
             await this.waitForChanges(args.FILE, flags.open);
         }
-        else {
-            await this.preview(args.FILE, flags.open);
-        }
         return;
     }
     async preview(file, open = false, currentPreview = undefined) {
@@ -68,17 +66,19 @@ class Preview extends command_1.default {
     }
 }
 exports.default = Preview;
-Preview.description = 'create a documentation preview from the given file or URL';
+Preview.description = 'Create a documentation preview from the given file or URL.';
 Preview.examples = [
     `$ bump preview FILE
 * Your preview is visible at: https://bump.sh/preview/45807371-9a32-48a7-b6e4-1cb7088b5b9b
 `,
 ];
 Preview.flags = {
-    help: flags.help({ char: 'h' }),
-    live: flags.live({
+    help: flagsBuilder.help({ char: 'h' }),
+    live: flagsBuilder.live({
         description: 'Generate a preview each time you save the given file',
     }),
-    open: flags.open({ description: 'Open the generated preview URL in your browser' }),
+    open: flagsBuilder.open({
+        description: 'Open the generated preview URL in your browser',
+    }),
 };
 Preview.args = [args_1.fileArg];

package/lib/core/definition_directory.d.ts

@@ -0,0 +1,20 @@
+import { API } from '../definition';
+export declare type DefinitionConfig = {
+    definition: API;
+    file: string;
+    slug: string;
+};
+export declare class DefinitionDirectory {
+    protected readonly path: string;
+    protected readonly definitions: DefinitionConfig[];
+    protected readonly filenamePattern: RegExp;
+    protected readonly humanFilenamePattern: string;
+    protected buildNewFilename: (slug: string) => string;
+    constructor(directory: string, filenamePattern: string);
+    readDefinitions(): Promise<DefinitionConfig[]>;
+    definitionsExists(): boolean;
+    sequentialMap(callback: (definition: DefinitionConfig) => Promise<DefinitionConfig>): Promise<void>;
+    renameToConvention(documentation: DefinitionConfig): Promise<void>;
+    interactiveSelection(): Promise<DefinitionConfig[]>;
+    d(formatter: any, ...args: any[]): void;
+}

package/lib/core/definition_directory.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefinitionDirectory = void 0;
+const tslib_1 = require("tslib");
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const fs_1 = require("fs");
+const node_path_1 = require("node:path");
+const p = (0, tslib_1.__importStar)(require("@clack/prompts"));
+const errors_1 = require("@oclif/errors");
+const cli_1 = require("../cli");
+const definition_1 = require("../definition");
+const file_1 = require("./utils/file");
+const prompts_1 = require("../core/utils/prompts");
+class DefinitionDirectory {
+    constructor(directory, filenamePattern) {
+        this.path = (0, node_path_1.resolve)(directory);
+        this.definitions = [];
+        // Transform basic patterns '*' or '{text}' into a real RegExp
+        this.filenamePattern = new RegExp('^' + filenamePattern.replace('*', '.*?').replace(/{.*?}/, '(?<slug>.+?)') + '$');
+        this.buildNewFilename = (slug) => filenamePattern.replace('*', '').replace(/{.*?}/, slug);
+        this.humanFilenamePattern = filenamePattern.replace(/{(.*?)}/, `${chalk_1.default.inverse('{$1}')}`);
+    }
+    async readDefinitions() {
+        var e_1, _a;
+        try {
+            for (var _b = (0, tslib_1.__asyncValues)(file_1.File.listValidConventionFiles(this.path, this.filenamePattern)), _c; _c = await _b.next(), !_c.done;) {
+                const { value, filename } = _c.value;
+                const file = (0, node_path_1.join)(this.path, value);
+                /* We already check the filenamePattern match inside the
+                `File.listValidConventionFiles` method so we are sure the group
+                matched exists. */
+                /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
+                const slug = filename.match(this.filenamePattern).groups.slug;
+                const definition = await definition_1.API.load(file);
+                this.definitions.push({
+                    file,
+                    definition,
+                    slug,
+                });
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) await _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        if (this.definitions.length) {
+            cli_1.cli.info(chalk_1.default.underline(`We've found ${this.definitions.length} valid API definitions to deploy`));
+            const subtree = cli_1.cli.tree();
+            this.definitions.forEach(({ file, definition }) => subtree.insert(`${(0, node_path_1.basename)(file)} (${definition.specName} spec version ${definition.version})`));
+            const tree = cli_1.cli.tree();
+            tree.insert(this.path, subtree);
+            tree.display();
+            cli_1.cli.info('');
+        }
+        return this.definitions;
+    }
+    definitionsExists() {
+        return !!this.definitions.length;
+    }
+    async sequentialMap(callback) {
+        for (const definition of this.definitions) {
+            await callback(definition);
+        }
+        return;
+    }
+    async renameToConvention(documentation) {
+        const { file, slug } = documentation;
+        if ((0, node_path_1.basename)(file, (0, node_path_1.extname)(file)).match(this.filenamePattern))
+            return;
+        // Default convention is defined in the flags.ts file for the
+        // 'filenamePattern' flag.
+        const newFilename = this.buildNewFilename(slug);
+        const newFile = `${(0, node_path_1.dirname)(file)}/${newFilename}${(0, node_path_1.extname)(file)}`;
+        let confirm = true;
+        await (0, prompts_1.confirm)(`Do you want to rename ${file} to ${newFile} (for later deployments)?`).catch(() => {
+            confirm = false;
+        });
+        if (confirm) {
+            await (0, fs_1.rename)(file, newFile, (err) => {
+                if (err)
+                    throw err;
+                cli_1.cli.styledSuccess(`Renamed ${file} to ${newFile}.`);
+            });
+        }
+        return;
+    }
+    async interactiveSelection() {
+        p.intro(`This interactive form will help you rename your API contrat files to follow the expected naming convention.\n${chalk_1.default.gray('│  ')}Once finished, the selected files will be deployed to Bump.sh.\n${chalk_1.default.gray('│  ')}\n${chalk_1.default.gray('│  ')}File naming convention: ${this.humanFilenamePattern}${chalk_1.default.dim('.[json|yml|yaml]')}\n`);
+        const fileOptions = file_1.File.listInvalidConventionFiles(this.path, this.filenamePattern);
+        if (!fileOptions.length) {
+            throw new errors_1.CLIError(`No JSON or YAML files needing a rename were found in ${this.path}.\nAre you sure you need the ${chalk_1.default.dim('--interactive')} flag?`);
+        }
+        let shouldContinue = true;
+        while (shouldContinue) {
+            const filePrompt = {
+                fileName: () => p.select({
+                    message: `Which file do you want to deploy from ${chalk_1.default.dim(this.path)}?`,
+                    options: fileOptions,
+                }),
+            };
+            const groupPrompt = {
+                /* Results type should be taken from the previous prompts
+                 * defined with clack/prompt  */
+                slug: ({ results }) => p.text({
+                    message: `What is the ${chalk_1.default.inverse('documentation slug')} for this ${chalk_1.default.dim(results.fileName)} file?`,
+                }),
+            };
+            const prompt = await p.group(Object.assign(Object.assign(Object.assign({}, filePrompt), groupPrompt), { shouldContinue: () => p.confirm({ message: 'Do you want to select another file?' }) }), {
+                onCancel: () => {
+                    p.cancel('Deploy cancelled.');
+                    process.exit(0);
+                },
+            });
+            const file = (0, node_path_1.join)(this.path, prompt.fileName);
+            const definition = await definition_1.API.load(file);
+            this.d(`${file} looks like an ${definition.specName} spec version ${definition.version}`);
+            this.definitions.push({
+                file,
+                definition,
+                slug: prompt.slug,
+            });
+            shouldContinue = prompt.shouldContinue;
+        }
+        p.outro(`You're all set. Your deployments will start soon.`);
+        return this.definitions;
+    }
+    // Function signature type taken from @types/debug
+    // Debugger(formatter: any, ...args: any[]): void;
+    /* eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any */
+    d(formatter, ...args) {
+        return (0, debug_1.default)(`bump-cli:core:interactive`)(formatter, ...args);
+    }
+}
+exports.DefinitionDirectory = DefinitionDirectory;

package/lib/core/deploy.d.ts

@@ -0,0 +1,14 @@
+import * as Config from '@oclif/config';
+import { API } from '../definition';
+import { BumpApi } from '../api';
+import { VersionRequest, VersionResponse } from '../api/models';
+export declare class Deploy {
+    _bump: BumpApi;
+    _config: Config.IConfig;
+    constructor(config: Config.IConfig);
+    run(api: API, dryRun: boolean, documentation: string, token: string, hub: string | undefined, autoCreate: boolean, documentationName: string | undefined, branch: string | undefined): Promise<VersionResponse | undefined>;
+    get bumpClient(): BumpApi;
+    createVersion(request: VersionRequest, token: string): Promise<VersionResponse | undefined>;
+    validateVersion(version: VersionRequest, token: string): Promise<undefined>;
+    d(formatter: any, ...args: any[]): void;
+}

package/lib/core/deploy.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Deploy = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const api_1 = require("../api");
+class Deploy {
+    constructor(config) {
+        this._config = config;
+    }
+    async run(api, dryRun, documentation, token, hub, autoCreate, documentationName, branch) {
+        let version = undefined;
+        const [definition, references] = api.extractDefinition();
+        const request = {
+            documentation,
+            hub,
+            documentation_name: documentationName,
+            auto_create_documentation: autoCreate && !dryRun,
+            definition,
+            references,
+            branch_name: branch,
+        };
+        if (dryRun) {
+            await this.validateVersion(request, token);
+        }
+        else {
+            version = await this.createVersion(request, token);
+        }
+        return version;
+    }
+    get bumpClient() {
+        if (!this._bump)
+            this._bump = new api_1.BumpApi(this._config);
+        return this._bump;
+    }
+    async createVersion(request, token) {
+        const response = await this.bumpClient.postVersion(request, token);
+        let version = undefined;
+        switch (response.status) {
+            case 204:
+                break;
+            case 201:
+                version = response.data
+                    ? response.data
+                    : { id: '', doc_public_url: 'https://bump.sh' };
+                break;
+            default:
+                this.d(`API status response was ${response.status}. Expected 201 or 204.`);
+                throw new Error('Unexpected server response. Please contact support at https://bump.sh if this error persists');
+        }
+        return version;
+    }
+    async validateVersion(version, token) {
+        const response = await this.bumpClient.postValidation(version, token);
+        switch (response.status) {
+            case 200:
+                break;
+            default:
+                this.d(`API status response was ${response.status}. Expected 200.`);
+                throw new Error('Unexpected server response. Please contact support at https://bump.sh if this error persists');
+        }
+        return;
+    }
+    // Function signature type taken from @types/debug
+    // Debugger(formatter: any, ...args: any[]): void;
+    /* eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any */
+    d(formatter, ...args) {
+        return (0, debug_1.default)(`bump-cli:core:deploy`)(formatter, ...args);
+    }
+}
+exports.Deploy = Deploy;

package/lib/core/utils/file.d.ts

@@ -0,0 +1,12 @@
+declare type FileDescription = {
+    value: string;
+    label: string;
+    filename: string;
+};
+export declare class File {
+    protected static readonly supportedFormats: string[];
+    static listValidConventionFiles(path: string, regex: RegExp): FileDescription[];
+    static listInvalidConventionFiles(path: string, regex: RegExp): FileDescription[];
+    private static listValidFormatFiles;
+}
+export {};

package/lib/core/utils/file.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.File = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+class File {
+    static listValidConventionFiles(path, regex) {
+        return File.listValidFormatFiles(path).filter(({ filename }) => {
+            return filename.match(regex);
+        });
+    }
+    static listInvalidConventionFiles(path, regex) {
+        return File.listValidFormatFiles(path).filter(({ filename }) => {
+            return !filename.match(regex);
+        });
+    }
+    static listValidFormatFiles(path) {
+        return (0, fs_1.readdirSync)(path)
+            .filter((file) => {
+            return File.supportedFormats.includes((0, path_1.extname)(file));
+        })
+            .map((file) => {
+            return {
+                value: file,
+                label: (0, path_1.basename)(file),
+                filename: (0, path_1.basename)(file, (0, path_1.extname)(file)),
+            };
+        });
+    }
+}
+exports.File = File;
+File.supportedFormats = ['.yml', '.yaml', '.json'];

package/lib/core/utils/prompts.d.ts

@@ -0,0 +1 @@
+export declare const confirm: (message?: string) => Promise<void>;

package/lib/core/utils/prompts.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.confirm = void 0;
+const tslib_1 = require("tslib");
+const errors_1 = require("@oclif/errors");
+const p = (0, tslib_1.__importStar)(require("@clack/prompts"));
+const confirm = async (message = 'Continue?') => {
+    const prompt = await p.group({
+        shouldContinue: () => p.confirm({ message: message }),
+    }, {
+        onCancel: () => {
+            p.cancel('Cancelled.');
+            process.exit(0);
+        },
+    });
+    if (!prompt.shouldContinue) {
+        throw new errors_1.CLIError(`Cancelled`);
+    }
+    return;
+};
+exports.confirm = confirm;

package/lib/definition.d.ts

@@ -1,5 +1,9 @@
 import $RefParser from '@apidevtools/json-schema-ref-parser';
 import { JSONSchema4Object, JSONSchema6Object } from 'json-schema';
+declare class SupportedFormat {
+    static readonly openapi: Record<string, SpecSchema>;
+    static readonly asyncapi: Record<string, SpecSchema>;
+}
 declare class API {
     readonly location: string;
     readonly rawDefinition: string;
@@ -34,4 +38,4 @@ declare type AsyncAPI = JSONSchema4Object & {
     readonly asyncapi: string;
     readonly info: string;
 };
-export { API };
+export { API, SupportedFormat };

package/lib/definition.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.API = void 0;
+exports.SupportedFormat = exports.API = void 0;
 const tslib_1 = require("tslib");
 const errors_1 = require("@oclif/errors");
 const json_schema_ref_parser_1 = (0, tslib_1.__importDefault)(require("@apidevtools/json-schema-ref-parser"));
@@ -9,6 +9,7 @@ const specs_1 = (0, tslib_1.__importDefault)(require("@asyncapi/specs"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 class SupportedFormat {
 }
+exports.SupportedFormat = SupportedFormat;
 SupportedFormat.openapi = {
     '2.0': require('oas-schemas/schemas/v2.0/schema.json'),
     '3.0': require('oas-schemas/schemas/v3.0/schema.json'),
@@ -21,6 +22,7 @@ SupportedFormat.asyncapi = {
     '2.3': specs_1.default['2.3.0'],
     '2.4': specs_1.default['2.4.0'],
     '2.5': specs_1.default['2.5.0'],
+    '2.6': specs_1.default['2.6.0'],
 };
 class UnsupportedFormat extends errors_1.CLIError {
     constructor(message = '') {

package/lib/flags.d.ts

@@ -4,12 +4,15 @@ export * from '@oclif/command/lib/flags';
 declare const doc: flags.Definition<string>;
 declare const docName: flags.Definition<string>;
 declare const hub: flags.Definition<string>;
+declare const filenamePattern: flags.Definition<string>;
 declare const branch: flags.Definition<string>;
 declare const token: flags.Definition<string>;
 declare const autoCreate: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
+declare const interactive: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
 declare const dryRun: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
 declare const open: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
+declare const failOnBreaking: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
 declare const live: (options?: {}) => Parser.flags.IBooleanFlag<boolean>;
 declare const format: flags.Definition<string>;
 declare const expires: flags.Definition<string>;
-export { doc, docName, hub, branch, token, autoCreate, dryRun, open, live, format, expires, };
+export { doc, docName, hub, branch, token, autoCreate, interactive, filenamePattern, dryRun, open, failOnBreaking, live, format, expires, };

package/lib/flags.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.expires = exports.format = exports.live = exports.open = exports.dryRun = exports.autoCreate = exports.token = exports.branch = exports.hub = exports.docName = exports.doc = void 0;
+exports.expires = exports.format = exports.live = exports.failOnBreaking = exports.open = exports.dryRun = exports.filenamePattern = exports.interactive = exports.autoCreate = exports.token = exports.branch = exports.hub = exports.docName = exports.doc = void 0;
 const tslib_1 = require("tslib");
 const command_1 = require("@oclif/command");
 // Re-export oclif flags https://oclif.io/docs/flags
 (0, tslib_1.__exportStar)(require("@oclif/command/lib/flags"), exports);
-// Custom flags for bum-cli
+// Custom flags for bump-cli
 const doc = command_1.flags.build({
     char: 'd',
-    required: true,
     description: 'Documentation public id or slug. Can be provided via BUMP_ID environment variable',
     default: () => {
         const envDoc = process.env.BUMP_ID;
@@ -35,6 +34,11 @@ const hub = command_1.flags.build({
     },
 });
 exports.hub = hub;
+const filenamePattern = command_1.flags.build({
+    description: `Pattern to extract the documentation slug from filenames when deploying a DIRECTORY. Pattern uses only '*' and '{slug}' as special characters to extract the slug from a filename without extension. Used with --hub flag only.`,
+    default: '{slug}-api',
+});
+exports.filenamePattern = filenamePattern;
 const branch = command_1.flags.build({
     char: 'B',
     description: 'Branch name. Can be provided via BUMP_BRANCH_NAME environment variable',
@@ -60,6 +64,10 @@ const autoCreate = (options = {}) => {
     return command_1.flags.boolean(Object.assign({ description: 'Automatically create the documentation if needed (only available with a --hub flag). Documentation name can be provided with --doc-name flag. Default: false', dependsOn: ['hub'] }, options));
 };
 exports.autoCreate = autoCreate;
+const interactive = (options = {}) => {
+    return command_1.flags.boolean(Object.assign({ description: "Interactively create a configuration file to deploy a Hub (only available with a --hub flag). This will start an interactive process if you don't have a CLI configuration file. Default: false", dependsOn: ['hub'] }, options));
+};
+exports.interactive = interactive;
 const dryRun = (options = {}) => {
     return command_1.flags.boolean(Object.assign({ description: 'Validate a new documentation version. Does everything a normal deploy would do except publishing the new version. Useful in automated environments such as test platforms or continuous integration. Default: false' }, options));
 };
@@ -68,6 +76,18 @@ const open = (options = {}) => {
     return command_1.flags.boolean(Object.assign({ char: 'o', default: false }, options));
 };
 exports.open = open;
+const failOnBreaking = (options = {}) => {
+    return command_1.flags.boolean(Object.assign({ char: 'F', description: 'Fail when diff contains a breaking change', default: () => {
+            const envCi = process.env.CI;
+            if (envCi) {
+                return true;
+            }
+            else {
+                return false;
+            }
+        } }, options));
+};
+exports.failOnBreaking = failOnBreaking;
 const live = (options = {}) => {
     return command_1.flags.boolean(Object.assign({ char: 'l', default: false }, options));
 };

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.5.0","commands":{"deploy":{"id":"deploy","description":"create a new version of your documentation from the given file or URL","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Deploy a new version of an existing documentation\n\n$ bump deploy FILE --doc <your_doc_id_or_slug> --token <your_doc_token>\n* Let's deploy a new documentation version on Bump... done\n* Your new documentation version will soon be ready\n","Deploy a new version of an existing documentation attached to a hub\n\n$ bump deploy FILE --doc <doc_slug> --hub <your_hub_id_or_slug> --token <your_doc_token>\n* Let's deploy a new documentation version on Bump... done\n* Your new documentation version will soon be ready\n","Validate a new documentation version before deploying it\n\n$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_token>\n* Let's validate a new documentation version on Bump... done\n* Definition is valid\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"doc":{"name":"doc","type":"option","char":"d","description":"Documentation public id or slug. Can be provided via BUMP_ID environment variable","required":true},"doc-name":{"name":"doc-name","type":"option","char":"n","description":"Documentation name. Used with --auto-create flag."},"hub":{"name":"hub","type":"option","char":"b","description":"Hub id or slug. Can be provided via BUMP_HUB_ID environment variable"},"branch":{"name":"branch","type":"option","char":"B","description":"Branch name. Can be provided via BUMP_BRANCH_NAME environment variable"},"token":{"name":"token","type":"option","char":"t","description":"Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable","required":true},"auto-create":{"name":"auto-create","type":"boolean","description":"Automatically create the documentation if needed (only available with a --hub flag). Documentation name can be provided with --doc-name flag. Default: false","allowNo":false},"dry-run":{"name":"dry-run","type":"boolean","description":"Validate a new documentation version. Does everything a normal deploy would do except publishing the new version. Useful in automated environments such as test platforms or continuous integration. Default: false","allowNo":false}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.","required":true}]},"diff":{"id":"diff","description":"Get a comparaison diff with your documentation from the given file or URL","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Compare a potential new version with the currently published one:\n\n  $ bump diff FILE --doc <your_doc_id_or_slug> --token <your_doc_token>\n  * Comparing the given definition file with the currently deployed one... done\n  Removed: GET /compare\n  Added: GET /versions/{versionId}\n","Store the diff in a dedicated file:\n\n  $ bump diff FILE --doc <doc_slug> --token <doc_token> > /tmp/my-saved-diff\n  * Comparing the given definition file with the currently deployed one... done\n\n  $ cat /tmp/my-saved-diff\n  Removed: GET /compare\n  Added: GET /versions/{versionId}\n","In case of a non modified definition FILE compared to your existing documentation, no changes are output:\n\n  $ bump diff FILE --doc <doc_slug> --token <your_doc_token>\n  * Comparing the given definition file with the currently deployed one... done\n   ›   Warning: Your documentation has not changed\n","Compare two different input files or URL independently to the one published on bump.sh\n\n  $ bump diff FILE FILE2 --doc <doc_slug> --token <your_doc_token>\n  * Comparing the two given definition files... done\n  Updated: POST /versions\n    Body attribute added: previous_version_id\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"doc":{"name":"doc","type":"option","char":"d","description":"Documentation public id or slug. Can be provided via BUMP_ID environment variable","required":false},"hub":{"name":"hub","type":"option","char":"b","description":"Hub id or slug. Can be provided via BUMP_HUB_ID environment variable"},"branch":{"name":"branch","type":"option","char":"B","description":"Branch name. Can be provided via BUMP_BRANCH_NAME environment variable"},"token":{"name":"token","type":"option","char":"t","description":"Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable","required":false},"open":{"name":"open","type":"boolean","char":"o","description":"Open the visual diff in your browser","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"Format in which to provide the diff result","options":["text","markdown","json","html"],"default":"text"},"expires":{"name":"expires","type":"option","char":"e","description":"Specify a longer expiration date for public diffs (defaults to 1 day). Use iso8601 format to provide a date, or you can use `--expires 'never'` to keep the result live indefinitely."}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.","required":true},{"name":"FILE2","description":"Path or URL to a second API documentation file to compute its diff"}]},"preview":{"id":"preview","description":"create a documentation preview from the given file or URL","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["$ bump preview FILE\n* Your preview is visible at: https://bump.sh/preview/45807371-9a32-48a7-b6e4-1cb7088b5b9b\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"live":{"name":"live","type":"boolean","char":"l","description":"Generate a preview each time you save the given file","allowNo":false},"open":{"name":"open","type":"boolean","char":"o","description":"Open the generated preview URL in your browser","allowNo":false}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.","required":true}]}}}
+{"version":"2.7.0","commands":{"deploy":{"id":"deploy","description":"Create a new version of your documentation from the given file or URL.","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Deploy a new version of an existing documentation\n\n$ bump deploy FILE --doc <your_doc_id_or_slug> --token <your_doc_token>\n* Let's deploy a new documentation version on Bump... done\n* Your new documentation version will soon be ready\n","Deploy a new version of an existing documentation attached to a hub\n\n$ bump deploy FILE --doc <doc_slug> --hub <your_hub_id_or_slug> --token <your_doc_token>\n* Let's deploy a new documentation version on Bump... done\n* Your new documentation version will soon be ready\n","Deploy a whole directory of API definitions files to a hub\n\n$ bump deploy DIR --filename-pattern *-{slug}-api --hub <hub_slug> --token <hub_token>\nWe've found 2 valid API definitions to deploy\n└─ DIR\n   └─ source-my-service-api.yml (OpenAPI spec version 3.1.0)\n   └─ source-my-jobs-service-api.yml (AsyncAPI spec version 2.6.0)\n\nLet's deploy those documentations to your <hub_slug> hub on Bump.sh\n\n* Your new documentation version will soon be ready\nLet's deploy a new version to your my-service documentation on Bump.sh... done\n\n* Your new documentation version will soon be ready\nLet's deploy a new version to your my-jobs-service documentation on Bump.sh... done\n","Validate a new documentation version before deploying it\n\n$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_token>\n* Let's validate a new documentation version on Bump... done\n* Definition is valid\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"doc":{"name":"doc","type":"option","char":"d","description":"Documentation public id or slug. Can be provided via BUMP_ID environment variable"},"doc-name":{"name":"doc-name","type":"option","char":"n","description":"Documentation name. Used with --auto-create flag."},"hub":{"name":"hub","type":"option","char":"b","description":"Hub id or slug. Can be provided via BUMP_HUB_ID environment variable"},"branch":{"name":"branch","type":"option","char":"B","description":"Branch name. Can be provided via BUMP_BRANCH_NAME environment variable"},"token":{"name":"token","type":"option","char":"t","description":"Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable","required":true,"default":"99f52837852249b328c0a00249f846a3"},"auto-create":{"name":"auto-create","type":"boolean","description":"Automatically create the documentation if needed (only available with a --hub flag). Documentation name can be provided with --doc-name flag. Default: false","allowNo":false},"interactive":{"name":"interactive","type":"boolean","description":"Interactively create a configuration file to deploy a Hub (only available with a --hub flag). This will start an interactive process if you don't have a CLI configuration file. Default: false","allowNo":false},"filename-pattern":{"name":"filename-pattern","type":"option","description":"Pattern to extract the documentation slug from filenames when deploying a DIRECTORY. Pattern uses only '*' and '{slug}' as special characters to extract the slug from a filename without extension. Used with --hub flag only.","default":"{slug}-api"},"dry-run":{"name":"dry-run","type":"boolean","description":"Validate a new documentation version. Does everything a normal deploy would do except publishing the new version. Useful in automated environments such as test platforms or continuous integration. Default: false","allowNo":false}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.\nPath can also be a directory when deploying to a Hub.","required":true}]},"diff":{"id":"diff","description":"Get a comparison diff with your documentation from the given file or URL.","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Compare a potential new version with the currently published one:\n\n  $ bump diff FILE --doc <your_doc_id_or_slug> --token <your_doc_token>\n  * Comparing the given definition file with the currently deployed one... done\n  Removed: GET /compare\n  Added: GET /versions/{versionId}\n","Store the diff in a dedicated file:\n\n  $ bump diff FILE --doc <doc_slug> --token <doc_token> > /tmp/my-saved-diff\n  * Comparing the given definition file with the currently deployed one... done\n\n  $ cat /tmp/my-saved-diff\n  Removed: GET /compare\n  Added: GET /versions/{versionId}\n","In case of a non modified definition FILE compared to your existing documentation, no changes are output:\n\n  $ bump diff FILE --doc <doc_slug> --token <your_doc_token>\n  * Comparing the given definition file with the currently deployed one... done\n   ›   Warning: Your documentation has not changed\n","Compare two different input files or URL independently to the one published on bump.sh\n\n  $ bump diff FILE FILE2 --doc <doc_slug> --token <your_doc_token>\n  * Comparing the two given definition files... done\n  Updated: POST /versions\n    Body attribute added: previous_version_id\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"doc":{"name":"doc","type":"option","char":"d","description":"Documentation public id or slug. Can be provided via BUMP_ID environment variable"},"hub":{"name":"hub","type":"option","char":"b","description":"Hub id or slug. Can be provided via BUMP_HUB_ID environment variable"},"branch":{"name":"branch","type":"option","char":"B","description":"Branch name. Can be provided via BUMP_BRANCH_NAME environment variable"},"token":{"name":"token","type":"option","char":"t","description":"Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable","required":false,"default":"99f52837852249b328c0a00249f846a3"},"open":{"name":"open","type":"boolean","char":"o","description":"Open the visual diff in your browser","allowNo":false},"fail-on-breaking":{"name":"fail-on-breaking","type":"boolean","char":"F","description":"Fail when diff contains a breaking change","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"Format in which to provide the diff result","options":["text","markdown","json","html"],"default":"text"},"expires":{"name":"expires","type":"option","char":"e","description":"Specify a longer expiration date for public diffs (defaults to 1 day). Use iso8601 format to provide a date, or you can use `--expires 'never'` to keep the result live indefinitely."}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.\nPath can also be a directory when deploying to a Hub.","required":true},{"name":"FILE2","description":"Path or URL to a second API documentation file to compute its diff"}]},"preview":{"id":"preview","description":"Create a documentation preview from the given file or URL.","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["$ bump preview FILE\n* Your preview is visible at: https://bump.sh/preview/45807371-9a32-48a7-b6e4-1cb7088b5b9b\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"live":{"name":"live","type":"boolean","char":"l","description":"Generate a preview each time you save the given file","allowNo":false},"open":{"name":"open","type":"boolean","char":"o","description":"Open the generated preview URL in your browser","allowNo":false}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.\nPath can also be a directory when deploying to a Hub.","required":true}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bump-cli",
   "description": "The Bump CLI is used to interact with your API documentation hosted on Bump by using the API of developers.bump.sh",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "author": "Paul Bonaud <paulr@bump.sh>",
   "bin": {
     "bump": "./bin/run"
@@ -13,8 +13,8 @@
     "@types/debug": "^4.1.5",
     "@types/mocha": "^10.0.0",
     "@types/node": "^18.11.18",
-    "@typescript-eslint/eslint-plugin": "^4.21.0",
-    "@typescript-eslint/parser": "^4.21.0",
+    "@typescript-eslint/eslint-plugin": "^5.21.0",
+    "@typescript-eslint/parser": "^5.21.0",
     "chai": "^4.3.4",
     "cross-spawn": "^7.0.3",
     "eslint": "^7.24.0",
@@ -29,7 +29,7 @@
     "sinon": "^14.0.0",
     "stdout-stderr": "^0.1.13",
     "ts-node": "^10.0.0",
-    "typescript": "^4.3.3"
+    "typescript": "4.5.5"
   },
   "engines": {
     "node": ">=14.0.0"
@@ -55,8 +55,13 @@
     "commands": "./lib/commands",
     "bin": "bump",
     "plugins": [
-      "@oclif/plugin-help"
-    ]
+      "@oclif/plugin-help",
+      "@oclif/plugin-warn-if-update-available"
+    ],
+    "warn-if-update-available": {
+      "timeoutInDays": 30,
+      "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>. Please upgrade with <%= chalk.underline.dim(`npm update ${config.name}`) %>."
+    }
   },
   "repository": "bump-sh/cli",
   "scripts": {
@@ -78,10 +83,12 @@
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.7",
     "@asyncapi/specs": "^4.0.1",
+    "@clack/prompts": "^0.6.3",
     "@oclif/command": "^1.8.16",
     "@oclif/config": "^1.17.0",
-    "@oclif/core": "^1.3.3",
+    "@oclif/core": "1.20.4",
     "@oclif/plugin-help": "^5.1.10",
+    "@oclif/plugin-warn-if-update-available": "^2.0.36",
     "async-mutex": "^0.4.0",
     "axios": "^0.27.2",
     "debug": "^4.3.1",