@asyncapi/cli 0.51.12 → 0.52.0

package/assets/create-glee-app/templates/default/package-lock.json

@@ -9,7 +9,7 @@
       "version": "0.1.0",
       "license": "Apache-2.0",
       "dependencies": {
-        "@asyncapi/glee": "^0.23.2"
+        "@asyncapi/glee": "^0.23.5"
       },
       "engines": {
         "node": ">=14.15.1"
@@ -219,13 +219,13 @@
       }
     },
     "node_modules/@asyncapi/glee": {
-      "version": "0.23.2",
-      "resolved": "https://registry.npmjs.org/@asyncapi/glee/-/glee-0.23.2.tgz",
-      "integrity": "sha512-6UDwNamtF3cPnifnkviLRlC4c0htuQWuWWz7M9lJhPfnJ6PuE7y5gxO+TT88nOVmR+Y8LzKKw0QAoFIeM95CMQ==",
+      "version": "0.23.5",
+      "resolved": "https://registry.npmjs.org/@asyncapi/glee/-/glee-0.23.5.tgz",
+      "integrity": "sha512-J5rGqGKB0OA624xnvGwqMYTa08W98yU0/aW9sdpoS13U+eJ09yrqG+01Gj2rDIHqf3ovgxarh7gfgnx184pZGg==",
       "dependencies": {
         "@asyncapi/generator": "^1.9.18",
         "@asyncapi/html-template": "^0.24.10",
-        "@asyncapi/markdown-template": "^1.3.0",
+        "@asyncapi/markdown-template": "^1.3.2",
         "@asyncapi/parser": "^1.13.1",
         "@types/jest": "^27.4.0",
         "@types/qs": "^6.9.7",
@@ -279,21 +279,21 @@
       }
     },
     "node_modules/@asyncapi/markdown-template": {
-      "version": "1.3.0",
-      "resolved": "https://registry.npmjs.org/@asyncapi/markdown-template/-/markdown-template-1.3.0.tgz",
-      "integrity": "sha512-VMtIk8Bcr2BJQWCoqkkgef0KqDfxD5sGLm/nrWoF7//c3rZsGM9hzBHMo1tur0w13Nnr59nqEK5mok8JQ9s+XA==",
+      "version": "1.3.2",
+      "resolved": "https://registry.npmjs.org/@asyncapi/markdown-template/-/markdown-template-1.3.2.tgz",
+      "integrity": "sha512-C3oKLu+v1Krvc4kciQIygoQumft829ayq20AjAcbT7sIN1f9cB7Xla/tYe1aCLE+7XMJuQrLCM2qpsx3iRI2dA==",
       "dependencies": {
         "@asyncapi/generator-filters": "^2.1.0",
         "@asyncapi/generator-react-sdk": "^0.2.23",
-        "@asyncapi/parser": "2.0.3",
+        "@asyncapi/parser": "^2.1.0",
         "openapi-sampler": "^1.3.0",
         "yaml": "^1.10.2"
       }
     },
     "node_modules/@asyncapi/markdown-template/node_modules/@asyncapi/parser": {
-      "version": "2.0.3",
-      "resolved": "https://registry.npmjs.org/@asyncapi/parser/-/parser-2.0.3.tgz",
-      "integrity": "sha512-2gtIQOaCz8sR70JFREpg6UwgUBboC/26JcAGySkXY/f1ayjcfDoNLi4LsDvmu6G21qLrGN2lI83i8iLG1AzTAw==",
+      "version": "2.1.0",
+      "resolved": "https://registry.npmjs.org/@asyncapi/parser/-/parser-2.1.0.tgz",
+      "integrity": "sha512-78jjN3eW4ZmgJEa6Ap15lofzADCeItO4wHcAY2Jod3qLB1xf1zFDZQdtm3VSHYLeLhwoC1A33bAtzEf7M5P2bg==",
       "dependencies": {
         "@asyncapi/specs": "^5.1.0",
         "@openapi-contrib/openapi-schema-to-json-schema": "~3.2.0",
@@ -11889,13 +11889,13 @@
       }
     },
     "@asyncapi/glee": {
-      "version": "0.23.2",
-      "resolved": "https://registry.npmjs.org/@asyncapi/glee/-/glee-0.23.2.tgz",
-      "integrity": "sha512-6UDwNamtF3cPnifnkviLRlC4c0htuQWuWWz7M9lJhPfnJ6PuE7y5gxO+TT88nOVmR+Y8LzKKw0QAoFIeM95CMQ==",
+      "version": "0.23.5",
+      "resolved": "https://registry.npmjs.org/@asyncapi/glee/-/glee-0.23.5.tgz",
+      "integrity": "sha512-J5rGqGKB0OA624xnvGwqMYTa08W98yU0/aW9sdpoS13U+eJ09yrqG+01Gj2rDIHqf3ovgxarh7gfgnx184pZGg==",
       "requires": {
         "@asyncapi/generator": "^1.9.18",
         "@asyncapi/html-template": "^0.24.10",
-        "@asyncapi/markdown-template": "^1.3.0",
+        "@asyncapi/markdown-template": "^1.3.2",
         "@asyncapi/parser": "^1.13.1",
         "@types/jest": "^27.4.0",
         "@types/qs": "^6.9.7",
@@ -11943,21 +11943,21 @@
       }
     },
     "@asyncapi/markdown-template": {
-      "version": "1.3.0",
-      "resolved": "https://registry.npmjs.org/@asyncapi/markdown-template/-/markdown-template-1.3.0.tgz",
-      "integrity": "sha512-VMtIk8Bcr2BJQWCoqkkgef0KqDfxD5sGLm/nrWoF7//c3rZsGM9hzBHMo1tur0w13Nnr59nqEK5mok8JQ9s+XA==",
+      "version": "1.3.2",
+      "resolved": "https://registry.npmjs.org/@asyncapi/markdown-template/-/markdown-template-1.3.2.tgz",
+      "integrity": "sha512-C3oKLu+v1Krvc4kciQIygoQumft829ayq20AjAcbT7sIN1f9cB7Xla/tYe1aCLE+7XMJuQrLCM2qpsx3iRI2dA==",
       "requires": {
         "@asyncapi/generator-filters": "^2.1.0",
         "@asyncapi/generator-react-sdk": "^0.2.23",
-        "@asyncapi/parser": "2.0.3",
+        "@asyncapi/parser": "^2.1.0",
         "openapi-sampler": "^1.3.0",
         "yaml": "^1.10.2"
       },
       "dependencies": {
         "@asyncapi/parser": {
-          "version": "2.0.3",
-          "resolved": "https://registry.npmjs.org/@asyncapi/parser/-/parser-2.0.3.tgz",
-          "integrity": "sha512-2gtIQOaCz8sR70JFREpg6UwgUBboC/26JcAGySkXY/f1ayjcfDoNLi4LsDvmu6G21qLrGN2lI83i8iLG1AzTAw==",
+          "version": "2.1.0",
+          "resolved": "https://registry.npmjs.org/@asyncapi/parser/-/parser-2.1.0.tgz",
+          "integrity": "sha512-78jjN3eW4ZmgJEa6Ap15lofzADCeItO4wHcAY2Jod3qLB1xf1zFDZQdtm3VSHYLeLhwoC1A33bAtzEf7M5P2bg==",
           "requires": {
             "@asyncapi/specs": "^5.1.0",
             "@openapi-contrib/openapi-schema-to-json-schema": "~3.2.0",

package/assets/create-glee-app/templates/default/package.json

@@ -24,6 +24,6 @@
   },
   "homepage": "https://github.com/asyncapi/glee-hello-world#readme",
   "dependencies": {
-    "@asyncapi/glee": "^0.23.2"
+    "@asyncapi/glee": "^0.23.5"
   }
 }

package/lib/commands/config/context/add.js

@@ -4,23 +4,39 @@ const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const base_1 = tslib_1.__importDefault(require("../../../base"));
 const Context_1 = require("../../../models/Context");
+const context_error_1 = require("../../../errors/context-error");
 class ContextAdd extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const { args } = yield this.parse(ContextAdd);
             const contextName = args['context-name'];
             const specFilePath = args['spec-file-path'];
-            yield (0, Context_1.addContext)(contextName, specFilePath);
-            this.log(`Added context "${contextName}".\n\nYou can set it as your current context: asyncapi config context use ${contextName}\nYou can use this context when needed by passing ${contextName} as a parameter: asyncapi validate ${contextName}`);
+            try {
+                yield (0, Context_1.addContext)(contextName, specFilePath);
+                this.log(`Added context "${contextName}".\n\nYou can set it as your current context: asyncapi config context use ${contextName}\nYou can use this context when needed by passing ${contextName} as a parameter: asyncapi validate ${contextName}`);
+            }
+            catch (e) {
+                if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
+                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
+                    return;
+                }
+                {
+                    throw e;
+                }
+            }
         });
     }
 }
 exports.default = ContextAdd;
