From 9b5332f8c1d93602899bfdba51cb58facfd03301 Mon Sep 17 00:00:00 2001 From: asyncapi-bot Date: Tue, 14 May 2024 15:46:20 +0200 Subject: [PATCH] chore(release): v1.13.0 (#1423) --- docs/usage.md | 61 +++++++++++++++++++++++++---------------------- package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 35 insertions(+), 32 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index d0f24dc7447..f809643cb1b 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -27,7 +27,7 @@ $ npm install -g @asyncapi/cli $ asyncapi COMMAND running command... $ asyncapi (--version) -@asyncapi/cli/1.12.2 linux-x64 node-v18.20.2 +@asyncapi/cli/1.12.3 linux-x64 node-v18.20.2 $ asyncapi --help [COMMAND] USAGE $ asyncapi COMMAND @@ -96,7 +96,7 @@ EXAMPLES $ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service ``` -_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/bundle.ts)_ +_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/bundle.ts)_ ## `asyncapi config` @@ -110,7 +110,7 @@ DESCRIPTION CLI config settings ``` -_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/index.ts)_ +_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/index.ts)_ ## `asyncapi config analytics` @@ -130,7 +130,7 @@ DESCRIPTION Enable or disable analytics for metrics collection ``` -_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/analytics.ts)_ +_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/analytics.ts)_ ## `asyncapi config context` @@ -144,7 +144,7 @@ DESCRIPTION Manage short aliases for full paths to AsyncAPI documents ``` -_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/index.ts)_ +_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/context/index.ts)_ ## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH` @@ -166,7 +166,7 @@ DESCRIPTION Add a context to the store ``` -_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/add.ts)_ +_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/context/add.ts)_ ## `asyncapi config context current` @@ -183,7 +183,7 @@ DESCRIPTION Shows the current context that is being used ``` -_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/current.ts)_ +_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/context/current.ts)_ ## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH` @@ -204,7 +204,7 @@ DESCRIPTION Edit a context in the store ``` -_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/edit.ts)_ +_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/context/edit.ts)_ ## `asyncapi config context init [CONTEXT-FILE-PATH]` @@ -227,7 +227,7 @@ DESCRIPTION Initialize context ``` -_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/init.ts)_ +_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/context/init.ts)_ ## `asyncapi config context list` @@ -244,7 +244,7 @@ DESCRIPTION List all the stored contexts in the store ``` -_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/list.ts)_ +_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/context/list.ts)_ ## `asyncapi config context remove CONTEXT-NAME` @@ -264,7 +264,7 @@ DESCRIPTION Delete a context from the store ``` -_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/remove.ts)_ +_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/context/remove.ts)_ ## `asyncapi config context use CONTEXT-NAME` @@ -284,7 +284,7 @@ DESCRIPTION Set a context as current ``` -_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/use.ts)_ +_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/context/use.ts)_ ## `asyncapi config versions` @@ -301,7 +301,7 @@ DESCRIPTION Show versions of AsyncAPI tools used ``` -_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/versions.ts)_ +_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/config/versions.ts)_ ## `asyncapi convert [SPEC-FILE]` @@ -323,7 +323,7 @@ DESCRIPTION Convert asyncapi documents older to newer versions ``` -_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/convert.ts)_ +_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/convert.ts)_ ## `asyncapi diff OLD NEW` @@ -378,7 +378,7 @@ DESCRIPTION Find diff between two asyncapi files ``` -_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/diff.ts)_ +_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/diff.ts)_ ## `asyncapi generate` @@ -392,7 +392,7 @@ DESCRIPTION Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates. ``` -_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/generate/index.ts)_ +_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/generate/index.ts)_ ## `asyncapi generate fromTemplate [ASYNCAPI] [TEMPLATE]` @@ -401,7 +401,8 @@ Generates whatever you want using templates compatible with AsyncAPI Generator. ``` USAGE $ asyncapi generate fromTemplate [ASYNCAPI] [TEMPLATE] [-h] [-d ] [--no-interactive] [-i] [--debug] [-n ] - [-o ] [--force-write] [-w] [-p ] [--map-base-url ] + [-o ] [--force-write] [-w] [-p ] [--map-base-url ] [--registry-url ] [--registry-auth + ] [--registry-token ] ARGUMENTS ASYNCAPI - Local path, url or context-name pointing to AsyncAPI file @@ -422,9 +423,11 @@ FLAGS unstaged files or not empty dir (defaults to false) --map-base-url= Maps all schema references from base url to local folder --no-interactive Disable interactive mode and run with the provided flags. - --registry-url Specifies the URL of the private registry for fetching templates and dependencies - --registry-auth The registry username and password encoded with base64, formatted as username:password - --registry-token The npm registry authentication token, that can be passed instead of base64 encoded username and password + --registry-auth= The registry username and password encoded with base64, formatted as username:password + --registry-token= The npm registry authentication token, that can be passed instead of base64 encoded + username and password + --registry-url= [default: https://registry.npmjs.org] Specifies the URL of the private registry for + fetching templates and dependencies DESCRIPTION Generates whatever you want using templates compatible with AsyncAPI Generator. @@ -433,7 +436,7 @@ EXAMPLES $ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write ``` -_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/generate/fromTemplate.ts)_ +_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/generate/fromTemplate.ts)_ ## `asyncapi generate models [LANGUAGE] [FILE]` @@ -519,7 +522,7 @@ DESCRIPTION Generates typed models ``` -_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/generate/models.ts)_ +_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/generate/models.ts)_ ## `asyncapi new` @@ -576,7 +579,7 @@ EXAMPLES $ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode ``` -_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/new/index.ts)_ +_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/new/index.ts)_ ## `asyncapi new file` @@ -633,7 +636,7 @@ EXAMPLES $ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode ``` -_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/new/file.ts)_ +_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/new/file.ts)_ ## `asyncapi new glee` @@ -655,7 +658,7 @@ DESCRIPTION Creates a new Glee project ``` -_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/new/glee.ts)_ +_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/new/glee.ts)_ ## `asyncapi optimize [SPEC-FILE]` @@ -693,7 +696,7 @@ EXAMPLES $ asyncapi optimize ./asyncapi.yaml --optimization=remove-components --output=terminal --no-tty ``` -_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/optimize.ts)_ +_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/optimize.ts)_ ## `asyncapi start` @@ -707,7 +710,7 @@ DESCRIPTION Start asyncapi studio ``` -_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/start/index.ts)_ +_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/start/index.ts)_ ## `asyncapi start studio` @@ -726,7 +729,7 @@ DESCRIPTION starts a new local instance of Studio ``` -_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/start/studio.ts)_ +_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/start/studio.ts)_ ## `asyncapi validate [SPEC-FILE]` @@ -753,5 +756,5 @@ DESCRIPTION validate asyncapi file ``` -_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/validate.ts)_ +_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v1.12.3/src/commands/validate.ts)_ diff --git a/package-lock.json b/package-lock.json index 6b393eb3154..f693913d867 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@asyncapi/cli", - "version": "1.12.3", + "version": "1.13.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@asyncapi/cli", - "version": "1.12.3", + "version": "1.13.0", "license": "Apache-2.0", "dependencies": { "@asyncapi/avro-schema-parser": "^3.0.22", diff --git a/package.json b/package.json index f48303df647..80a0430f70c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@asyncapi/cli", "description": "All in one CLI for all AsyncAPI tools", - "version": "1.12.3", + "version": "1.13.0", "author": "@asyncapi", "bin": { "asyncapi": "./bin/run_bin"