dyna-ts-react-module-boilerplate
v18.0.5
Published
React Component / Module boilerplate
Downloads
346
Readme
About dyna-ts-module-boilerplate
Boilerplate with Webpack setup for ES6/ESNEXT for React TypeScript Component Libraries/Packages.
- Develop in TypeScript
- Debug with Chrome Dev Tools
- Write tests with Jest
- Lint
- Build
- Deploy on Git and npm
This boilerplate includes minimal configuration and dependencies for creating one or multiple modules written in TypeScript.
It can export one module or multiple for explicit imports.
Happy coding!
Not react, just Web or Node library?
This boilerplate is designed for developing React components. However, if you need a lighter boilerplate for node utils, or web utils without react, you can use the the dyna-ts-module-boilerplate, which is a similar boilerplate but lighter.
Again this supports React and JSX but hasn't StoryBook, react ESList etc.
How to use this boilerplate
To use it and create your own module:
- Clone it into a folder named after your module, like
my-module
. - Run
pnpm bootstrap
to unlink it from this git repo.
Example:
git clone https://github.com/aneldev/dyna-ts-react-module-boilerplate.git my-module
cd my-module
pnpm bootstrap
Your repo will now be ready, and you can git init
under your own account.
Why is create-react-app
different?
It is different because create-react-app
creates React applications and includes everything an application needs.
The dyna-ts-react-module-boilerplate
creates React modules (reusable components). It creates React components that will be used in React applications or other modules.
Features
- Uses the powerful
pnpm
as a packager, but you can easily replace it with another one - Written in TypeScript, .tsx, .ts
- Supports CSS, SCSS & LESS at the same time
- Advanced ESLint
- Tested with Jest
- Debugged with Chrome Dev Tools
- Distributes with TypeScript definitions
- Supports distribution of one or multiple modules for explicit import
- Supports distribution of modules for Web and Node
- Analyzes the distribution
- Exports ESNext modules
- Exports Typescript declarations
- Detects circular dependencies (which can lead to
undefined
ornull
imports) - Monorepo friendly
Specs
- Webpack 5
- TypeScript v5 with higher restrictions
- Supports ES2019 lib
- React JSX syntax
- Less/Scss module CSS or other loaders
- Image loaders
- ESLint configuration for React and rules
- Webpack analyzer for package content with the webpack-bundle-analyzer
Scripts
| Script | Description | Notes |
|:------------------------|:-------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------|
| install-clean
| Clears all node_modules
and runs pnpm install
| |
| storybook-start
| Starts Storybook | |
| storybook-deploy
| Builds Storybook for publishing to Git | |
| build
| Builds .src/index
into the dist
folder | |
| build-watch
| Runs build
in watch mode | |
| build-analyze
| Shows the Webpack dependencies analyzer | |
| commit
| Easily commit, including unstaged files | |
| commit-amend
| Easily amend the previous commit with unstaged files | |
| lint
| Runs ESLint on your source code | |
| lint-watch
| Runs ESLint in watch mode | |
| lint-fix
| Autofixes issues with ESLint | |
| lint-fix-watch
| Autofixes issues with ESLint in watch mode | |
| test
| Runs all or filtered tests | Arguments <filter>
. Example: test MyService
|
| test-debug
| Debugs tests with Dev Tools | Arguments <filter>
. Example: test-debug MyService
|
| test-watch
| Runs all or filtered tests in watch mode | Arguments <filter>
. Example: test-watch MyService
|
| test-no-coverage
| Runs all or filtered tests without coverage | Arguments <filter>
. Example: test-no-coverage MyService
|
| test-update-snapshots
| Updates test snapshots | Arguments <filter>
. Example: test-update-snapshots MyService
|
| update-deps
| Bumps all dependencies to their latest versions based on version definition | |
| publish-push
| Bumps the patch version, publishes to npm, and pushes to Git | |
| release
| Runs build
& publish-push
| |
| bootstrap
| Initialization script that prepares the boilerplate and disconnects it from the Anel Dev organization’s Git. | You shouldn't see this script; it's only run right after cloning. |
If you see the bootstrap
script and you've already run git init
on your versioning system, you can delete:
- The
bootstrap
script - The
bootstrap.js
file
Configuration
This is a Zero-Configuration boilerplate!
However, if needed, you should only edit the following:
Webpack Loaders/Rules
Add them in /webpack.loaders.js
.
Webpack Plugins
Add them in /webpack.plugins.js
.
Distributions
This boilerplate can export one or multiple independent modules.
Single module
If the boilerplate finds the src/index.ts
file, it considers the module Single.
For example:
Content of src/index.ts
:
export class Invoice {...}
From another package, you can import this module like this:
import { Invoice } from "my-module";
Multi modules
If the boilerplate cannot find the src/index.ts
file, it considers the module Multi. In this case, the /src
folder should contain folders, each representing a module with its own index.ts
file.
This allows making explicit imports from other packages or apps improving the tree shaking.
For example:
Folder structure:
src/Invoice/index.ts // content: export class Invoice {...}
src/Person/index.ts // content: export class Person {...}
From another package, you can explicit import these modules like this:
import { Invoice } from "my-module/dist/Invoice";
import { Person } from "my-module/dist/Person";
Similarly, you can distribute modules for specific environments, such as Web or Node, ensuring you import dependencies compatible with the target environment.
The dist
folder contains only JavaScript code (ES5), without Webpack module loaders, so the code works everywhere as ES5.
Switching from Single to Multi
- The
/src
folder should contain only subfolders. - Each subfolder is considered an independent module.
- Each subfolder should have an
/index.ts
that exports what’s needed. - Delete the
src/index.ts
.
Switching from Multi to Single
- Create the
src/index.ts
. - Export what’s needed.
- The folder structure can be anything.
Develop
Development is based on Jest tests. After creating something in the src
, create a Jest test like the main.test.ts and run or debug it.
Steps:
- Write your Jest tests anywhere under the
./src
. - Important Place a
debugger;
statement somewhere; otherwise, the debug runtime won’t stop. - Run
pnpm test-debug <name of the test file>
. - Open chrome://inspect/#devices.
- Select the remote target instance and click
inspect
. - Ready for debugging.
Note: You might need to press Resume script
(the Play
button) to skip some internal Node lib points.
For more information about the tests, read below.
Analyze
- Run
pnpm analyse
.
Test
Write tests
For testing, Jest is used. Check the documentation for details.
Test files can be located anywhere but should have names in the format *.(test|spec).(ts|js)
.
Run tests
Run pnpm test
to execute your tests and coverage.
Run pnpm test-watch
to execute tests on changes.
Run pnpm test-no-coverage
to run tests without coverage.
Run pnpm test-update-snapshots
to update the snapshots.
Run pnpm test-debug
to debug with Chrome Dev Tools.
Dist / Release
General
Run pnpm build
to create a distributable version of your project in the dist/
folder.
The package configuration exports the dist/
folder, so you need to run pnpm build
each time you want to publish this package. TypeScript declarations are included out of the box.
Run pnpm release
to build, publish to npm, and push to your repo.