bump-cli 2.9.3 → 2.9.4

package/README.md

@@ -88,7 +88,7 @@ $ bump --help
 The Bump.sh CLI is used to interact with your API documentation hosted on Bump.sh by using the API of developers.bump.sh
 
 VERSION
-  bump-cli/2.9.2 linux-x64 node-v20.18.1
+  bump-cli/2.9.3 linux-x64 node-v20.18.1
 
 USAGE
   $ bump [COMMAND]
@@ -325,12 +325,37 @@ Make sure to have Node.js (At least v20) installed on your machine.
   ```
 
 - Run the test suites
-  
+
   ```shell
   npm run test
   npm run test-coverage # Run tests with coverage
   ```
 
+### Use package in local environment
+
+You can run the package by executing the file `bin/run.js` locally:
+
+  ```shell
+  bin/run.js
+  ```
+
+For example to generate a preview:
+
+  ```shell
+  ./bin/run.js preview path/to/file.json
+  > Your preview is visible at: https://bump.sh/preview/42
+  ```
+
+Please note that even if CLI is running locally, by default requests are sent to [Bump.sh API](https://developers.bump.sh/).
+
+If you have a local version of the Bump.sh API, you can run CLI 100% in local environment
+by setting the environment variable `BUMP_HOST`:
+
+  ```shell
+  BUMP_HOST="http://localhost:3000" ./bin/run.js preview path/to/file.json
+  > Your preview is visible at: http://localhost:3000/preview/42
+  ```
+
 ## License
 
 The Bump CLI project is released under the [MIT License](http://opensource.org/licenses/MIT).

package/dist/core/diff.js

@@ -1,6 +1,7 @@
 import { Config } from '@oclif/core';
 import { CLIError } from '@oclif/core/errors';
 import debug from 'debug';
+import { resolve } from 'node:path';
 import { BumpApi } from '../api/index.js';
 import { API } from '../definition.js';
 export class Diff {
@@ -99,7 +100,7 @@ export class Diff {
     }
     async run(file1, file2, documentation, hub, branch, token, format, expires) {
         if (!this._config)
-            this._config = await Config.load('../../');
+            this._config = await Config.load(resolve(import.meta.dirname, './../../'));
         let diffVersion;
         if (file2 && (!documentation || !token)) {
             diffVersion = await this.createDiff(file1, file2, expires);

package/dist/core/overlay.js

@@ -39,7 +39,7 @@ export class Overlay {
                 for (const path of paths) {
                     // The 'executeAction' will mutate the passed spec object in
                     // place.
-                    this.executeAction(spec, action, path);
+                    spec = this.executeAction(spec, action, path);
                 }
             }
         }
@@ -74,11 +74,12 @@ export class Overlay {
             this.remove(parent, thingToActUpon);
         }
         else if (Object.hasOwn(action, 'update')) {
-            this.update(spec, parent, action.update, thingToActUpon);
+            spec = this.update(spec, parent, action.update, thingToActUpon);
         }
         else {
             process.stderr.write(`WARNING: ${this.humanName(action)} needs either a 'remove' or an 'update' property\n`);
         }
+        return spec;
     }
     humanName(action) {
         return action.description ? `Action '${action.description}'` : 'Action';
@@ -101,7 +102,7 @@ export class Overlay {
                 // the given update with the whole spec.
                 spec = merger(spec, update);
             }
-            else if (property_or_index) {
+            else if (property_or_index !== undefined) {
                 const targetObject = parent[property_or_index];
                 if (typeof targetObject === 'object' && typeof update === 'object') {
                     parent[property_or_index] =
@@ -117,5 +118,6 @@ export class Overlay {
         catch (error) {
             process.stderr.write(`Error applying overlay: ${error.message}\n`);
         }
+        return spec;
     }
 }

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

@@ -3,7 +3,7 @@ type FileDescription = {
     label: string;
     value: string;
 };
-export declare const isDir: (path: string) => boolean;
+export declare const isDir: (path_or_url: string) => boolean;
 export declare class File {
     protected static readonly supportedFormats: string[];
     static listInvalidConventionFiles(path: string, regex: RegExp): FileDescription[];

package/dist/core/utils/file.js

@@ -1,8 +1,24 @@
+import { CLIError } from '@oclif/core/errors';
 import { readdirSync, statSync } from 'node:fs';
 import { basename, extname } from 'node:path';
-export const isDir = (path) => {
+export const isDir = (path_or_url) => {
+    if (isHttpUrl(path_or_url)) {
+        return false;
+    }
+    try {
+        return statSync(path_or_url).isDirectory();
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            throw new CLIError(error);
+        }
+        return false;
+    }
+};
+const isHttpUrl = (path) => {
     try {
-        return statSync(path).isDirectory();
+        const url = new URL(path);
+        return ['http:', 'https:'].includes(url.protocol);
     }
     catch {
         return false;

package/oclif.manifest.json

@@ -97,6 +97,7 @@
           "description": "Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable",
           "name": "token",
           "required": true,
+          "default": "99f52837852249b328c0a00249f846a3",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -190,6 +191,7 @@
           "description": "Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable",
           "name": "token",
           "required": false,
+          "default": "99f52837852249b328c0a00249f846a3",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -277,5 +279,5 @@
       "strict": true
     }
   },
-  "version": "2.9.3"
+  "version": "2.9.4"
 }

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.sh by using the API of developers.bump.sh",
-  "version": "2.9.3",
+  "version": "2.9.4",
   "author": "Paul Bonaud <paulr@bump.sh>",
   "bin": {
     "bump": "./bin/run.js"