├── example
    ├── .npmignore
    ├── index.tsx
    ├── index.html
    ├── tsconfig.json
    └── package.json
├── .gitignore
├── src
    ├── index.tsx
    ├── tailwind.css
    ├── Thing.tsx
    └── Button.tsx
├── postcss.config.js
├── .storybook
    ├── preview.js
    └── main.js
├── .github
    └── workflows
    │   ├── size.yml
    │   └── main.yml
├── tailwind.config.js
├── test
    ├── blah.test.tsx
    └── Button.test.tsx
├── tsdx.config.js
├── README.md
├── .vscode
    ├── extensions.json
    └── settings.json
├── stories
    ├── Button.stories.tsx
    └── Thing.stories.tsx
├── LICENSE
├── tsconfig.json
├── package.json
└── TSDX_README.md


/example/.npmignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | .cache
3 | dist


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.log
2 | .DS_Store
3 | node_modules
4 | .cache
5 | dist
6 | 


--------------------------------------------------------------------------------
/src/index.tsx:
--------------------------------------------------------------------------------
1 | export * from './Thing';
2 | export * from './Button';
3 | 


--------------------------------------------------------------------------------
/src/tailwind.css:
--------------------------------------------------------------------------------
1 | @tailwind base;
2 | @tailwind components;
3 | @tailwind utilities;
4 | 


--------------------------------------------------------------------------------
/postcss.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 |   plugins: {
3 |     tailwindcss: {},
4 |     autoprefixer: {},
5 |   },
6 | };
7 | 


--------------------------------------------------------------------------------
/.storybook/preview.js:
--------------------------------------------------------------------------------
1 | // https://storybook.js.org/docs/react/writing-stories/parameters#global-parameters
2 | export const parameters = {
3 |   // https://storybook.js.org/docs/react/essentials/actions#automatically-matching-args
4 |   actions: { argTypesRegex: '^on.*' },
5 | };
6 | 


--------------------------------------------------------------------------------
/.github/workflows/size.yml:
--------------------------------------------------------------------------------
 1 | name: size
 2 | on: [pull_request]
 3 | jobs:
 4 |   size:
 5 |     runs-on: ubuntu-latest
 6 |     env:
 7 |       CI_JOB_NUMBER: 1
 8 |     steps:
 9 |       - uses: actions/checkout@v1
10 |       - uses: andresz1/size-limit-action@v1
11 |         with:
12 |           github_token: ${{ secrets.GITHUB_TOKEN }}
13 | 


--------------------------------------------------------------------------------
/.storybook/main.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 |   stories: ['../stories/**/*.stories.@(ts|tsx|js|jsx)'],
3 |   addons: ['@storybook/addon-links', '@storybook/addon-essentials'],
4 |   // https://storybook.js.org/docs/react/configure/typescript#mainjs-configuration
5 |   typescript: {
6 |     check: true, // type-check stories during Storybook build
7 |   }
8 | };
9 | 


--------------------------------------------------------------------------------
/tailwind.config.js:
--------------------------------------------------------------------------------
 1 | module.exports = {
 2 |   purge: [
 3 |     './src/components/**/*.tsx',
 4 |     './src/components/**/*.styled.ts',
 5 |     './src/components/**/*.styled.tsx',
 6 |   ],
 7 |   darkMode: false, // or 'media' or 'class'
 8 |   theme: {
 9 |     extend: {},
10 |   },
11 |   variants: {
12 |     extend: {},
13 |   },
14 |   plugins: [],
15 | }
16 | 


--------------------------------------------------------------------------------
/example/index.tsx:
--------------------------------------------------------------------------------
 1 | import 'react-app-polyfill/ie11';
 2 | import * as React from 'react';
 3 | import * as ReactDOM from 'react-dom';
 4 | import { Thing, Button } from '../.';
 5 | 
 6 | const App = () => {
 7 |   return (
 8 |     <div>
 9 |       <Thing />
10 |       <Button text="test" />
11 |     </div>
12 |   );
13 | };
14 | 
15 | ReactDOM.render(<App />, document.getElementById('root'));
16 | 