-ContextAdd.description = 'Add or modify a context in the store';
+ContextAdd.description = 'Add a context to the store';
 ContextAdd.flags = {
-    help: core_1.Flags.help({ char: 'h' })
+    help: core_1.Flags.help({ char: 'h' }),
 };
 ContextAdd.args = [
     { name: 'context-name', description: 'context name', required: true },
-    { name: 'spec-file-path', description: 'file path of the spec file', required: true }
+    {
+        name: 'spec-file-path',
+        description: 'file path of the spec file',
+        required: true,
+    },
 ];

package/lib/commands/config/context/current.js

@@ -4,16 +4,40 @@ const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const base_1 = tslib_1.__importDefault(require("../../../base"));
 const Context_1 = require("../../../models/Context");
+const context_error_1 = require("../../../errors/context-error");
 class ContextCurrent extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            const { current, context } = yield (0, Context_1.getCurrentContext)();
-            this.log(`${current}: ${context}`);
+            let fileContent;
+            try {
+                fileContent = yield (0, Context_1.getCurrentContext)();
+            }
+            catch (e) {
+                if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
+                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
+                    return;
+                }
+                else if (e instanceof context_error_1.ContextFileEmptyError) {
+                    this.log(`Context file "${Context_1.CONTEXT_FILE_PATH}" is empty.`);
+                    return;
+                }
+                else if (e instanceof context_error_1.ContextNotFoundError ||
+                    (fileContent && !fileContent.current)) {
+                    this.log('No context is set as current. Run "asyncapi config context" to see all available options.');
+                    return;
+                }
+                {
+                    throw e;
+                }
+            }
+            if (fileContent) {
+                this.log(`${fileContent.current}: ${fileContent.context}`);
+            }
         });
     }
 }
 exports.default = ContextCurrent;
 ContextCurrent.description = 'Shows the current context that is being used';
 ContextCurrent.flags = {
-    help: core_1.Flags.help({ char: 'h' })
+    help: core_1.Flags.help({ char: 'h' }),
 };

