This repo demonstrates how to setup and build many custom modules from a single repository. The build process is barebones for simplicity and to easily allow customization. You can fork Shrine as a starting point or copy its principles in your own project.
The example modules in the src folder use React only to show support for external modules, there is absolutely no requirement or constraint on external npm modules you want to use.
I strongly believe that individually managed modules are an incredibly powerful asset to any codebase. We've seen the tremendous impact npm has had on the JavaScript community, and use of modules is not restricted to node, but thanks to projects like webpack and Browserify they can be bundled up for use in the browser as well.
Having to create and maintain these modules as separate entities does add a burden on the developer, one of the most painful I've experienced is the need to constantly publish my custom modules to a private repository even though they are only used in my project - npm publish does a lot and is an expensive operation.
To avoid publishing all of the modules, Shrine's build step restructures them in a way npm can understand without the need to publish anything, and can still use external modules from the npm repository. This gives all of the benefits we've found with modules but greatly reduces the pain of developing them.
To better demonstrate how a monorepo can be used there are a couple recipes, each one a little more complicated.
- webbundle - uses browserify to generate a bundle that is rendered only on the client
- universalbundle - runs a node server to run the generated bundle on the server for isomorphic/universal rendering
- scoped-jsx-scss - uses JSX and CSS encapsulation to automatically scope CSS to React components, allowing much cleaner styling
Building creates a build/deploy directory which is the final result of assembling custom modules and installing any external dependencies. This directory is immediately ready to require in node or bundle with your favorite tool such as webpack or Browserify.
$ cd shrine$ npm install$ gulp build
Tests are run via $ npm test
npm install will include a local copy of Mocha which is used to run any test files in the form of *.test.js, for example util.test.js.
When working with custom modules there is a very real chance your name will conflict with one of the 230k modules in npm. To avoid this, the custom modules are prefixed with the @shrine scope; for example the app module's name is @shrine/app. This scope is configurable (see below). The package.json files also set "private": true which will prevent accidental publishing to npm.
The only constraint on where custom modules can live is that they must all be in one parent directory that contains only your modules. They can be anywhere inside of this directory and nested however you'd like. To show this, the footer and header modules are nested in src/supportingviews.
There are a couple configuration values you can change in gulptasks/build-constants.js:
MODULE_PREFIXtells the build process what custom scope is usedENTRY_MODULEfull, scoped module name of your application's entry pointSRC_DIRdirectory in the repository where your custom modules liveBUILD_DIRoutput directory of all build processesMODULES_BUILD_DIRbefore being installed alongside the entry point, this is where your modules are builtDEPLOY_DIRfinal output directory of the application and all supportingnode_modules
The build process is broken down into three steps.
Transpiling involves flattening the src directory so the custom modules end up in a predictable location, similar to how a node_modules contents appear. During this step babel is run to convert from ES6/jsx-harmony -> ES5 and some transforms are applied to the package.json files to account for the transpiling.
After the modules have been transpiled the app's entry point is copied to the deploy directory
Everything is now in place and npm install is executed on the deploy directory. This starts with your entry module and uses npm's dependency tree to install the appropriate modules, both custom and external.