--------------------------------------------------------------------------------
/test/blah.test.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import * as ReactDOM from 'react-dom';
 3 | import { Default as Thing } from '../stories/Thing.stories';
 4 | 
 5 | describe('Thing', () => {
 6 |   it('renders without crashing', () => {
 7 |     const div = document.createElement('div');
 8 |     ReactDOM.render(<Thing />, div);
 9 |     ReactDOM.unmountComponentAtNode(div);
10 |   });
11 | });
12 | 


--------------------------------------------------------------------------------
/example/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="UTF-8" />
 5 |     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 6 |     <meta http-equiv="X-UA-Compatible" content="ie=edge" />
 7 |     <title>Playground</title>
 8 |   </head>
 9 | 
10 |   <body>
11 |     <div id="root"></div>
12 |     <script src="./index.tsx"></script>
13 |   </body>
14 | </html>
15 | 


--------------------------------------------------------------------------------
/tsdx.config.js:
--------------------------------------------------------------------------------
 1 | const postcss = require('rollup-plugin-postcss');
 2 | 
 3 | module.exports = {
 4 |   rollup(config, options) {
 5 |     config.plugins.push(
 6 |       postcss({
 7 |         config: {
 8 |           path: './postcss.config.js',
 9 |         },
10 |         extensions: ['.css'],
11 |         minimize: true,
12 |         inject: {
13 |           insertAt: 'top',
14 |         },
15 |       })
16 |     );
17 |     return config;
18 |   },
19 | };
20 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # How to Build A React TS Tailwind Design System
2 | This repo is the code for the blog post ["How to Build A React TS Tailwind Design System"](https://dev.to/hamatoyogi/how-to-build-a-react-ts-tailwind-design-system-1ppi).
3 | 
4 | You can read along the article and look at the commits which correspond to the sections throughout it.
5 | 
6 | For any questions about this repo, feel free to open issues here or [reach out to me](https://twitter.com/HamatoYogi).
7 | 


--------------------------------------------------------------------------------
/example/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "allowSyntheticDefaultImports": false,
 4 |     "target": "es5",
 5 |     "module": "commonjs",
 6 |     "jsx": "react",
 7 |     "moduleResolution": "node",
 8 |     "noImplicitAny": false,
 9 |     "noUnusedLocals": false,
10 |     "noUnusedParameters": false,
11 |     "removeComments": true,
12 |     "strictNullChecks": true,
13 |     "preserveConstEnums": true,
14 |     "sourceMap": true,
15 |     "lib": ["es2015", "es2016", "dom"],
16 |     "types": ["node"]
17 |   }
18 | }
19 | 


--------------------------------------------------------------------------------
/.vscode/extensions.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
 3 |   // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
 4 | 
 5 |   // List of extensions which should be recommended for users of this workspace.
 6 |   "recommendations": [
 7 |     "bradlc.vscode-tailwindcss",
 8 |     "jpoissonnier.vscode-styled-components",
 9 |     "austenc.tailwind-docs"
10 |   ],
11 |   // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
12 |   "unwantedRecommendations": []
13 | }
14 | 


--------------------------------------------------------------------------------
/stories/Button.stories.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import { Meta, Story } from '@storybook/react';
 3 | import { Button, ButtonProps } from '../src';
 4 | 
 5 | const meta: Meta = {
 6 |   title: 'Button',
 7 |   component: Button,
 8 |   argTypes: {
 9 |     text: {
10 |       control: {
11 |         type: 'text',
12 |       },
13 |     },
14 |   },
15 |   parameters: {
16 |     controls: { expanded: true },
17 |   },
18 | };
19 | 
20 | export default meta;
21 | 
22 | const Template: Story<ButtonProps> = args => <Button {...args} />;
23 | 
24 | export const SCButton = Template.bind({});
25 | 
26 | SCButton.args = { text: 'Button' };
27 | 