package/lib/commands/config/context/edit.d.ts

@@ -0,0 +1,13 @@
+import Command from '../../../base';
+export default class ContextEdit extends Command {
+    static description: string;
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<void>;
+}

package/lib/commands/config/context/edit.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const base_1 = tslib_1.__importDefault(require("../../../base"));
+const Context_1 = require("../../../models/Context");
+const context_error_1 = require("../../../errors/context-error");
+class ContextEdit extends base_1.default {
+    run() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { args } = yield this.parse(ContextEdit);
+            const contextName = args['context-name'];
+            const newSpecFilePath = args['new-spec-file-path'];
+            try {
+                yield (0, Context_1.editContext)(contextName, newSpecFilePath);
+                this.log(`Edited context "${contextName}".\n\nYou can set it as your current context: asyncapi config context use ${contextName}\nYou can use this context when needed by passing ${contextName} as a parameter: asyncapi validate ${contextName}`);
+            }
+            catch (e) {
+                if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
+                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
+                    return;
+                }
+                else if (e instanceof context_error_1.ContextFileEmptyError) {
+                    this.log(`Context file "${Context_1.CONTEXT_FILE_PATH}" is empty.`);
+                    return;
+                }
+                {
+                    throw e;
+                }
+            }
+        });
+    }
+}
+exports.default = ContextEdit;
+ContextEdit.description = 'Edit a context in the store';
+ContextEdit.flags = {
+    help: core_1.Flags.help({ char: 'h' }),
+};
+ContextEdit.args = [
+    { name: 'context-name', description: 'context name', required: true },
+    {
+        name: 'new-spec-file-path',
+        description: 'new file path of the spec file',
+        required: true,
+    },
+];

package/lib/commands/config/context/index.d.ts

@@ -1,4 +1,5 @@
 import Command from '../../../base';
 export default class Context extends Command {
+    static description: string;
     run(): Promise<void>;
 }

package/lib/commands/config/context/index.js

@@ -13,3 +13,4 @@ class Context extends base_1.default {
     }
 }
 exports.default = Context;
+Context.description = 'Manage short aliases for full paths to AsyncAPI documents';

package/lib/commands/config/context/init.d.ts

@@ -0,0 +1,14 @@
+import Command from '../../../base';
+export default class ContextInit extends Command {
+    static description: string;
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    };
+    static contextFilePathMessage: string;
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<void>;
+}

package/lib/commands/config/context/init.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const base_1 = tslib_1.__importDefault(require("../../../base"));
+const Context_1 = require("../../../models/Context");
+class ContextInit extends base_1.default {
+    run() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { args } = yield this.parse(ContextInit);
+            const contextFilePath = args['context-file-path'];
+            const contextWritePath = yield (0, Context_1.initContext)(contextFilePath);
+            this.log(`Initialized context ${contextWritePath}`);
+        });
+    }
+}
+exports.default = ContextInit;
+ContextInit.description = 'Initialize context';
+ContextInit.flags = {
+    help: core_1.Flags.help({ char: 'h' }),
+};
+ContextInit.contextFilePathMessage = `Specify directory in which context file should be created:
+    - current directory          : asyncapi config context init . (default)
+    - root of current repository : asyncapi config context init ./
+    - user's home directory      : asyncapi config context init ~`;
+ContextInit.args = [
+    {
+        name: 'context-file-path',
+        description: `${ContextInit.contextFilePathMessage}`,
+        required: false,
+    },
+];

package/lib/commands/config/context/list.js

@@ -4,18 +4,36 @@ const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const base_1 = tslib_1.__importDefault(require("../../../base"));
 const Context_1 = require("../../../models/Context");
+const context_error_1 = require("../../../errors/context-error");
 class ContextList extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            const fileContent = yield (0, Context_1.loadContextFile)();
-            for (const [contextName, filePath] of Object.entries(fileContent.store)) {
-                this.log(`${contextName}: ${filePath}`);
+            try {
+                const fileContent = yield (0, Context_1.loadContextFile)();
+                if (yield (0, Context_1.isContextFileEmpty)(fileContent)) {
+                    this.log(`Context file "${Context_1.CONTEXT_FILE_PATH}" is empty.`);
+                    return;
+                }
+                if (fileContent) {
+                    for (const [contextName, filePath] of Object.entries(fileContent.store)) {
+                        this.log(`${contextName}: ${filePath}`);
+                    }
+                }
+            }
+            catch (e) {
+                if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
+                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
+                    return;
+                }
+                {
+                    throw e;
+                }
             }
         });
     }
 }
 exports.default = ContextList;
-ContextList.description = 'List all the stored context in the store';
+ContextList.description = 'List all the stored contexts in the store';
 ContextList.flags = {
-    help: core_1.Flags.help({ char: 'h' })
+    help: core_1.Flags.help({ char: 'h' }),
 };

package/lib/commands/config/context/remove.js

@@ -4,6 +4,7 @@ const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const base_1 = tslib_1.__importDefault(require("../../../base"));
 const Context_1 = require("../../../models/Context");
