Skip to content

Commit 2d209ee

Browse files
danielwerthendanielwerthen
committed
Start with docs
1 parent d0d02b3 commit 2d209ee

File tree

2 files changed

+189
-176
lines changed

2 files changed

+189
-176
lines changed

‎README.md‎

Lines changed: 8 additions & 176 deletions
Original file line numberDiff line numberDiff line change
@@ -1,181 +1,13 @@
1-
# TSDX React w/ Storybook User Guide
1+
# Reacṭ̣-Observe-Async!
22

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.
3+
This library is an collection of my favorite ways of dealing with asynchronous state and side effects.
44

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`.
5+
## useAsync
66

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-
},
7+
```tsx
8+
const { result, pending, error, refresh } = useAsync(() => {
9+
return fetch('https://jsonplaceholder.typicode.com/todos/');
10+
}, []);
17911
```
18012

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)
13+
The `useAsync` hook allows you to call asynchronous closures and retrieve the output in a painless way, and at the same time reduce the number of unnecessary rerenderings. It follows the convention of the standard react hooks in terms of the second dependency array.

‎TSDX-notes.md‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
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)

0 commit comments

Comments
 (0)