cpoo
Version:
simple react component generator
267 lines (189 loc) • 6.24 kB
Markdown
cpoo
====
simple react component generator
[](https://oclif.io)
[](https://npmjs.org/package/cpoo)
[](https://npmjs.org/package/cpoo)
[](https://github.com/masaya-fukazawa/cpoo/blob/master/package.json)
<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g cpoo
$ cpoo COMMAND
running command...
$ cpoo (--version)
cpoo/1.2.0 darwin-x64 node-v14.18.2
$ cpoo --help [COMMAND]
USAGE
$ cpoo COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`cpoo generate COMPONENTNAME [PATH]`](#cpoo-generate-componentname-path)
* [`cpoo help [COMMAND]`](#cpoo-help-command)
* [`cpoo init`](#cpoo-init)
* [`cpoo plugins`](#cpoo-plugins)
* [`cpoo plugins:inspect PLUGIN...`](#cpoo-pluginsinspect-plugin)
* [`cpoo plugins:install PLUGIN...`](#cpoo-pluginsinstall-plugin)
* [`cpoo plugins:link PLUGIN`](#cpoo-pluginslink-plugin)
* [`cpoo plugins:uninstall PLUGIN...`](#cpoo-pluginsuninstall-plugin)
* [`cpoo plugins:update`](#cpoo-pluginsupdate)
## `cpoo generate COMPONENTNAME [PATH]`
generate React Component
```
USAGE
$ cpoo generate [COMPONENTNAME] [PATH] [-h] [--excludeTest] [--excludeStory]
ARGUMENTS
COMPONENTNAME component name
PATH path to component
FLAGS
-h, --help Show CLI help.
--excludeStory exclude generating storybook file.
--excludeTest exclude generating test file.
DESCRIPTION
generate React Component
EXAMPLES
$ cpoo generate Button src/components/atoms
info : No such directory, so make dir.
success : completed to make directory :3
success created: /your/project/src/components/atoms/Button/Button.stories.tsx
success created: /your/project/src/components/atoms/Button/Button.test.tsx
success created: /your/project/src/components/atoms/Button/Button.tsx
success created: /your/project/src/components/atoms/Button/Button.ts
info : completed to generate component :)
```
_See code: [src/commands/generate/index.ts](https://github.com/masaya-fukazawa/cpoo/blob/v1.2.0/src/commands/generate/index.ts)_
## `cpoo help [COMMAND]`
Display help for cpoo.
```
USAGE
$ cpoo 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 cpoo.
```
_See code: [/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.9/src/commands/help.ts)_
## `cpoo init`
initialize "cpoo"
```
USAGE
$ cpoo init
DESCRIPTION
initialize "cpoo"
EXAMPLES
$ cpoo init
```
_See code: [src/commands/init/index.ts](https://github.com/masaya-fukazawa/cpoo/blob/v1.2.0/src/commands/init/index.ts)_
## `cpoo plugins`
List installed plugins.
```
USAGE
$ cpoo plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ cpoo plugins
```
_See code: [/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_
## `cpoo plugins:inspect PLUGIN...`
Displays installation properties of a plugin.
```
USAGE
$ cpoo 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
$ cpoo plugins:inspect myplugin
```
_See code: [/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/inspect.ts)_
## `cpoo plugins:install PLUGIN...`
Installs a plugin into the CLI.
```
USAGE
$ cpoo 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
$ cpoo plugins:add
EXAMPLES
$ cpoo plugins:install myplugin
$ cpoo plugins:install https://github.com/someuser/someplugin
$ cpoo plugins:install someuser/someplugin
```
_See code: [/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/install.ts)_
## `cpoo plugins:link PLUGIN`
Links a plugin into the CLI for development.
```
USAGE
$ cpoo 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
$ cpoo plugins:link myplugin
```
_See code: [/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/link.ts)_
## `cpoo plugins:uninstall PLUGIN...`
Removes a plugin from the CLI.
```
USAGE
$ cpoo plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cpoo plugins:unlink
$ cpoo plugins:remove
```
_See code: [/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/uninstall.ts)_
## `cpoo plugins:update`
Update installed plugins.
```
USAGE
$ cpoo plugins:update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
```
_See code: [/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/update.ts)_
<!-- commandsstop -->