+const context_error_1 = require("../../../errors/context-error");
 class ContextRemove extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -13,8 +14,18 @@ class ContextRemove extends base_1.default {
                 yield (0, Context_1.removeContext)(contextName);
                 this.log(`${contextName} successfully deleted`);
             }
-            catch (err) {
-                this.error(err);
+            catch (e) {
+                if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
+                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
+                    return;
+                }
+                else if (e instanceof context_error_1.ContextFileEmptyError) {
+                    this.log(`Context file "${Context_1.CONTEXT_FILE_PATH}" is empty.`);
+                    return;
+                }
+                {
+                    throw e;
+                }
             }
         });
     }
@@ -22,8 +33,12 @@ class ContextRemove extends base_1.default {
 exports.default = ContextRemove;
 ContextRemove.description = 'Delete a context from the store';
 ContextRemove.flags = {
-    help: core_1.Flags.help({ char: 'h' })
+    help: core_1.Flags.help({ char: 'h' }),
 };
 ContextRemove.args = [
-    { name: 'context-name', description: 'Name of the context to delete', required: true }
+    {
+        name: 'context-name',
+        description: 'Name of the context to delete',
+        required: true,
+    },
 ];

package/lib/commands/config/context/use.js

@@ -4,21 +4,41 @@ const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const base_1 = tslib_1.__importDefault(require("../../../base"));
 const Context_1 = require("../../../models/Context");
+const context_error_1 = require("../../../errors/context-error");
 class ContextUse extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const { args } = yield this.parse(ContextUse);
             const contextName = args['context-name'];
-            yield (0, Context_1.setCurrentContext)(contextName);
-            this.log(`${contextName} is set as current`);
+            try {
+                yield (0, Context_1.setCurrentContext)(contextName);
+                this.log(`${contextName} is set as current`);
+            }
+            catch (e) {
+                if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
+                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
+                    return;
+                }
+                else if (e instanceof context_error_1.ContextFileEmptyError) {
+                    this.log(`Context file "${Context_1.CONTEXT_FILE_PATH}" is empty.`);
+                    return;
+                }
+                {
+                    throw e;
+                }
+            }
         });
     }
 }
 exports.default = ContextUse;
 ContextUse.description = 'Set a context as current';
 ContextUse.flags = {
-    help: core_1.Flags.help({ char: 'h' })
+    help: core_1.Flags.help({ char: 'h' }),
 };
 ContextUse.args = [
-    { name: 'context-name', description: 'name of the saved context', required: true }
+    {
+        name: 'context-name',
+        description: 'name of the saved context',
+        required: true,
+    },
 ];

package/lib/errors/context-error.d.ts

