Skip to content

Latest commit

 

History

History
99 lines (71 loc) · 3.41 KB

README.md

File metadata and controls

99 lines (71 loc) · 3.41 KB
Raw

Reacto is a set of CLI commands to maintain react.js apps and components based on specific structure we use in ottofeller.com. It is mostly a wrapper around https://github.com/audreyr/cookiecutter with some additional features like adding extra parts (like actions or routes) into existing component.

The main reason why it is not an npm, but pypi package is that there is no cookiecutter port for node.js with non-CLI API.

Component structure

Reacto declares app structure which is aimed to be easily scalable, with infinitely deep hierarchy of nested components.

Rules:

  • each component must be named with camel case, like SomeNestedComponent
  • each component structure is the same
  • non-components dirs must be named in lower case, using - as words separator.

According to declared rules component dir includes following parts.

SomeNestedComponent/

Nested component dir name starts with capital letter.

assets/

CSS/images/fonts — all related assets are placed there.

types/

Put your types definitions into this dir. Put each type into one file in order to avoid having single big and poorely maintainable file where all types are defined.

index.js

Entry point of any component. Should export all of its parts and describe presentational view:

  • Routing to nested components, based on react-router v4 library
  • HTML structure of component
  • CSS imports
  • other assets import.

View should be described/connected to redux in this file and exported as default value. This file should always be presented in each component.

Other parts of component should be exported with name:

  • reducers
  • actions

Parts of a component must be imported separately to make imports less heavy, not importing entire object including all its parts:

// app/SomeComponent/index.js
import React from 'react';
import DetailsView from 'Entity/Details';
import ListView from 'Entity/List';
import {Route, Switch} from 'react-router-dom';
export {default as reducers} from './reducers';

export default () => <div>
	<h1>This is Some Component title</h1>
	
	<Switch>
		<Route exact path='/' component={ListView} />
		<Route path='details/:id' component={DetailsView} />
	</Switch>
</div>;

actions.js

Redux actions should be described as functions here. Also this file should include actions types constants.

reducers.js

Reducers functions according to redux.

Installation

Simply install pypi package:

pip install reacto

CLI script will deploy into some of your bin/ directories, make sure it is listed in $PATH.

Usage

Example, create component NewComponent in the current dir:

reacto start-component --no-flow NewComponent

Available commands and options

start-component [options] <component path>

Start new component. You can pass absolute/relative path or just component name, in which case component will be created in current directory.

--actions

If passed <component path>/actions.js file created.

--no-flow

Disable FlowType — do not apply its annotations.

--dumb-type

Adding this flag will create dumb type file typedefs/dumb.js and import it from index.js.

--reducers

If passed <component path>/reducers.js file created.

--routes

If passed React Router 4 will be applied to index.js.

--route-path

Path specified on root component of routes tree, which is routes.js:<Route />.