From ad97ec81795bddcf982dca13ae9633105c9d2117 Mon Sep 17 00:00:00 2001 From: asyncapi-bot Date: Fri, 7 Jun 2024 10:44:39 +0200 Subject: [PATCH] chore(release): v4.0.0-next.48 (#2027) --- modelina-cli/README.md | 388 +++++++++++++++++++++++++++++++-- modelina-cli/package-lock.json | 4 +- modelina-cli/package.json | 2 +- package-lock.json | 4 +- package.json | 2 +- 5 files changed, 372 insertions(+), 28 deletions(-) diff --git a/modelina-cli/README.md b/modelina-cli/README.md index 76216842f6..1005dc32fb 100644 --- a/modelina-cli/README.md +++ b/modelina-cli/README.md @@ -18,26 +18,18 @@ # Table of contents - -- [Installation](#installation) - * [MacOS](#macos) - * [Windows](#windows) - * [Linux](#linux) - * [Others](#others) -- [Usage](#usage) -- [Commands](#commands) - * [`modelina config`](#modelina-config) - * [`modelina config context`](#modelina-config-context) - * [`modelina config context add CONTEXT-NAME SPEC-FILE-PATH`](#modelina-config-context-add-context-name-spec-file-path) - * [`modelina config context current`](#modelina-config-context-current) - * [`modelina config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`](#modelina-config-context-edit-context-name-new-spec-file-path) - * [`modelina config context init [CONTEXT-FILE-PATH]`](#modelina-config-context-init-context-file-path) - * [`modelina config context list`](#modelina-config-context-list) - * [`modelina config context remove CONTEXT-NAME`](#modelina-config-context-remove-context-name) - * [`modelina config context use CONTEXT-NAME`](#modelina-config-context-use-context-name) - * [`modelina generate LANGUAGE FILE`](#modelina-generate-language-file) - * [`modelina help [COMMAND]`](#modelina-help-command) - +* [Table of contents](#table-of-contents) +* [Installation](#installation) +* [Download latest release](#download-latest-release) +* [Install it](#install-it) +* [Download latest release](#download-latest-release) +* [Install it](#install-it) +* [Download](#download) +* [Install](#install) +* [Download](#download) +* [Install](#install) +* [Usage](#usage) +* [Commands](#commands) # Installation @@ -170,7 +162,7 @@ $ npm install -g @asyncapi/modelina-cli $ modelina COMMAND running command... $ modelina (--version) -@asyncapi/modelina-cli/4.0.0-next.47 darwin-x64 node-v18.19.0 +@asyncapi/modelina-cli/4.0.0-next.47 linux-x64 node-v18.20.3 $ modelina --help [COMMAND] USAGE $ modelina COMMAND @@ -181,6 +173,7 @@ USAGE # Commands +* [`modelina autocomplete [SHELL]`](#modelina-autocomplete-shell) * [`modelina config`](#modelina-config) * [`modelina config context`](#modelina-config-context) * [`modelina config context add CONTEXT-NAME SPEC-FILE-PATH`](#modelina-config-context-add-context-name-spec-file-path) @@ -192,6 +185,48 @@ USAGE * [`modelina config context use CONTEXT-NAME`](#modelina-config-context-use-context-name) * [`modelina generate LANGUAGE FILE`](#modelina-generate-language-file) * [`modelina help [COMMAND]`](#modelina-help-command) +* [`modelina plugins`](#modelina-plugins) +* [`modelina plugins add PLUGIN`](#modelina-plugins-add-plugin) +* [`modelina plugins:inspect PLUGIN...`](#modelina-pluginsinspect-plugin) +* [`modelina plugins install PLUGIN`](#modelina-plugins-install-plugin) +* [`modelina plugins link PATH`](#modelina-plugins-link-path) +* [`modelina plugins remove [PLUGIN]`](#modelina-plugins-remove-plugin) +* [`modelina plugins reset`](#modelina-plugins-reset) +* [`modelina plugins uninstall [PLUGIN]`](#modelina-plugins-uninstall-plugin) +* [`modelina plugins unlink [PLUGIN]`](#modelina-plugins-unlink-plugin) +* [`modelina plugins update`](#modelina-plugins-update) +* [`modelina version`](#modelina-version) + +## `modelina autocomplete [SHELL]` + +Display autocomplete installation instructions. + +``` +USAGE + $ modelina autocomplete [SHELL] [-r] + +ARGUMENTS + SHELL (zsh|bash|powershell) Shell type + +FLAGS + -r, --refresh-cache Refresh cache (ignores displaying instructions) + +DESCRIPTION + Display autocomplete installation instructions. + +EXAMPLES + $ modelina autocomplete + + $ modelina autocomplete bash + + $ modelina autocomplete zsh + + $ modelina autocomplete powershell + + $ modelina autocomplete --refresh-cache +``` + +_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.1.1/modelina-cli/src/commands/autocomplete/index.ts)_ ## `modelina config` @@ -437,5 +472,314 @@ DESCRIPTION Display help for modelina. ``` -_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.20/modelina-cli/src/commands/help.ts)_ +_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.1.0/modelina-cli/src/commands/help.ts)_ + +## `modelina plugins` + +List installed plugins. + +``` +USAGE + $ modelina plugins [--json] [--core] + +FLAGS + --core Show core plugins. + +GLOBAL FLAGS + --json Format output as json. + +DESCRIPTION + List installed plugins. + +EXAMPLES + $ modelina plugins +``` + +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/modelina-cli/src/commands/plugins/index.ts)_ + +## `modelina plugins add PLUGIN` + +Installs a plugin into modelina. + +``` +USAGE + $ modelina plugins add PLUGIN... [--json] [-f] [-h] [-s | -v] + +ARGUMENTS + PLUGIN... Plugin to install. + +FLAGS + -f, --force Force npm to fetch remote resources even if a local copy exists on disk. + -h, --help Show CLI help. + -s, --silent Silences npm output. + -v, --verbose Show verbose npm output. + +GLOBAL FLAGS + --json Format output as json. + +DESCRIPTION + Installs a plugin into modelina. + + Uses bundled npm executable to install plugins into /home/runner/.local/share/@asyncapi/modelina-cli + + Installation of a user-installed plugin will override a core plugin. + + Use the MODELINA_NPM_LOG_LEVEL environment variable to set the npm loglevel. + Use the MODELINA_NPM_REGISTRY environment variable to set the npm registry. + +ALIASES + $ modelina plugins add + +EXAMPLES + Install a plugin from npm registry. + + $ modelina plugins add myplugin + + Install a plugin from a github url. + + $ modelina plugins add https://github.com/someuser/someplugin + + Install a plugin from a github slug. + + $ modelina plugins add someuser/someplugin +``` + +## `modelina plugins:inspect PLUGIN...` + +Displays installation properties of a plugin. + +``` +USAGE + $ modelina plugins inspect PLUGIN... + +ARGUMENTS + PLUGIN... [default: .] Plugin to inspect. + +FLAGS + -h, --help Show CLI help. + -v, --verbose + +GLOBAL FLAGS + --json Format output as json. + +DESCRIPTION + Displays installation properties of a plugin. + +EXAMPLES + $ modelina plugins inspect myplugin +``` + +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/modelina-cli/src/commands/plugins/inspect.ts)_ + +## `modelina plugins install PLUGIN` + +Installs a plugin into modelina. + +``` +USAGE + $ modelina plugins install PLUGIN... [--json] [-f] [-h] [-s | -v] + +ARGUMENTS + PLUGIN... Plugin to install. + +FLAGS + -f, --force Force npm to fetch remote resources even if a local copy exists on disk. + -h, --help Show CLI help. + -s, --silent Silences npm output. + -v, --verbose Show verbose npm output. + +GLOBAL FLAGS + --json Format output as json. + +DESCRIPTION + Installs a plugin into modelina. + + Uses bundled npm executable to install plugins into /home/runner/.local/share/@asyncapi/modelina-cli + + Installation of a user-installed plugin will override a core plugin. + + Use the MODELINA_NPM_LOG_LEVEL environment variable to set the npm loglevel. + Use the MODELINA_NPM_REGISTRY environment variable to set the npm registry. + +ALIASES + $ modelina plugins add + +EXAMPLES + Install a plugin from npm registry. + + $ modelina plugins install myplugin + + Install a plugin from a github url. + + $ modelina plugins install https://github.com/someuser/someplugin + + Install a plugin from a github slug. + + $ modelina plugins install someuser/someplugin +``` + +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/modelina-cli/src/commands/plugins/install.ts)_ + +## `modelina plugins link PATH` + +Links a plugin into the CLI for development. + +``` +USAGE + $ modelina plugins link PATH [-h] [--install] [-v] + +ARGUMENTS + PATH [default: .] path to plugin + +FLAGS + -h, --help Show CLI help. + -v, --verbose + --[no-]install Install dependencies after linking the plugin. + +DESCRIPTION + Links a plugin into the CLI for development. + Installation of a linked plugin will override a user-installed or core plugin. + + e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' + command will override the user-installed or core plugin implementation. This is useful for development work. + + +EXAMPLES + $ modelina plugins link myplugin +``` + +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/modelina-cli/src/commands/plugins/link.ts)_ + +## `modelina plugins remove [PLUGIN]` + +Removes a plugin from the CLI. + +``` +USAGE + $ modelina plugins remove [PLUGIN...] [-h] [-v] + +ARGUMENTS + PLUGIN... plugin to uninstall + +FLAGS + -h, --help Show CLI help. + -v, --verbose + +DESCRIPTION + Removes a plugin from the CLI. + +ALIASES + $ modelina plugins unlink + $ modelina plugins remove + +EXAMPLES + $ modelina plugins remove myplugin +``` + +## `modelina plugins reset` + +Remove all user-installed and linked plugins. + +``` +USAGE + $ modelina plugins reset [--hard] [--reinstall] + +FLAGS + --hard Delete node_modules and package manager related files in addition to uninstalling plugins. + --reinstall Reinstall all plugins after uninstalling. +``` + +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/modelina-cli/src/commands/plugins/reset.ts)_ + +## `modelina plugins uninstall [PLUGIN]` + +Removes a plugin from the CLI. + +``` +USAGE + $ modelina plugins uninstall [PLUGIN...] [-h] [-v] + +ARGUMENTS + PLUGIN... plugin to uninstall + +FLAGS + -h, --help Show CLI help. + -v, --verbose + +DESCRIPTION + Removes a plugin from the CLI. + +ALIASES + $ modelina plugins unlink + $ modelina plugins remove + +EXAMPLES + $ modelina plugins uninstall myplugin +``` + +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/modelina-cli/src/commands/plugins/uninstall.ts)_ + +## `modelina plugins unlink [PLUGIN]` + +Removes a plugin from the CLI. + +``` +USAGE + $ modelina plugins unlink [PLUGIN...] [-h] [-v] + +ARGUMENTS + PLUGIN... plugin to uninstall + +FLAGS + -h, --help Show CLI help. + -v, --verbose + +DESCRIPTION + Removes a plugin from the CLI. + +ALIASES + $ modelina plugins unlink + $ modelina plugins remove + +EXAMPLES + $ modelina plugins unlink myplugin +``` + +## `modelina plugins update` + +Update installed plugins. + +``` +USAGE + $ modelina plugins update [-h] [-v] + +FLAGS + -h, --help Show CLI help. + -v, --verbose + +DESCRIPTION + Update installed plugins. +``` + +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.1/modelina-cli/src/commands/plugins/update.ts)_ + +## `modelina version` + +``` +USAGE + $ modelina version [--json] [--verbose] + +FLAGS + --verbose Show additional information about the CLI. + +GLOBAL FLAGS + --json Format output as json. + +FLAG DESCRIPTIONS + --verbose Show additional information about the CLI. + + Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using. +``` + +_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v2.2.1/modelina-cli/src/commands/version.ts)_ diff --git a/modelina-cli/package-lock.json b/modelina-cli/package-lock.json index 8abba64cf9..7d2bc1fd36 100644 --- a/modelina-cli/package-lock.json +++ b/modelina-cli/package-lock.json @@ -1,12 +1,12 @@ { "name": "@asyncapi/modelina-cli", - "version": "4.0.0-next.47", + "version": "4.0.0-next.48", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@asyncapi/modelina-cli", - "version": "4.0.0-next.47", + "version": "4.0.0-next.48", "license": "Apache-2.0", "dependencies": { "@asyncapi/modelina": "^4.0.0-next.47", diff --git a/modelina-cli/package.json b/modelina-cli/package.json index 0cf976f2c7..08dc0f0460 100644 --- a/modelina-cli/package.json +++ b/modelina-cli/package.json @@ -1,7 +1,7 @@ { "name": "@asyncapi/modelina-cli", "description": "CLI to work with Modelina", - "version": "4.0.0-next.47", + "version": "4.0.0-next.48", "bin": { "modelina": "./bin/run_bin" }, diff --git a/package-lock.json b/package-lock.json index 9f7e6c76d6..1d7762d8bc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@asyncapi/modelina", - "version": "4.0.0-next.47", + "version": "4.0.0-next.48", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@asyncapi/modelina", - "version": "4.0.0-next.47", + "version": "4.0.0-next.48", "license": "Apache-2.0", "dependencies": { "@apidevtools/json-schema-ref-parser": "^11.1.0", diff --git a/package.json b/package.json index cb72240156..d6b76dcba2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@asyncapi/modelina", - "version": "4.0.0-next.47", + "version": "4.0.0-next.48", "description": "Library for generating data models based on inputs such as AsyncAPI, OpenAPI, or JSON Schema documents", "license": "Apache-2.0", "homepage": "https://www.modelina.org",