refactor-cli
v0.0.2
Published
Refactors code using language servers
Downloads
4
Readme
Refactor CLI
oclif example Hello World CLI
Usage
$ npm install -g refactor-cli
$ refactor COMMAND
running command...
$ refactor (--version)
refactor-cli/0.0.2 darwin-arm64 node-v18.3.0
$ refactor --help [COMMAND]
USAGE
$ refactor COMMAND
...
Commands
refactor help [COMMAND]
refactor plugins
refactor plugins:install PLUGIN...
refactor plugins:inspect PLUGIN...
refactor plugins:install PLUGIN...
refactor plugins:link PLUGIN
refactor plugins:uninstall PLUGIN...
refactor plugins:uninstall PLUGIN...
refactor plugins:uninstall PLUGIN...
refactor plugins update
refactor rename OLDNAME NEWNAME
refactor help [COMMAND]
Display help for refactor.
USAGE
$ refactor 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 refactor.
See code: @oclif/plugin-help
refactor plugins
List installed plugins.
USAGE
$ refactor plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ refactor plugins
See code: @oclif/plugin-plugins
refactor plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ refactor 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
$ refactor plugins add
EXAMPLES
$ refactor plugins:install myplugin
$ refactor plugins:install https://github.com/someuser/someplugin
$ refactor plugins:install someuser/someplugin
refactor plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ refactor 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
$ refactor plugins:inspect myplugin
refactor plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ refactor 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
$ refactor plugins add
EXAMPLES
$ refactor plugins:install myplugin
$ refactor plugins:install https://github.com/someuser/someplugin
$ refactor plugins:install someuser/someplugin
refactor plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ refactor 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
$ refactor plugins:link myplugin
refactor plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ refactor plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ refactor plugins unlink
$ refactor plugins remove
refactor plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ refactor plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ refactor plugins unlink
$ refactor plugins remove
refactor plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ refactor plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ refactor plugins unlink
$ refactor plugins remove
refactor plugins update
Update installed plugins.
USAGE
$ refactor plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
refactor rename OLDNAME NEWNAME
Rename a symbol
USAGE
$ refactor rename [OLDNAME] [NEWNAME] --file <value> --line <value> [--repoPath <value>]
FLAGS
--file=<value> (required) File that contains symbol
--line=<value> (required) Line that contains symbol
--repoPath=<value> Repository
DESCRIPTION
Rename a symbol
EXAMPLES
$ refactor rename Input FileInput --file test.js --line 10
See code: dist/commands/rename.ts