Skip to content

noahziheng/exception-generator

 
 

Repository files navigation

artus-exception-generator

⚠️ NOTICE!!! The project is experimental and Working-In-Process, DON'T use it in production!

Exception Generator CLI created by Artus WG.

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g exception-generator
$ artus-exception-generator COMMAND
running command...
$ artus-exception-generator (--version)
exception-generator/0.0.0 darwin-x64 node-v16.17.1
$ artus-exception-generator --help [COMMAND]
USAGE
  $ artus-exception-generator COMMAND
...

Commands

artus-exception-generator hello PERSON

Say hello

USAGE
  $ artus-exception-generator hello [PERSON] -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ oex hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

See code: dist/commands/hello/index.ts

artus-exception-generator hello world

Say hello world

USAGE
  $ artus-exception-generator hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ artus-exception-generator hello world
  hello world! (./src/commands/hello/world.ts)

artus-exception-generator help [COMMAND]

Display help for artus-exception-generator.

USAGE
  $ artus-exception-generator help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for artus-exception-generator.

See code: @oclif/plugin-help

artus-exception-generator plugins

List installed plugins.

USAGE
  $ artus-exception-generator plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ artus-exception-generator plugins

See code: @oclif/plugin-plugins

artus-exception-generator plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ artus-exception-generator plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ artus-exception-generator plugins add

EXAMPLES
  $ artus-exception-generator plugins:install myplugin 

  $ artus-exception-generator plugins:install https://github.com/someuser/someplugin

  $ artus-exception-generator plugins:install someuser/someplugin

artus-exception-generator plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ artus-exception-generator plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ artus-exception-generator plugins:inspect myplugin

artus-exception-generator plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ artus-exception-generator plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ artus-exception-generator plugins add

EXAMPLES
  $ artus-exception-generator plugins:install myplugin 

  $ artus-exception-generator plugins:install https://github.com/someuser/someplugin

  $ artus-exception-generator plugins:install someuser/someplugin

artus-exception-generator plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ artus-exception-generator plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

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
  $ artus-exception-generator plugins:link myplugin

artus-exception-generator plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ artus-exception-generator plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ artus-exception-generator plugins unlink
  $ artus-exception-generator plugins remove

artus-exception-generator plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ artus-exception-generator plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ artus-exception-generator plugins unlink
  $ artus-exception-generator plugins remove

artus-exception-generator plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ artus-exception-generator plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ artus-exception-generator plugins unlink
  $ artus-exception-generator plugins remove

artus-exception-generator plugins update

Update installed plugins.

USAGE
  $ artus-exception-generator plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

About

WIP: Exception class generator for Artus.js

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 64.8%
  • JavaScript 32.6%
  • Batchfile 2.6%