generator-elderfo-typescript-workspace

generator-elderfo-typescript-workspace

Boilerplate generator for typescript monorepos not intended to be published to npm.

Installation

First, install Yeoman and generator-elderfo-typescript-workspace using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-elderfo-typescript-workspace

Then generate your new project:

yo elderfo-typescript-workspace

Configuration

The generator will prompt you for two values:

• Application Name - the name of the application. Note: when running the generator, you will want to be in the folder above where you want the package to be created
• Application Version - the version to be used with the application

Structure

The application configuration expects the application to be structured like:

<project-name>/
|-- packages/
|-- tools/
|-- jest.json
|-- lerna.json
|-- package.json
`-- tsconfig.json

• packages is for the main applicaiton packages
• tools is for dev packages, such as pre-processors, data generators, etc...

Npm/yarn Run Scripts

• bootstrap - convinence method for lerna bootstrap
• build - runs build on all packages with a defined build script
• clean-all - cleans all node_modules and build folders
• dev - runs the dev script in parallel on all packages that have one defined
• pretest - pre-builds packages for testing
• test - runs tests at a global level

License

MIT © Chris Getsfred