# @isfco/create-react-component

> A command line tool for creating React components.

Latest version **1.1.2** (published 2017-04-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install @isfco/create-react-component
pnpm add @isfco/create-react-component
yarn add @isfco/create-react-component
bun add @isfco/create-react-component
```

Provides the command `create-react-component`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2017-04-20 |
| First published | 2017-04-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | @fcaldera |
| Maintainers | fcaldera, federico-garcia |
| Keywords | react, component, cli |

## Links

- npm: https://www.npmjs.com/package/@isfco/create-react-component
- Repository: https://github.com/cebroker/create-react-component
- Homepage: https://github.com/cebroker/create-react-component#readme
- Issues: https://github.com/cebroker/create-react-component/issues
- npm.io page: https://npm.io/package/@isfco/create-react-component

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [commander](https://npm.io/package/commander.md) ^2.9.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.2 (latest) — 2017-04-20
- 1.1.1 — 2017-04-20
- 1.1.0 — 2017-04-11
- 1.0.0 — 2017-04-11

## README

# Create React Component
A command line tool for creating React components based on ISFco common patterns. 

## Install

```
$ npm install @isfco/create-react-component
```

## Usage

```
$ create-react-component <ComponentName>
```

It creates a React stateless component under the current directory. 

### Extra files

You can combine options for granularly adding more files, like so:

```
$ create-react-component <ComponentName> --css --test
```

It creates the component and adds stylesheet and test files.

> Use the single arg syntax for shorter commands. `--css --test` can be expressed as `-ct`

You can also indicates creating all files as follow:

```
$ create-react-component <ComponentName> --all
```

### Output path
For creating the component files in a different directory, you must specify an output path. It can be relative or absolute.

```
$ create-react-component <ComponentName> --all --output src
```

It uses the src folder for creating the component folder and files. Output path must exits, otherwise an error will be thrown.

### Overwriting files
By default, create-react-component doesn't overwrite any file. If the component directory already exists in the given output path, the tool will check if the directory is empty before proceeding to create the files. If the directory is not empty, you'll get an error and no files will be created.

In order to force the file creation in this scenario, you can use the `--force` flag. It will overwrite any file in the target directory that matches with any of the used names.

```
$ create-react-component <ComponentName> --all --output src --force
```

> You won't receive any warning preventing files overwriting. So be carefull.

## Options

```
-h, --help           output usage information
-t, --test           create test file
-s, --story          create storybook file
-c, --css            create css/sass file
-i, --index          create index file
-a, --all            create all files
-o, --output [path]  the output path
-f, --force          force files overwriting 
```

---
_Source: https://npm.io/package/@isfco/create-react-component · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._