@@ -8,7 +8,19 @@ export declare class MissingContextFileError extends ContextError {
 export declare class MissingCurrentContextError extends ContextError {
     constructor();
 }
-export declare class ContextNotFound extends ContextError {
+export declare class ContextNotFoundError extends ContextError {
     constructor(contextName: string);
 }
+export declare class ContextAlreadyExistsError extends ContextError {
+    constructor(contextName: string, contextFileName: string);
+}
+export declare class ContextFileWrongFormatError extends ContextError {
+    constructor(contextFileName: string);
+}
+export declare class ContextFileEmptyError extends ContextError {
+    constructor(contextFileName: string);
+}
+export declare class ContextFileWriteError extends ContextError {
+    constructor(contextFileName: string);
+}
 export {};

package/lib/errors/context-error.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContextNotFound = exports.MissingCurrentContextError = exports.MissingContextFileError = exports.NO_CONTEXTS_SAVED = void 0;
-const CONTEXT_NOT_FOUND = (contextName) => `Context "${contextName}" does not exists.`;
-const MISSING_CURRENT_CONTEXT = 'No context is set as current, please set a current context.';
+exports.ContextFileWriteError = exports.ContextFileEmptyError = exports.ContextFileWrongFormatError = exports.ContextAlreadyExistsError = exports.ContextNotFoundError = exports.MissingCurrentContextError = exports.MissingContextFileError = exports.NO_CONTEXTS_SAVED = void 0;
 exports.NO_CONTEXTS_SAVED = `These are your options to specify in the CLI what AsyncAPI file should be used:
 	- You can provide a path to the AsyncAPI file: asyncapi <command> path/to/file/asyncapi.yml
 	- You can provide URL to the AsyncAPI file: asyncapi <command> https://example.com/path/to/file/asyncapi.yml
@@ -10,6 +8,12 @@ exports.NO_CONTEXTS_SAVED = `These are your options to specify in the CLI what A
 	- In case you did not specify a context that you want to use, the CLI checks if there is a default context and uses it. To set default context run: asyncapi config context use mycontext
 	- In case you did not provide any reference to AsyncAPI file and there is no default context, the CLI detects if in your current working directory you have files like asyncapi.json, asyncapi.yaml, asyncapi.yml. Just rename your file accordingly.
 `;
+const MISSING_CURRENT_CONTEXT = 'No context is set as current, please set a current context.';
+const CONTEXT_NOT_FOUND = (contextName) => `Context "${contextName}" does not exist.`;
+const CONTEXT_ALREADY_EXISTS = (contextName, contextFileName) => `Context with name "${contextName}" already exists in context file "${contextFileName}".`;
+const CONTEXT_FILE_WRONG_FORMAT = (contextFileName) => `Context file "${contextFileName}" has wrong format. Make sure your context file follows the structure described in section "Context File structure" at https://www.asyncapi.com/docs/tools/cli/context#context-file-structure`;
+const CONTEXT_FILE_EMPTY = (contextFileName) => `Context file "${contextFileName}" is empty.`;
+const CONTEXT_FILE_WRITE_ERROR = (contextFileName) => `Error writing context file "${contextFileName}".`;
 class ContextError extends Error {
     constructor() {
         super();
@@ -30,10 +34,38 @@ class MissingCurrentContextError extends ContextError {
     }
 }
 exports.MissingCurrentContextError = MissingCurrentContextError;
-class ContextNotFound extends ContextError {
+class ContextNotFoundError extends ContextError {
     constructor(contextName) {
         super();
         this.message = CONTEXT_NOT_FOUND(contextName);
     }
 }
-exports.ContextNotFound = ContextNotFound;
+exports.ContextNotFoundError = ContextNotFoundError;
+class ContextAlreadyExistsError extends ContextError {
+    constructor(contextName, contextFileName) {
+        super();
+        this.message = CONTEXT_ALREADY_EXISTS(contextName, contextFileName);
+    }
+}
+exports.ContextAlreadyExistsError = ContextAlreadyExistsError;
+class ContextFileWrongFormatError extends ContextError {
+    constructor(contextFileName) {
+        super();
+        this.message = CONTEXT_FILE_WRONG_FORMAT(contextFileName);
+    }
+}
+exports.ContextFileWrongFormatError = ContextFileWrongFormatError;
+class ContextFileEmptyError extends ContextError {
+    constructor(contextFileName) {
+        super();
+        this.message = CONTEXT_FILE_EMPTY(contextFileName);
+    }
+}
+exports.ContextFileEmptyError = ContextFileEmptyError;
+class ContextFileWriteError extends ContextError {
+    constructor(contextFileName) {
+        super();
+        this.message = CONTEXT_FILE_WRITE_ERROR(contextFileName);
+    }
+}
+exports.ContextFileWriteError = ContextFileWriteError;

package/lib/models/Context.d.ts

@@ -1,4 +1,5 @@
 export declare const DEFAULT_CONTEXT_FILE_PATH: string;
+export declare let CONTEXT_FILE_PATH: string;
 export interface IContextFile {
     current?: string;
     readonly store: {
@@ -9,9 +10,12 @@ export interface ICurrentContext {
     readonly current: string;
     readonly context: string;
 }
+export declare function initContext(contextFilePath: string): Promise<string>;
 export declare function loadContext(contextName?: string): Promise<string>;
 export declare function addContext(contextName: string, pathToFile: string): Promise<void>;
 export declare function removeContext(contextName: string): Promise<void>;
 export declare function getCurrentContext(): Promise<ICurrentContext>;
 export declare function setCurrentContext(contextName: string): Promise<void>;
+export declare function editContext(contextName: string, pathToFile: string): Promise<void>;
 export declare function loadContextFile(): Promise<IContextFile>;
+export declare function isContextFileEmpty(fileContent: IContextFile): Promise<boolean>;

package/lib/models/Context.js

@@ -1,28 +1,110 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadContextFile = exports.setCurrentContext = exports.getCurrentContext = exports.removeContext = exports.addContext = exports.loadContext = exports.DEFAULT_CONTEXT_FILE_PATH = void 0;
+exports.isContextFileEmpty = exports.loadContextFile = exports.editContext = exports.setCurrentContext = exports.getCurrentContext = exports.removeContext = exports.addContext = exports.loadContext = exports.initContext = exports.CONTEXT_FILE_PATH = exports.DEFAULT_CONTEXT_FILE_PATH = void 0;
 const tslib_1 = require("tslib");
 const fs_1 = require("fs");
 const path = tslib_1.__importStar(require("path"));
 const os = tslib_1.__importStar(require("os"));
 const context_error_1 = require("../errors/context-error");
 const { readFile, writeFile } = fs_1.promises;
-const CONTEXT_FILENAME = process.env.CONTEXT_FILENAME || '.asyncapi';
-exports.DEFAULT_CONTEXT_FILE_PATH = path.resolve(process.env.CONTEXT_FILE_PATH || os.homedir(), CONTEXT_FILENAME);
+// `repoRootPath` is optimistically assigned current working directory's
+// filesystem path because chances are it will become 'official' repository root
+// down the execution.
+//
+// `REPO_ROOT_PATH` will be converted to a real constant after migration of the
+// codebase to ES2022 or higher and introduction of construction
+//
+// const REPO_ROOT_PATH = await getRepoRootPath(process.cwd());
+//
+// See explanation of the situation with `CONTEXT_FILE_PATH` below.
+let REPO_ROOT_PATH = process.cwd();
+getRepoRootPath(process.cwd());
+const DEFAULT_CONTEXT_FILENAME = '.asyncapi-cli';
+const DEFAULT_CONTEXT_FILE_LOCATION = os.homedir();
+exports.DEFAULT_CONTEXT_FILE_PATH = path.resolve(DEFAULT_CONTEXT_FILE_LOCATION, DEFAULT_CONTEXT_FILENAME);
+const CONTEXT_FILENAME = process.env.CUSTOM_CONTEXT_FILENAME || DEFAULT_CONTEXT_FILENAME;
+const CONTEXT_FILE_LOCATION = process.env.CUSTOM_CONTEXT_FILE_LOCATION || DEFAULT_CONTEXT_FILE_LOCATION;
+// Usage of promises for assignment of their resolved values to constants is
+// known to be troublesome:
+// https://www.reddit.com/r/learnjavascript/comments/p7p7zw/assigning_data_from_a_promise_to_a_constant
+//
+// In this particular case and usage of ES6, there is a race condition during
+// code execution, due to faster assignment of default values to
+// `CONTEXT_FILE_PATH` than resolution of the promise. This is the cause
+// `CONTEXT_FILE_PATH` will always pick default values for context file's path
+// instead of waiting for resolution of the promise from `getContextFilePath()`.
+// The situation might become better with use of top-level await which should
+// pause code execution, until promise in construction
+//
+// const CONTEXT_FILE_PATH = await getContextFilePath() || path.resolve(CONTEXT_FILE_LOCATION, CONTEXT_FILENAME) || DEFAULT_CONTEXT_FILE_PATH;
+//
+// is resolved, but for this to be checked, all codebase (including
+// `@oclif/core`) needs to be migrated to ES2022 or higher.
+//
+// Until then `CONTEXT_FILE_PATH` name is mimicking a `const` while right now it
+// is a `let` reassigned inside of `getContextFilePath()`.
+exports.CONTEXT_FILE_PATH = path.resolve(CONTEXT_FILE_LOCATION, CONTEXT_FILENAME) ||
+    exports.DEFAULT_CONTEXT_FILE_PATH;
+// Sonar recognizes next line as a bug `Promises must be awaited, end with a
+// call to .catch, or end with a call to .then with a rejection handler.` but
+// due to absence of top-level await in ES6, this bug cannot be fixed without
+// migrating the codebase to ES2022 or higher, thus suppressing Sonar analysis
+// for this line.
+getContextFilePath(); // NOSONAR
+function initContext(contextFilePath) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const fileContent = {
+            store: {},
+        };
+        let contextWritePath = '';
+        // prettier-ignore
+        switch (contextFilePath) {
+            /* eslint-disable indent */
+            case '.':
+                contextWritePath = process.cwd() + path.sep + CONTEXT_FILENAME;
+                break;
+            case './':
+                contextWritePath = REPO_ROOT_PATH + path.sep + CONTEXT_FILENAME;
+                break;
+            // There are two variants of `~` case because tilde expansion in UNIX
+            // systems is not a guaranteed feature - sometimes `~` can return just `~`
+            // instead of home directory path.
+            // https://stackoverflow.com/questions/491877/how-to-find-a-users-home-directory-on-linux-or-unix#comment17161699_492669
+            case os.homedir():
+                contextWritePath = os.homedir() + path.sep + CONTEXT_FILENAME;
+                break;
+            case '~':
+                contextWritePath = os.homedir() + path.sep + CONTEXT_FILENAME;
+                break;
+            default:
+                contextWritePath = process.cwd() + path.sep + CONTEXT_FILENAME;
+        }
+        try {
+            yield writeFile(contextWritePath, JSON.stringify(fileContent), {
+                encoding: 'utf8',
+            });
+        }
+        catch (e) {
+            throw new context_error_1.ContextFileWriteError(contextWritePath);
+        }
+        return contextWritePath;
+    });
+}
+exports.initContext = initContext;
 function loadContext(contextName) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const fileContent = yield loadContextFile();
         if (contextName) {
             const context = fileContent.store[String(contextName)];
             if (!context) {
-                throw new context_error_1.ContextNotFound(contextName);
+                throw new context_error_1.ContextNotFoundError(contextName);
             }
             return context;
         }
         else if (fileContent.current) {
             const context = fileContent.store[fileContent.current];
             if (!context) {
-                throw new context_error_1.ContextNotFound(fileContent.current);
+                throw new context_error_1.ContextNotFoundError(fileContent.current);
             }
             return context;
         }
@@ -32,23 +114,14 @@ function loadContext(contextName) {
 exports.loadContext = loadContext;
 function addContext(contextName, pathToFile) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        let fileContent;
-        try {
-            fileContent = yield loadContextFile();
-        }
-        catch (err) {
-            if (err instanceof context_error_1.MissingContextFileError) {
-                fileContent = {
-                    store: {
-                        [contextName]: pathToFile,
-                    }
-                };
-            }
-            else {
-                throw err;
-            }
+        const fileContent = yield loadContextFile();
+        // If context file already has context name similar to the one specified as
+        // an argument, notify user about it (throw `ContextAlreadyExistsError`
+        // error) and exit.
+        if (fileContent.store.hasOwnProperty.call(fileContent.store, contextName)) {
+            throw new context_error_1.ContextAlreadyExistsError(contextName, exports.CONTEXT_FILE_PATH);
         }
-        fileContent.store[String(contextName)] = pathToFile;
+        fileContent.store[String(contextName)] = String(pathToFile);
         yield saveContextFile(fileContent);
     });
 }
@@ -56,8 +129,11 @@ exports.addContext = addContext;
 function removeContext(contextName) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const fileContent = yield loadContextFile();
+        if (yield isContextFileEmpty(fileContent)) {
+            throw new context_error_1.ContextFileEmptyError(exports.CONTEXT_FILE_PATH);
+        }
         if (!fileContent.store[String(contextName)]) {
-            throw new context_error_1.ContextNotFound(contextName);
+            throw new context_error_1.ContextNotFoundError(contextName);
         }
         if (fileContent.current === contextName) {
             delete fileContent.current;
@@ -70,6 +146,9 @@ exports.removeContext = removeContext;
 function getCurrentContext() {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const fileContent = yield loadContextFile();
+        if (yield isContextFileEmpty(fileContent)) {
+            throw new context_error_1.ContextFileEmptyError(exports.CONTEXT_FILE_PATH);
+        }
         const context = yield loadContext();
         return {
             current: fileContent.current,
@@ -81,36 +160,162 @@ exports.getCurrentContext = getCurrentContext;
 function setCurrentContext(contextName) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const fileContent = yield loadContextFile();
+        if (yield isContextFileEmpty(fileContent)) {
+            throw new context_error_1.ContextFileEmptyError(exports.CONTEXT_FILE_PATH);
+        }
         if (!fileContent.store[String(contextName)]) {
-            throw new context_error_1.ContextNotFound(contextName);
+            throw new context_error_1.ContextNotFoundError(contextName);
         }
-        fileContent.current = contextName;
+        fileContent.current = String(contextName);
         yield saveContextFile(fileContent);
     });
 }
 exports.setCurrentContext = setCurrentContext;
+function editContext(contextName, pathToFile) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        // The expression is not wrapped in a `try...catch` block and is allowed to
+        // throw automatically because it is assumed that `loadContextFile()` works
+        // with a 100%-existing valid file in this case, thus if it threw anyway -
+        // some REAL error happened and user should know about it.
+        const fileContent = yield loadContextFile();
+        if (yield isContextFileEmpty(fileContent)) {
+            throw new context_error_1.ContextFileEmptyError(exports.CONTEXT_FILE_PATH);
+        }
+        fileContent.store[String(contextName)] = String(pathToFile);
+        yield saveContextFile(fileContent);
+    });
+}
+exports.editContext = editContext;
 function loadContextFile() {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        let fileContent;
+        // If the context file cannot be read then it's a 'MissingContextFileError'
+        // error.
         try {
-            return JSON.parse(yield readFile(exports.DEFAULT_CONTEXT_FILE_PATH, { encoding: 'utf8' }));
+            yield readFile(exports.CONTEXT_FILE_PATH, { encoding: 'utf8' });
         }
         catch (e) {
             throw new context_error_1.MissingContextFileError();
         }
+        // If the context file cannot be parsed then it's a
+        // 'ContextFileWrongFormatError' error.
+        try {
+            fileContent = JSON.parse(yield readFile(exports.CONTEXT_FILE_PATH, { encoding: 'utf8' }));
+        }
+        catch (e) {
+            // https://stackoverflow.com/questions/29797946/handling-bad-json-parse-in-node-safely
+            throw new context_error_1.ContextFileWrongFormatError(exports.CONTEXT_FILE_PATH);
+        }
+        // If the context file cannot be validated then it's a
+        // 'ContextFileWrongFormatError' error.
+        if (!(yield isContextFileValid(fileContent))) {
+            throw new context_error_1.ContextFileWrongFormatError(exports.CONTEXT_FILE_PATH);
+        }
+        return fileContent;
     });
 }
 exports.loadContextFile = loadContextFile;
 function saveContextFile(fileContent) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         try {
-            writeFile(exports.DEFAULT_CONTEXT_FILE_PATH, JSON.stringify({
+            yield writeFile(exports.CONTEXT_FILE_PATH, JSON.stringify({
                 current: fileContent.current,
-                store: fileContent.store
+                store: fileContent.store,
             }), { encoding: 'utf8' });
-            return fileContent;
         }
-        catch (error) {
-            return;
+        catch (e) {
+            throw new context_error_1.ContextFileWriteError(exports.CONTEXT_FILE_PATH);
+        }
+    });
+}
+function getRepoRootPath(repoRootPath) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        // Asynchronous `fs.exists()` is deprecated, asynchronous `fs.stat()`
+        // introduces race condition, thus synchronous functions are used.
+        let pathToCheck = `${repoRootPath}${path.sep}.git`;
+        // If directory where `init` was requested in, happens to contain `.git`
+        // directory, then it surely is a root of repository, no need to search
+        // further and `REPO_ROOT_PATH` will remain as it was.
+        if ((0, fs_1.existsSync)(pathToCheck) && (0, fs_1.lstatSync)(pathToCheck).isDirectory()) {
+            return null;
+        }
+        // Directory where `init` was requested in, did not happen to contain `.git`
+        // directory, so preparation for iterating through array of filesystem paths
+        // is started.
+        const repoRootPathArray = repoRootPath.split(path.sep);
+        // Last element in array is thrown away because it is already known that it
+        // does not contain directory `.git`.
+        repoRootPathArray.pop();
+        // Backwards search of the array of filesystem paths will now be performed.
+        let i = repoRootPathArray.length - 1;
+        while (i > 0) {
+            pathToCheck = `${repoRootPathArray.join(path.sep)}${path.sep}.git`;
+            if ((0, fs_1.existsSync)(pathToCheck) && (0, fs_1.lstatSync)(pathToCheck).isDirectory()) {
+                REPO_ROOT_PATH = repoRootPathArray.join(path.sep);
+                return REPO_ROOT_PATH;
+            }
+            // Last (`0th`) element is an empty string, so if directory `.git` was not
+            // found on 1st element (last actual directory in filesystem), the search
+            // does not need to continue and `REPO_ROOT_PATH` will remain having the
+            // value of current (where `init` was requested in) directory.
+            if (i === 1) {
+                return null;
+            }
+            repoRootPathArray.pop();
+            i--;
+        }
+        return null;
+    });
+}
+function getContextFilePath() {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const currentPath = process
+            .cwd()
+            .slice(REPO_ROOT_PATH.length + 1)
+            .split(path.sep);
+        currentPath.unshift(REPO_ROOT_PATH);
+        for (let i = currentPath.length; i >= 0; i--) {
+            const currentPathString = currentPath[0]
+                ? currentPath.join(path.sep) + path.sep + CONTEXT_FILENAME
+                : os.homedir() + path.sep + CONTEXT_FILENAME;
+            // This `try...catch` is a part of `for` loop and is used only to swallow
+            // errors if the file does not exist or cannot be read, to continue
+            // uninterrupted execution of the loop.
+            try {
+                // If a file is found which can be read and passed validation as a
+                // legitimate context file, then it is considered a legitimate context
+                // file indeed.
+                const fileContent = JSON.parse(yield readFile(currentPathString, {
+                    encoding: 'utf8',
+                }));
+                if (fileContent &&
+                    (yield isContextFileValid(fileContent))) {
+                    exports.CONTEXT_FILE_PATH = currentPathString;
+                    return exports.CONTEXT_FILE_PATH;
+                }
+            }
+            catch (e) { } // eslint-disable-line
+            currentPath.pop();
         }
+        return null;
+    });
+}
+function isContextFileValid(fileContent) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        // Validation of context file's format against interface `IContextFile`.
+        return ([1, 2].includes(Object.keys(fileContent).length) &&
+            fileContent.hasOwnProperty.call(fileContent, 'store') &&
+            !Array.from(Object.keys(fileContent.store)).find((elem) => typeof elem !== 'string') &&
+            !Array.from(Object.values(fileContent.store)).find((elem) => typeof elem !== 'string'));
+    });
+}
+function isContextFileEmpty(fileContent) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        // If context file contains only one empty property `store` then the whole
+        // context file is considered empty.
+        return (fileContent &&
+            Object.keys(fileContent).length === 1 &&
+            Object.keys(fileContent.store).length === 0);
     });
 }
