noderaider / modular

Scaffold a react monorepo and its component parts.

An unofficial companion ecosystem to create-react-app

What is this?

Often react applications can grow extremely large. create-react-app is a very innovative step forward in react apps, encouraging keeping them small by abstracting the build into a separate module (react-scripts). This 'managed' build strategy has many upsides, with the primary drawback being that you cannot modify the build process as easily. @raider/modular is an ecosystem of companion tools to create-react-app to continue in its footsteps, targeting the areas that it does not hit such as CSS modules support, and doing it in such a way that it will encourage project stacks to grow horizontally (many modules) instead of vertically.

Tenets

• Every module is its own npm package.
• Every module has built in hot reloading support to work in conjunction with a create-react-app downstream project.
• Fast yarn installation support with fallback to npm if yarn is not installed.
• Works on every platform.

PROGRESS

• npm i -g create-css-module 📜
  • create a hot reloading CSS modules library.
• npm i -g create-umd-module 📜
  • create a lightweight ES2015 module with rollupjs and tree shaking.
  • hot reloads with simple babel watch.
  • good for generic universal libraries (non-React)
• npm i -g create-cli-module 📜
  • create a server module meant to be called from CLI / API.
• npm i -g create-sass-module 📜
  • create a hot reloading sass library.
• npm i -g create-component-module 📜
  • create a hot reloading React component module.
  • No react / react-dom dependencies, components are created functionally via a factory interface:

create-component-module react-foo-bar [-t/--with-test-module]

After publishing / linking, you may use the component from your downstream react app like so:

import React from 'react'
import reactFooBar from 'react-foo-bar'

// Create the component
const FooBar = reactFooBar(React)

export default (props) => <FooBar foo="bar" />

^{Note: Exporting modules as factories sidesteps a wide range of issues causing multiple instances of React in your downstream app.}

• npm i -g create-jest-module 📜
  • create a standalone jest test module capable of end-to-end testing another module.
  • IMO it is better to unit test components (react ones particularly) from a separate module. No longer must react / react-dom be included as npm dependencies of your module.
• npm i -g create-express-module 📜
  • create an express server module.
• npm i -g create-koa-module 📜
  • create a koa server module.
• npm i -g create-proxy-module 📜
  • create a reverse proxy.
• npm i -g create-deploy-module 📜
  • create a server deployment module.
• npm i -g create-react-repo 📜
  • create a lerna monorepo with all modular commands (and create-react-app) integrated.

Utils

• npm i -g @raider/install 📜
  • CLI / API component to run NPM install on a package.
  • Uses yarn if detected and falls back to npm.
• npm i -g @raider/which 📜
  • CLI / API component to run closs-platform which command.
• npm i -g @raider/cross 📜
  • CLI / API component to upgrade a project / repos line endings to unix style safely and recursively.

Acknowledgements

Special thanks to Facebook for innovations with create-react-app, without it this project would not be possible.