# react-scaffoldx

> Scaffold your React app from the command line.

Latest version **0.4.1** (published 2022-09-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-scaffoldx
pnpm add react-scaffoldx
yarn add react-scaffoldx
bun add react-scaffoldx
```

Provides the command `rsx`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2022-09-20 |
| First published | 2022-06-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 6 |
| Unpacked size | 26.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Abdullah Zeidan @AbdullahZeidan |
| Maintainers | abdullahzeidan |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/react-scaffoldx
- Repository: https://github.com/AbdullahZeidan/react-scaffold
- Issues: https://github.com/AbdullahZeidan/react-scaffold/issues
- npm.io page: https://npm.io/package/react-scaffoldx

## Dependencies (6)

- [enquirer](https://npm.io/package/enquirer.md) ^2.3.6
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0
- [readdirp](https://npm.io/package/readdirp.md) ^3.6.0
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^1
- [ansi-colors](https://npm.io/package/ansi-colors.md) ^4.1.3
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.4.1 (latest) — 2022-09-20
- 0.4.0 — 2022-09-19
- 0.3.0 — 2022-08-09
- 0.2.1 — 2022-06-05
- 0.2.0 — 2022-06-05

## README

# react-scaffold
⚛️ Scaffold your React app from the command line ⚛️.

[![Downloads/week](https://img.shields.io/npm/dm/react-scaffoldx?color=black)](https://npmjs.org/package/react-scaffoldx)
[![Build status](https://img.shields.io/github/workflow/status/abdullahzeidan/react-scaffold/react-scaffold%20CI%20Pipeline?label=build&logo=mocha&logoColor=white)](https://github.com/AbdullahZeidan/react-scaffold/actions/workflows/ci.yml)
[![License](https://img.shields.io/npm/l/react-scaffoldx?color=purple)](https://github.com/oclif/hello-world/blob/main/package.json)

<!-- toc -->
* [react-scaffold](#react-scaffold)
* [Usage & Installation](#usage--installation)
* [Commands](#commands)
<!-- tocstop -->

# Usage & Installation

It is recommended to install react-scaffoldx globally since it makes it easier for you to quickly type out.

<!-- usage -->
```sh-session
$ npm install -g react-scaffoldx
$ rsx COMMAND
running command...
$ rsx (--version)
react-scaffoldx/0.4.1 linux-x64 node-v16.17.0
$ rsx --help [COMMAND]
USAGE
  $ rsx COMMAND
...
```
<!-- usagestop -->


# Commands
<!-- commands -->
* [`rsx c`](#rsx-c)
* [`rsx comp`](#rsx-comp)
* [`rsx component`](#rsx-component)
* [`rsx help [COMMAND]`](#rsx-help-command)
* [`rsx init`](#rsx-init)

## `rsx c`

Create/Scaffold a React component

```
USAGE
  $ rsx c [-d <value>] [--typescript] [--style css|scss|styled-components|none]

FLAGS
  -d, --dest=<value>                         Destination folder
  --style=(css|scss|styled-components|none)  Choose which type of styling to use for your components
  --typescript                               Create a TypeScript component

DESCRIPTION
  Create/Scaffold a React component

ALIASES
  $ rsx comp
  $ rsx c

EXAMPLES
  $ rsx c ComponentOne ComponentTwo

  $ rsx c ComponentOne --typescript --style=scss --dest src/components/layout
```

## `rsx comp`

Create/Scaffold a React component

```
USAGE
  $ rsx comp [-d <value>] [--typescript] [--style css|scss|styled-components|none]

FLAGS
  -d, --dest=<value>                         Destination folder
  --style=(css|scss|styled-components|none)  Choose which type of styling to use for your components
  --typescript                               Create a TypeScript component

DESCRIPTION
  Create/Scaffold a React component

ALIASES
  $ rsx comp
  $ rsx c

EXAMPLES
  $ rsx comp ComponentOne ComponentTwo

  $ rsx comp ComponentOne --typescript --style=scss --dest src/components/layout
```

## `rsx component`

Create/Scaffold a React component

```
USAGE
  $ rsx component [-d <value>] [--typescript] [--style css|scss|styled-components|none]

FLAGS
  -d, --dest=<value>                         Destination folder
  --style=(css|scss|styled-components|none)  Choose which type of styling to use for your components
  --typescript                               Create a TypeScript component

DESCRIPTION
  Create/Scaffold a React component

ALIASES
  $ rsx comp
  $ rsx c

EXAMPLES
  $ rsx component ComponentOne ComponentTwo

  $ rsx component ComponentOne --typescript --style=scss --dest src/components/layout
```

_See code: [dist/commands/component.ts](https://github.com/AbdullahZeidan/react-scaffold/blob/v0.4.1/dist/commands/component.ts)_

## `rsx help [COMMAND]`

Display help for rsx.

```
USAGE
  $ rsx 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 rsx.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_

## `rsx init`

Initialize react-scaffold's config file (.rsxrc)

```
USAGE
  $ rsx init [-y]

FLAGS
  -y, --yes  accept default config values ('assume YES')

DESCRIPTION
  Initialize react-scaffold's config file (.rsxrc)
```

_See code: [dist/commands/init.ts](https://github.com/AbdullahZeidan/react-scaffold/blob/v0.4.1/dist/commands/init.ts)_
<!-- commandsstop -->

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