+exports.isContextFileEmpty = isContextFileEmpty;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.51.12",
+  "version": "0.52.0",
   "commands": {
     "bundle": {
       "id": "bundle",
@@ -914,7 +914,7 @@
     },
     "config:context:add": {
       "id": "config:context:add",
-      "description": "Add or modify a context in the store",
+      "description": "Add a context to the store",
       "strict": true,
       "pluginName": "@asyncapi/cli",
       "pluginAlias": "@asyncapi/cli",
@@ -961,8 +961,39 @@
       },
       "args": {}
     },
+    "config:context:edit": {
+      "id": "config:context:edit",
+      "description": "Edit a context in the store",
+      "strict": true,
+      "pluginName": "@asyncapi/cli",
+      "pluginAlias": "@asyncapi/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "context-name": {
+          "name": "context-name",
+          "description": "context name",
+          "required": true
+        },
+        "new-spec-file-path": {
+          "name": "new-spec-file-path",
+          "description": "new file path of the spec file",
+          "required": true
+        }
+      }
+    },
     "config:context": {
       "id": "config:context",
+      "description": "Manage short aliases for full paths to AsyncAPI documents",
       "strict": true,
       "pluginName": "@asyncapi/cli",
       "pluginAlias": "@asyncapi/cli",
@@ -971,9 +1002,35 @@
       "flags": {},
       "args": {}
     },