--------------------------------------------------------------------------------
/example/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "example",
 3 |   "version": "1.0.0",
 4 |   "main": "index.js",
 5 |   "license": "MIT",
 6 |   "scripts": {
 7 |     "start": "parcel index.html",
 8 |     "build": "parcel build index.html"
 9 |   },
10 |   "dependencies": {
11 |     "react-app-polyfill": "^1.0.0"
12 |   },
13 |   "alias": {
14 |     "react": "../node_modules/react",
15 |     "react-dom": "../node_modules/react-dom/profiling",
16 |     "scheduler/tracing": "../node_modules/scheduler/tracing-profiling"
17 |   },
18 |   "devDependencies": {
19 |     "@types/react": "^16.9.11",
20 |     "@types/react-dom": "^16.8.4",
21 |     "parcel": "^1.12.3",
22 |     "typescript": "^3.4.5"
23 |   }
24 | }
25 | 


--------------------------------------------------------------------------------
/stories/Thing.stories.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import { Meta, Story } from '@storybook/react';
 3 | import { Thing, Props } from '../src';
 4 | 
 5 | const meta: Meta = {
 6 |   title: 'Welcome',
 7 |   component: Thing,
 8 |   argTypes: {
 9 |     children: {
10 |       control: {
11 |         type: 'text',
12 |       },
13 |     },
14 |   },
15 |   parameters: {
16 |     controls: { expanded: true },
17 |   },
18 | };
19 | 
20 | export default meta;
21 | 
22 | const Template: Story<Props> = args => <Thing {...args} />;
23 | 
24 | // By passing using the Args format for exported stories, you can control the props for a component for reuse in a test
25 | // https://storybook.js.org/docs/react/workflows/unit-testing
26 | export const Default = Template.bind({});
27 | 
28 | Default.args = {};
29 | 


--------------------------------------------------------------------------------
/src/Thing.tsx:
--------------------------------------------------------------------------------
 1 | import React, { FC, HTMLAttributes, ReactChild } from 'react';
 2 | import './tailwind.css';
 3 | 
 4 | export interface Props extends HTMLAttributes<HTMLDivElement> {
 5 |   /** custom content, defaults to 'the snozzberries taste like snozzberries' */
 6 |   children?: ReactChild;
 7 | }
 8 | 
 9 | // Please do not use types off of a default export module or else Storybook Docs will suffer.
10 | // see: https://github.com/storybookjs/storybook/issues/9556
11 | /**
12 |  * A custom Thing component. Neat!
13 |  */
14 | export const Thing: FC<Props> = ({ children }) => {
15 |   return (
16 |     <div className="flex items-center justify-center w-5/6 m-auto text-2xl text-center text-pink-700 uppercase bg-yellow-400 shadow-xl rounded-3xl">
17 |       {children || `the snozzberries taste like snozzberries`}
18 |     </div>
19 |   );
20 | };
21 | 


--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "workbench.colorCustomizations": {
 3 |         "activityBar.activeBackground": "#ffff33",
 4 |         "activityBar.activeBorder": "#00bfbf",
 5 |         "activityBar.background": "#ffff33",
 6 |         "activityBar.foreground": "#15202b",
 7 |         "activityBar.inactiveForeground": "#15202b99",
 8 |         "activityBarBadge.background": "#00bfbf",
 9 |         "activityBarBadge.foreground": "#15202b",
10 |         "statusBar.background": "#ffff00",
11 |         "statusBar.foreground": "#15202b",
12 |         "statusBarItem.hoverBackground": "#cccc00",
13 |         "titleBar.activeBackground": "#ffff00",
14 |         "titleBar.activeForeground": "#15202b",
15 |         "titleBar.inactiveBackground": "#ffff0099",
16 |         "titleBar.inactiveForeground": "#15202b99"
17 |     },
18 |     "peacock.color": "yellow"
19 | }


