1.1.0 • Published 2 years ago

goconv v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

goconv

npm link : https://npmjs.com/package/goconv

A CLI tool to convert json to Golang structs and write it to a desired file of your choice

Usage

$ npm install -g goconv
$ goconv COMMAND
running command...
$ goconv (--version)
goconv/1.1.0 darwin-arm64 node-v17.8.0
$ goconv --help [COMMAND]
USAGE
  $ goconv COMMAND
...

Commands

goconv conv

Converts json from source file to struct and writes it in the destination file

USAGE
  $ goconv conv -J <value> -G <value> [-P <value>] [-S <value>] [-C <value>]

FLAGS
  -C, --comment=<value>  Comment to add in the struct
  -G, --go=<value>       (required) path to the go file where the struct will be written
  -J, --json=<value>     (required) path to the JSON source file
  -P, --package=<value>  [default: autogenerated] Name of the package to be imported
  -S, --struct=<value>   [default: Autogenerated] Name of the parent struct

DESCRIPTION
  Converts json from source file to struct and writes it in the destination file

FLAG DESCRIPTIONS
  -C, --comment=<value>  Comment to add in the struct

    Comment

  -G, --go=<value>  path to the go file where the struct will be written

    path to GO file

  -J, --json=<value>  path to the JSON source file

    path to JSON file

  -P, --package=<value>  Name of the package to be imported

    Package name

  -S, --struct=<value>  Name of the parent struct

    Parent struct name

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

goconv help [COMMANDS]

Display help for goconv.

USAGE
  $ goconv help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for goconv.

See code: @oclif/plugin-help

goconv plugins

List installed plugins.

USAGE
  $ goconv plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ goconv plugins

See code: @oclif/plugin-plugins

goconv plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ goconv 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
  $ goconv plugins add

EXAMPLES
  $ goconv plugins:install myplugin 

  $ goconv plugins:install https://github.com/someuser/someplugin

  $ goconv plugins:install someuser/someplugin

goconv plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ goconv 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
  $ goconv plugins:inspect myplugin

goconv plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ goconv 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
  $ goconv plugins add

EXAMPLES
  $ goconv plugins:install myplugin 

  $ goconv plugins:install https://github.com/someuser/someplugin

  $ goconv plugins:install someuser/someplugin

goconv plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ goconv 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
  $ goconv plugins:link myplugin

goconv plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ goconv plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ goconv plugins unlink
  $ goconv plugins remove

goconv plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ goconv plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ goconv plugins unlink
  $ goconv plugins remove

goconv plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ goconv plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ goconv plugins unlink
  $ goconv plugins remove

goconv plugins update

Update installed plugins.

USAGE
  $ goconv plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.
1.1.0

2 years ago

1.0.0

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago