https://github.com/wednesday-solutions/react-floki
A CLI tool that works with the react template and allows you to scaffold tests, containers, components and stitches them all together preventing wastage of time in setup and boilerplate code.
https://github.com/wednesday-solutions/react-floki
component components container es6 javascript javascript-library plop plop-generators react react-components react-intl react-redux redux saga scaffolding selector template testing testing-library testing-library-react
Last synced: 3 months ago
JSON representation
A CLI tool that works with the react template and allows you to scaffold tests, containers, components and stitches them all together preventing wastage of time in setup and boilerplate code.
- Host: GitHub
- URL: https://github.com/wednesday-solutions/react-floki
- Owner: wednesday-solutions
- License: mit
- Created: 2019-08-13T19:02:44.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T07:27:50.000Z (11 months ago)
- Last Synced: 2025-01-13T05:46:44.089Z (5 months ago)
- Topics: component, components, container, es6, javascript, javascript-library, plop, plop-generators, react, react-components, react-intl, react-redux, redux, saga, scaffolding, selector, template, testing, testing-library, testing-library-react
- Language: JavaScript
- Homepage: https://wednesday.is/building-products/?utm_source=github&utm_medium=react-floki
- Size: 67.8 MB
- Stars: 38
- Watchers: 6
- Forks: 12
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
React Floki
A CLI tool that works with the react template and allows you to scaffold tests, containers, components and stitches them all together preventing wastage of time in setup and boilerplate code.
___
Expert teams of digital product strategists, developers, and designers.
___
We’re always looking for people who value their work, so come and join us. We are hiring!
## Installation
### Globally install react-generate
`npm install -g react-floki`
**OR**
`yarn global add react-floki`
## Examples of generated files
- [Container](generated-files/container)
- [Component](generated-files/component)
- [Loadable](generated-files/loadable)
- [Test-util](generated-files/test-util)
## Generating containers with tests and stories
## Generate components with tests and stories
## Documentation
### Help
To get a list of commands and usage hints use
```
react-generate --help
```
### Creating a new React Application
```
react-generate init movie-rating
```
### Generating tests for all existing components and containers
**Creating a test for a container or component:** `react-generate gt`
**Creating a test for an existing component:** `react-generate gtcom`
**Creating a test for an existing container:** `react-generate gtcon`
### Forcefully generating tests for all existing components and containers
**Forcefully creating a test for a container or component:** `react-generate gtf`
**Forcefully creating a test for an existing component:** `react-generate gtcomf`
**Forcefully creating a test for an existing container:** `react-generate gtconf`
### Generating components and containers
**Creating a container or component:** `react-generate g`
**Creating a component:** `react-generate gcom`
**Creating a container:** `react-generate gcon`
### Forcefully generating components and containers
**Forcefully creating a container or component:** `react-generate gf`
**Forcefully creating a component:** `react-generate gcomf`
**Forcefully creating a container:** `react-generate gconf`
### Generating tests for all existing components and containers
**Generate test for all components in directory:** `react-generate --all component `
**Generate test for all containers in directory:** `react-generate --all containers `
### Generating a testUtils file with some utility functions for tests
**Generate a test util file:** `react-generate gtutil`
### Generating a utility for a loadable file using React 16 lazy and Suspense
**Generating a utility for a loadable file :** `react-generate gloadable`
# Advanced
## Example Usages
**Creating a test by specifying type, path and name:** `react-generate gt component src/app Button`
**Creating a test for an existing component by specifying path and name:** `react-generate gtcom src/app Button`
**Creating a test for an existing container by specifying path and name:** `react-generate gtcon src/app HomePage`
**Creating a component/container by specifying type, path and name:** `react-generate g component src/app Button`
**Creating a component by specifying path and name:** `react-generate gcom src/app Button`
**Creating a container by specifying path and name:** `react-generate gcon src/app HomePage`
**Generate test for all components in directory:** `react-generate --all component src/app/components`
**Generate test for all containers in directory:** `react-generate --all container src/app/containers`
# Projects using it
- [React Template](https://github.com/wednesday-solutions/react-template)