--------------------------------------------------------------------------------
/.github/workflows/main.yml:
--------------------------------------------------------------------------------
 1 | name: CI
 2 | on: [push]
 3 | jobs:
 4 |   build:
 5 |     name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
 6 | 
 7 |     runs-on: ${{ matrix.os }}
 8 |     strategy:
 9 |       matrix:
10 |         node: ['10.x', '12.x', '14.x']
11 |         os: [ubuntu-latest, windows-latest, macOS-latest]
12 | 
13 |     steps:
14 |       - name: Checkout repo
15 |         uses: actions/checkout@v2
16 | 
17 |       - name: Use Node ${{ matrix.node }}
18 |         uses: actions/setup-node@v1
19 |         with:
20 |           node-version: ${{ matrix.node }}
21 | 
22 |       - name: Install deps and build (with cache)
23 |         uses: bahmutov/npm-install@v1
24 | 
25 |       - name: Lint
26 |         run: yarn lint
27 | 
28 |       - name: Test
29 |         run: yarn test --ci --coverage --maxWorkers=2
30 | 
31 |       - name: Build
32 |         run: yarn build
33 | 


--------------------------------------------------------------------------------
/src/Button.tsx:
--------------------------------------------------------------------------------
 1 | import React, { FC, ButtonHTMLAttributes } from 'react';
 2 | import styled from 'styled-components';
 3 | 
 4 | const StyledButton = styled.button.attrs(
 5 |   ({ variant }: { variant: ButtonVariants }) => ({
 6 |     className: `px-8 py-2 font-semibold ${
 7 |       variant === 'default' ? 'text-white' : 'text-red-700'
 8 |     } transition duration-500 ease-in-out transform rounded-lg shadow-xl bg-gradient-to-r from-red-300 to-blue-300 hover:from-pink-400 hover:to-indigo-400`,
 9 |   })
10 | )<{ variant: ButtonVariants }>``;
11 | 
12 | type ButtonVariants = 'default' | 'warning';
13 | export interface ButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
14 |   text: string;
15 |   variant?: ButtonVariants;
16 | }
17 | 
18 | export const Button: FC<ButtonProps> = ({
19 |   text,
20 |   variant = 'default',
21 |   ...rest
22 | }) => {
23 |   return (
24 |     <StyledButton variant={variant} {...rest}>
25 |       {text}
26 |     </StyledButton>
27 |   );
28 | };
29 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2021 Yoav Ganbar
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   // see https://www.typescriptlang.org/tsconfig to better understand tsconfigs
 3 |   "include": ["src", "types"],
 4 |   "compilerOptions": {
 5 |     "module": "esnext",
 6 |     "lib": ["dom", "esnext"],
 7 |     "importHelpers": true,
 8 |     // output .d.ts declaration files for consumers
 9 |     "declaration": true,
10 |     // output .js.map sourcemap files for consumers
11 |     "sourceMap": true,
12 |     // match output dir to input dir. e.g. dist/index instead of dist/src/index
13 |     "rootDir": "./src",
14 |     // stricter type-checking for stronger correctness. Recommended by TS
15 |     "strict": true,
16 |     // linter checks for common issues
17 |     "noImplicitReturns": true,
18 |     "noFallthroughCasesInSwitch": true,
19 |     // noUnused* overlap with @typescript-eslint/no-unused-vars, can disable if duplicative
20 |     "noUnusedLocals": true,
21 |     "noUnusedParameters": true,
22 |     // use Node's module resolution algorithm, instead of the legacy TS one
23 |     "moduleResolution": "node",
24 |     // transpile JSX to React.createElement
25 |     "jsx": "react",
26 |     // interop between ESM and CJS modules. Recommended by TS
27 |     "esModuleInterop": true,
28 |     // significant perf increase by skipping checking .d.ts files, particularly those in node_modules. Recommended by TS
29 |     "skipLibCheck": true,
30 |     // error out if import and file system have a casing mismatch. Recommended by TS
31 |     "forceConsistentCasingInFileNames": true,
32 |     // `tsdx build` ignores this option, but it is commonly used when type-checking separately with `tsc`
33 |     "noEmit": true,
34 |   }
35 | }
36 | 


