@asyncapi/cli 0.16.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/lib/commands/convert.d.ts +15 -0
- package/lib/commands/convert.js +64 -0
- package/oclif.manifest.json +1 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -23,6 +23,14 @@
|
|
|
23
23
|
|
|
24
24
|
<!-- toc -->
|
|
25
25
|
|
|
26
|
+
- [Requirements](#requirements)
|
|
27
|
+
* [Installation](#installation)
|
|
28
|
+
- [Usage](#usage)
|
|
29
|
+
- [Contributing](#contributing)
|
|
30
|
+
* [Set up development environment](#set-up-development-environment)
|
|
31
|
+
* [Command Structure and Patterns](#command-structure-and-patterns)
|
|
32
|
+
- [Contributors](#contributors)
|
|
33
|
+
|
|
26
34
|
<!-- tocstop -->
|
|
27
35
|
|
|
28
36
|
## Requirements
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import Command from '../base';
|
|
2
|
+
export default class Convert extends Command {
|
|
3
|
+
static description: string;
|
|
4
|
+
static flags: {
|
|
5
|
+
help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
|
|
6
|
+
output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
|
|
7
|
+
'target-version': import("@oclif/core/lib/interfaces").OptionFlag<string>;
|
|
8
|
+
};
|
|
9
|
+
static args: {
|
|
10
|
+
name: string;
|
|
11
|
+
description: string;
|
|
12
|
+
required: boolean;
|
|
13
|
+
}[];
|
|
14
|
+
run(): Promise<void>;
|
|
15
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const tslib_1 = require("tslib");
|
|
4
|
+
/* eslint-disable @typescript-eslint/ban-ts-comment */
|
|
5
|
+
const fs_1 = require("fs");
|
|
6
|
+
const core_1 = require("@oclif/core");
|
|
7
|
+
const base_1 = (0, tslib_1.__importDefault)(require("../base"));
|
|
8
|
+
const validation_error_1 = require("../errors/validation-error");
|
|
9
|
+
const SpecificationFile_1 = require("../models/SpecificationFile");
|
|
10
|
+
const specification_file_1 = require("../errors/specification-file");
|
|
11
|
+
// @ts-ignore
|
|
12
|
+
const converter_1 = require("@asyncapi/converter");
|
|
13
|
+
// @ts-ignore
|
|
14
|
+
const specs_1 = (0, tslib_1.__importDefault)(require("@asyncapi/specs"));
|
|
15
|
+
const latestVersion = Object.keys(specs_1.default).pop();
|
|
16
|
+
class Convert extends base_1.default {
|
|
17
|
+
async run() {
|
|
18
|
+
const { args, flags } = await this.parse(Convert);
|
|
19
|
+
const filePath = args['spec-file'];
|
|
20
|
+
let specFile;
|
|
21
|
+
let convertedFile;
|
|
22
|
+
try {
|
|
23
|
+
// LOAD FILE
|
|
24
|
+
specFile = await (0, SpecificationFile_1.load)(filePath);
|
|
25
|
+
// CONVERSION
|
|
26
|
+
convertedFile = await (0, converter_1.convert)(specFile.text(), flags['target-version'], {});
|
|
27
|
+
if (convertedFile) {
|
|
28
|
+
if (specFile.getFilePath()) {
|
|
29
|
+
this.log(`File ${specFile.getFilePath()} successfully converted!`);
|
|
30
|
+
}
|
|
31
|
+
else if (specFile.getFileURL()) {
|
|
32
|
+
this.log(`URL ${specFile.getFileURL()} successfully converted!`);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
if (flags.output) {
|
|
36
|
+
await fs_1.promises.writeFile(`${flags.output}`, convertedFile, { encoding: 'utf8' });
|
|
37
|
+
}
|
|
38
|
+
else {
|
|
39
|
+
this.log(convertedFile);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
catch (err) {
|
|
43
|
+
if (err instanceof specification_file_1.SpecificationFileNotFound) {
|
|
44
|
+
this.error(new validation_error_1.ValidationError({
|
|
45
|
+
type: 'invalid-file',
|
|
46
|
+
filepath: filePath
|
|
47
|
+
}));
|
|
48
|
+
}
|
|
49
|
+
else {
|
|
50
|
+
this.error(err);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
exports.default = Convert;
|
|
56
|
+
Convert.description = 'convert asyncapi documents older to newer versions';
|
|
57
|
+
Convert.flags = {
|
|
58
|
+
help: core_1.Flags.help({ char: 'h' }),
|
|
59
|
+
output: core_1.Flags.string({ char: 'o', description: 'path to the file where the result is saved' }),
|
|
60
|
+
'target-version': core_1.Flags.string({ char: 't', description: 'asyncapi version to convert to', default: latestVersion })
|
|
61
|
+
};
|
|
62
|
+
Convert.args = [
|
|
63
|
+
{ name: 'spec-file', description: 'spec path, url, or context-name', required: false },
|
|
64
|
+
];
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"0.
|
|
1
|
+
{"version":"0.17.0","commands":{"convert":{"id":"convert","description":"convert asyncapi documents older to newer versions","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},"output":{"name":"output","type":"option","char":"o","description":"path to the file where the result is saved","multiple":false},"target-version":{"name":"target-version","type":"option","char":"t","description":"asyncapi version to convert to","multiple":false,"default":"2.3.0"}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}],"_globalFlags":{}},"diff":{"id":"diff","description":"find diff between two asyncapi files","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},"format":{"name":"format","type":"option","char":"f","description":"format of the output","multiple":false,"options":["json"],"default":"json"},"type":{"name":"type","type":"option","char":"t","description":"type of the output","multiple":false,"options":["breaking","non-breaking","unclassified","all"],"default":"all"},"overrides":{"name":"overrides","type":"option","char":"o","description":"path to JSON file containing the override properties","multiple":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Enable watch mode","allowNo":false}},"args":[{"name":"old","description":"old spec path, URL or context-name","required":true},{"name":"new","description":"new spec path, URL or context-name","required":true}],"_globalFlags":{}},"new":{"id":"new","description":"creates a new asyncapi file","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},"file-name":{"name":"file-name","type":"option","char":"n","description":"name of the file","multiple":false},"example":{"name":"example","type":"option","char":"e","description":"name of the example to use","multiple":false},"studio":{"name":"studio","type":"boolean","char":"s","description":"open in Studio","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio","multiple":false},"no-tty":{"name":"no-tty","type":"boolean","description":"do not use an interactive terminal","allowNo":false}},"args":[],"_globalFlags":{}},"validate":{"id":"validate","description":"validate asyncapi file","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},"watch":{"name":"watch","type":"boolean","char":"w","description":"Enable watch mode","allowNo":false}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}],"_globalFlags":{}},"config":{"id":"config","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"start":{"id":"start","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"start:studio":{"id":"start:studio","description":"starts a new local instance of Studio","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},"file":{"name":"file","type":"option","char":"f","description":"path to the AsyncAPI file to link with Studio","multiple":false},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio","multiple":false}},"args":[],"_globalFlags":{}},"config:context:add":{"id":"config:context:add","description":"Add or modify 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":[{"name":"context-name","description":"context name","required":true},{"name":"spec-file-path","description":"file path of the spec file","required":true}],"_globalFlags":{}},"config:context:current":{"id":"config:context:current","description":"Shows the current context that is being used","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":[],"_globalFlags":{}},"config:context":{"id":"config:context","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"config:context:list":{"id":"config:context:list","description":"List all the stored 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":[],"_globalFlags":{}},"config:context:remove":{"id":"config:context:remove","description":"Delete a context from 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":[{"name":"context-name","description":"Name of the context to delete","required":true}],"_globalFlags":{}},"config:context:use":{"id":"config:context:use","description":"Set a context as current","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":[{"name":"context-name","description":"name of the saved context","required":true}],"_globalFlags":{}}}}
|
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@asyncapi/cli",
|
|
3
3
|
"description": "All in one CLI for all AsyncAPI tools",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.17.0",
|
|
5
5
|
"author": "@asyncapi",
|
|
6
6
|
"bin": {
|
|
7
7
|
"asyncapi": "./bin/run"
|
|
8
8
|
},
|
|
9
9
|
"bugs": "https://github.com/asyncapi/cli/issues",
|
|
10
10
|
"dependencies": {
|
|
11
|
+
"@asyncapi/converter": "^0.9.0",
|
|
11
12
|
"@asyncapi/diff": "^0.3.0",
|
|
12
13
|
"@asyncapi/parser": "^1.14.0",
|
|
13
14
|
"@asyncapi/studio": "^0.10.0",
|