+    "config:context:init": {
+      "id": "config:context:init",
+      "description": "Initialize context",
+      "strict": true,
+      "pluginName": "@asyncapi/cli",
+      "pluginAlias": "@asyncapi/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "context-file-path": {
+          "name": "context-file-path",
+          "description": "Specify directory in which context file should be created:\n    - current directory          : asyncapi config context init . (default)\n    - root of current repository : asyncapi config context init ./\n    - user's home directory      : asyncapi config context init ~",
+          "required": false
+        }
+      },
+      "contextFilePathMessage": "Specify directory in which context file should be created:\n    - current directory          : asyncapi config context init . (default)\n    - root of current repository : asyncapi config context init ./\n    - user's home directory      : asyncapi config context init ~"
+    },
     "config:context:list": {
       "id": "config:context:list",
-      "description": "List all the stored context in the store",
+      "description": "List all the stored contexts in the store",
       "strict": true,
       "pluginName": "@asyncapi/cli",
       "pluginAlias": "@asyncapi/cli",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "0.51.12",
+  "version": "0.52.0",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run"
@@ -150,7 +150,7 @@
     "release": "semantic-release",
     "pretest": "npm run build",
     "test": "npm run test:unit",
-    "test:unit": "cross-env NODE_ENV=development TEST=1 CONTEXT_FILENAME=\"./test.asyncapi\" CONTEXT_FILE_PATH=\"./\" jest --coverage -i",
+    "test:unit": "cross-env NODE_ENV=development TEST=1 CUSTOM_CONTEXT_FILENAME=\"test.asyncapi-cli\" CUSTOM_CONTEXT_FILE_LOCATION=\"\" jest --coverage -i",
     "get-version": "echo $npm_package_version"
   },
   "types": "lib/index.d.ts"