# @jkirkpatrick24/react-create-component-cli

> cli tool for creating react/redux components

Latest version **0.1.5** (published 2017-09-20) · ISC license · 0 weekly downloads

## Install

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

Provides the command `mkcpt`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2017-09-20 |
| First published | 2017-09-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | James Kirkpatrick |
| Maintainers | jkirkpatrick24 |
| Keywords | react, redux, node |

## Links

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

## Dependencies (2)

- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [nunjucks](https://npm.io/package/nunjucks.md) ^3.0.1

## 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

- 0.1.5 (latest) — 2017-09-20
- 0.1.4 — 2017-09-19
- 0.1.2 — 2017-09-12
- 0.1.1 — 2017-09-12

## README

# react-create-component-cli

react-create-component-cli is simple cli tool to create boilerplate for react components. It makes use of [nunjucks](https://mozilla.github.io/nunjucks/) templates to construct the component files.

## Usage

Currently this package creates components using the assumption that you are using a few libraries within your react/redux application. These are not required to create basic components.
  - [redux-threads](https://github.com/stonevanzuiden/redux-threads)
  - [react-resolve-dependencies](https://github.com/eadmundo/react-resolve-dependencies)

```bash
  $ npm i -g @jkirkpatrick24/react-create-component-cli
  $ mkcpt $ARGS
```
### Example Component
`$ mkcpt --name TestComponent --hasDependencies --isConnected`

```js
// TestComponent.react.js

import React from 'react';
import { compose } from 'redux';
import resolveDependencies from 'react-resolve-dependencies';
import { connect } from 'react-redux';
import { makeConnectArgs } from 'redux-threads';
import * as selectors from '../selectors';
import * as actions from '../actions';

export class TestComponent extends React.PureComponent {

  static dependencies = [];

  render() {
    return(

    );
  }

}

const pageThread = [
  selectors,
  actions,
  (stateProps, dispatchProps) => ({})
]

const connectArgs = makeConnectArgs(
  pageThread
);

export default compose(
  resolveDependencies()
  connect(...connectArgs)
)(TestComponent);
```

### Arguments

Currently makes use of the following flags
```
  --cdm                // false
  --cwm                // false
  --cwu                // false
  --ext                // react.js
  --hasConstructor     // false
  --hasDependencies    // false
  --isConnected        // false
  --isPure             // true
  --isFunctional       // false
  --name               // index
```

#### `--cdm`

defaults to false.

Creates the `componentDidMount` lifecycle method if `true`

#### `--cwm`

defaults to false.

Creates the `componentWillMount` lifecycle method if `true`

#### `--cwu`

defaults to false.

Creates the `componentWillUnmount` lifecycle method if `true`

#### `--hasConstructor`

defaults to false.

Creates the class `constructor` method if `true`

#### `--hasDependencies`

Defaults to false. Includes the [react-resolve-dependencies](https://github.com/eadmundo/react-resolve-dependencies) library.

adds to component:
```js
import resolveDependencies from 'react-resolve-dependencies';

static dependencies = [];

export default resolveDependencies()(componentName);

```

#### `--isConnected`

Defaults to `false`

Includes imports and boilerplate for a redux connected component (Assuming the use of [redux-threads](1))

adds to component:
```js
import { connect } from 'react-redux';
import { makeConnectArgs } from 'redux-threads';
import * as selectors from '../selectors';
import * as actions from '../actions';

const pageThread = [
  selectors,
  actions,
  (stateProps, dispatchProps) => ({})
]

const connectArgs = makeConnectArgs(
  pageThread
);

compose(
  connect(...connectArgs)
)()
```

#### `--isFunctional`

Defaults to `false`

renders a functional component

```
const {{ name }} => () {
  return (
    
  );
}

export default name
```

#### `--isPure`

Defaults to true.

While true, uses `React.PureComponent`. Otherwise uses `React.Component`

#### `--name`

Defaults to "index".

Name of the component.

## Liscence

MIT.

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