@mdapper/react-components-library v1.0.0
React Components Library - Demo
This is a demo for how to build a React components library using TSDX and Docz.
If you’re new to TypeScript and React, checkout this handy cheatsheet
Commands
The recommended workflow is to run TSDX in one terminal:
npm start
# or
yarn start
This builds to /dist
and runs the project in watch mode so any edits you save inside src
causes a rebuild to /dist
.
To do a one-off build, use npm run build
or yarn build
.
To run tests, use npm test
or yarn test
.
To run the linter, use npm lint
or yarn lint
.
Configuration
Code quality is set up for you with prettier
, husky
, and lint-staged
. Adjust the respective fields in package.json
accordingly.
Jest
Jest tests are set up to run with npm test
or yarn test
. This runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.
Setup Files
This is the folder structure:
/src
/Component # Basic component structure
Component.test.tsx
Component.tsx
index.ts
README.mdx
index.tsx
.eslintrc.js
.gitignore
.nvmrc
.prettierrc
package.json
README.md # EDIT THIS
tsconfig.json
Tests
We already installed React Testing Library so you can use it to test your components.
Rollup
TSDX uses Rollup v1.x as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.
TypeScript
tsconfig.json
is set up to interpret dom
and esnext
types, as well as react
for jsx
. Adjust according to your needs.
Continuous Integration
Travis
to be completed
Optimizations
Please see the main tsdx
optimizations docs. In particular, know that you can take advantage of development-only optimizations:
// ./types/index.d.ts
declare var __DEV__: boolean;
// inside your code...
if (__DEV__) {
console.log('foo');
}
You can also choose to install and use invariant and warning functions.
Module Formats
CJS, ESModules, and UMD module formats are supported.
The appropriate paths are configured in package.json
and dist/index.js
accordingly. Please report if any issues are found.
Named Exports
Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.
Including Styles
There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
For vanilla CSS, you can include it at the root directory and add it to the files
section in your package.json
, so that it can be imported separately by your users and run through their bundler's loader.
4 years ago