--------------------------------------------------------------------------------
/test/Button.test.tsx:
--------------------------------------------------------------------------------
 1 | import * as React from 'react';
 2 | import { render, fireEvent } from '@testing-library/react';
 3 | import '@testing-library/jest-dom/extend-expect';
 4 | import { SCButton as Button } from '../stories/Button.stories';
 5 | 
 6 | describe('Button', () => {
 7 |   it('should render the button without crashing', () => {
 8 |     // render the button and get the getByRole method
 9 |     const { getByRole } = render(<Button text="test" />);
10 | 
11 |     // getByRole as its name gets a selector by its role.
12 |     // in this case we're looking for a `button`.
13 |     // then we make sure it's in the document
14 |     expect(getByRole('button')).toBeInTheDocument();
15 |   });
16 | 
17 |   it('should call the onClick method when a user clicks on the button', () => {
18 |     // mock out our OnClick function
19 |     const mockClick = jest.fn();
20 | 
21 |     const { getByRole } = render(<Button text="test" onClick={mockClick} />);
22 | 
23 |     // we store a variable with the button element
24 |     const buttonElement = getByRole('button', { name: 'test' });
25 | 
26 |     // Simulate a user clicking on the button
27 |     fireEvent.click(buttonElement);
28 | 
29 |     // check that the function was called once;
30 |     expect(mockClick).toHaveBeenCalledTimes(1);
31 |   });
32 | 
33 |   it('should have the right text color class name for variants', () => {
34 |     // we extract the "rerender" method to test both variants
35 |     const { getByRole, rerender } = render(<Button text="test" />);
36 | 
37 |     const buttonElement = getByRole('button', { name: 'test' });
38 | 
39 |     // if you recall, passing no variant, defaults to "default" variant.
40 |     // this is a bit robust, but it serves to illustarte the point
41 |     expect(buttonElement.classList.contains('text-white')).toBe(true);
42 |     expect(buttonElement.classList.contains('text-red-700')).toBe(false);
43 | 
44 |     // render the other "warning" variant
45 |     rerender(<Button text={'test'} variant="warning" />);
46 | 
47 |     // test the opposite of the above:
48 |     expect(buttonElement.classList.contains('text-white')).toBe(false);
49 |     expect(buttonElement.classList.contains('text-red-700')).toBe(true);
50 |   });
51 | });
52 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "version": "0.1.0",
 3 |   "license": "MIT",
 4 |   "main": "dist/index.js",
 5 |   "typings": "dist/index.d.ts",
 6 |   "files": [
 7 |     "dist",
 8 |     "src"
 9 |   ],
