msk-hackathon

DSM React TypeScript components with compiler, based on TSDX

TypeScript cheatsheet

This setup is meant for developing React component libraries that can be published to NPM.

Commands

Using TSDX, it scaffolds your new library inside /src, and also sets up a Parcel-based playground for it inside /demo.

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.

Then run the demo inside another:

cd demo
npm i # or yarn to install dependencies
npm dev # or yarn dev

The default demo imports and live reloads whatever is in /dist, so if you are seeing an out of date component, make sure package is running in watch mode like we recommend above. No symlinking required via Parcel's aliasing.

To do a one-off build, use npm run build or yarn build.

Configuration

Code quality is set up for you with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.

Setup Files

This is the folder structure we set up for you:

/demo
  index.html
  index.tsx       # test your component here in a demo app
  package.json
  tsconfig.json
/src
  index.tsx       # export all your components here
.gitignore
package.json
README.md        
tsconfig.json

Rollup

This package uses Rollup 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.

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.

Deploying the demo Playground

The Playground is just a simple Parcel app, you can deploy it anywhere you would normally deploy that.

npm run build # builds to dist

Named Exports

Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.

Including Styles

• CSS-in-JS

• 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.

Nuances with Lerna

You might encounter a Cannot resolve dependency error when trying to run the demo project. To fix that you will need to make changes to the package.json file inside the demo directory.

The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the demo project's package.json might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.

Change the alias to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.

   "alias": {
-    "react": "../node_modules/react",
-    "react-dom": "../node_modules/react-dom"
+    "react": "../../../node_modules/react",
+    "react-dom": "../../../node_modules/react-dom"
   },

An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. However, that might cause other problems.