10 |   "engines": {
11 |     "node": ">=12.13"
12 |   },
13 |   "scripts": {
14 |     "start": "tsdx watch",
15 |     "build": "NODE_ENV=production tsdx build",
16 |     "test": "tsdx test --passWithNoTests",
17 |     "lint": "tsdx lint",
18 |     "prepare": "tsdx build",
19 |     "size": "size-limit",
20 |     "analyze": "size-limit --why",
21 |     "storybook": "start-storybook -p 6006",
22 |     "build-storybook": "build-storybook",
23 |     "chromatic": "npx chromatic --project-token f6e38b79b78a"
24 |   },
25 |   "peerDependencies": {
26 |     "react": ">=16"
27 |   },
28 |   "husky": {
29 |     "hooks": {
30 |       "pre-commit": "tsdx lint"
31 |     }
32 |   },
33 |   "prettier": {
34 |     "printWidth": 80,
35 |     "semi": true,
36 |     "singleQuote": true,
37 |     "trailingComma": "es5"
38 |   },
39 |   "name": "react-tw-blog-post",
40 |   "author": "Yoav Ganbar",
41 |   "module": "dist/react-tw-blog-post.esm.js",
42 |   "size-limit": [
43 |     {
44 |       "path": "dist/react-tw-blog-post.cjs.production.min.js",
45 |       "limit": "10 KB"
46 |     },
47 |     {
48 |       "path": "dist/react-tw-blog-post.esm.js",
49 |       "limit": "10 KB"
50 |     }
51 |   ],
52 |   "devDependencies": {
53 |     "@babel/core": "^7.12.13",
54 |     "@size-limit/preset-small-lib": "^4.9.2",
55 |     "@storybook/addon-essentials": "^6.1.17",
56 |     "@storybook/addon-info": "^5.3.21",
57 |     "@storybook/addon-links": "^6.1.17",
58 |     "@storybook/addons": "^6.1.17",
59 |     "@storybook/react": "^6.1.17",
60 |     "@tailwindcss/postcss7-compat": "^2.0.3",
61 |     "@testing-library/jest-dom": "^5.11.9",
62 |     "@testing-library/react": "^11.2.5",
63 |     "@types/react": "^17.0.1",
64 |     "@types/react-dom": "^17.0.0",
65 |     "@types/styled-components": "^5.1.7",
66 |     "autoprefixer": "^9",
67 |     "babel-loader": "^8.2.2",
68 |     "chromatic": "^5.6.2",
69 |     "husky": "^4.3.8",
70 |     "identity-obj-proxy": "^3.0.0",
71 |     "postcss": "^7",
72 |     "react": "^17.0.1",
73 |     "react-dom": "^17.0.1",
74 |     "react-is": "^17.0.1",
75 |     "rollup-plugin-postcss": "^4.0.0",
76 |     "size-limit": "^4.9.2",
77 |     "styled-components": "^5.2.1",
78 |     "tailwindcss": "npm:@tailwindcss/postcss7-compat",
79 |     "tsdx": "^0.14.1",
80 |     "tslib": "^2.1.0",
81 |     "typescript": "^4.1.3"
82 |   },
83 |   "jest": {
84 |     "moduleNameMapper": {
85 |       "\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": "<rootDir>/__mocks__/fileMock.js",
86 |       "\\.(css|less|scss|sass)$": "identity-obj-proxy"
87 |     }
88 |   }
89 | }
90 | 


--------------------------------------------------------------------------------
/TSDX_README.md:
--------------------------------------------------------------------------------
  1 | # TSDX React w/ Storybook User Guide
  2 | 
  3 | Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
  4 | 
  5 | > This TSDX setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.
  6 | 
  7 | > If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
  8 | 
  9 | ## Commands
 10 | 
 11 | TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.
 12 | 
 13 | The recommended workflow is to run TSDX in one terminal:
 14 | 
 15 | ```bash
 16 | npm start # or yarn start
 17 | ```
 18 | 
 19 | This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
 20 | 
 21 | Then run either Storybook or the example playground:
 22 | 
 23 | ### Storybook
 24 | 
 25 | Run inside another terminal:
 26 | 
 27 | ```bash
 28 | yarn storybook
 29 | ```
 30 | 
 31 | This loads the stories from `./stories`.
 32 | 
 33 | > NOTE: Stories should reference the components as if using the library, similar to the example playground. This means importing from the root project directory. This has been aliased in the tsconfig and the storybook webpack config as a helper.
 34 | 
 35 | ### Example
 36 | 
 37 | Then run the example inside another:
 38 | 
 39 | ```bash
 40 | cd example
 41 | npm i # or yarn to install dependencies
 42 | npm start # or yarn start
 43 | ```
 44 | 
 45 | The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).
 46 | 
 47 | To do a one-off build, use `npm run build` or `yarn build`.
 48 | 
 49 | To run tests, use `npm test` or `yarn test`.
 50 | 
 51 | ## Configuration
 52 | 
 53 | Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
 54 | 
 55 | ### Jest
 56 | 
 57 | Jest tests are set up to run with `npm test` or `yarn test`.
 58 | 
 59 | ### Bundle analysis
 60 | 
 61 | Calculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `npm run size` and visulize it with `npm run analyze`.
 62 | 
 63 | #### Setup Files
 64 | 
 65 | This is the folder structure we set up for you:
 66 | 
 67 | ```txt
 68 | /example
 69 |   index.html
 70 |   index.tsx       # test your component here in a demo app
 71 |   package.json
 72 |   tsconfig.json
 73 | /src
 74 |   index.tsx       # EDIT THIS
 75 | /test
 76 |   blah.test.tsx   # EDIT THIS
 77 | /stories
 78 |   Thing.stories.tsx # EDIT THIS
 79 | /.storybook
 80 |   main.js
 81 |   preview.js
 82 | .gitignore
 83 | package.json
 84 | README.md         # EDIT THIS
 85 | tsconfig.json
 86 | ```
 87 | 
 88 | #### React Testing Library
 89 | 
 90 | We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
 91 | 
 92 | ### Rollup
 93 | 
 94 | TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
 95 | 
 96 | ### TypeScript
 97 | 
 98 | `tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
 99 | 
100 | ## Continuous Integration
101 | 
102 | ### GitHub Actions
103 | 
104 | Two actions are added by default:
105 | 
106 | - `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
107 | - `size` which comments cost comparison of your library on every pull request using [size-limit](https://github.com/ai/size-limit)
108 | 
109 | ## Optimizations
110 | 
111 | Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
112 | 
113 | ```js
114 | // ./types/index.d.ts
115 | declare var __DEV__: boolean;
116 | 
117 | // inside your code...
118 | if (__DEV__) {
119 |   console.log('foo');
120 | }
121 | ```
122 | 
123 | You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
124 | 
125 | ## Module Formats
126 | 
127 | CJS, ESModules, and UMD module formats are supported.
128 | 
129 | The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
130 | 
131 | ## Deploying the Example Playground
132 | 
133 | The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
134 | 
135 | ```bash
136 | cd example # if not already in the example folder
137 | npm run build # builds to dist
138 | netlify deploy # deploy the dist folder
139 | ```
140 | 
141 | Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
142 | 
143 | ```bash
144 | netlify init
145 | # build command: yarn build && cd example && yarn && yarn build
146 | # directory to deploy: example/dist
147 | # pick yes for netlify.toml
148 | ```
149 | 
150 | ## Named Exports
151 | 
152 | Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
153 | 
154 | ## Including Styles
155 | 
156 | There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
157 | 
158 | 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.
159 | 
160 | ## Publishing to NPM
161 | 
162 | We recommend using [np](https://github.com/sindresorhus/np).
163 | 
164 | ## Usage with Lerna
165 | 
166 | When creating a new package with TSDX within a project set up with Lerna, you might encounter a `Cannot resolve dependency` error when trying to run the `example` project. To fix that you will need to make changes to the `package.json` file _inside the `example` directory_.
167 | 
168 | The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example 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.
169 | 
170 | 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.
171 | 
172 | ```diff
173 |    "alias": {
174 | -    "react": "../node_modules/react",
175 | -    "react-dom": "../node_modules/react-dom"
176 | +    "react": "../../../node_modules/react",
177 | +    "react-dom": "../../../node_modules/react-dom"
178 |    },
179 | ```
180 | 
181 | 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.](https://github.com/palmerhq/tsdx/issues/64)
182 | 


--------------------------------------------------------------------------------