Skip to content

Document a gotcha where linking this package leads to conflicting @types/react copies #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 7, 2023
Merged

Document a gotcha where linking this package leads to conflicting @types/react copies #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .storybook/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const config: StorybookConfig = {

publicDir: "res",
};
}
},
};

export default config;
22 changes: 16 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,20 @@ React implementation of Compound – Element's design system – See full docume

## Commands

| Command | Runs |
| ------- | ---- |
| `yarn dev` | Runs a local development environment |
| `yarn test` | Tests all components |
| `yarn lint` | Lints all components |
| `yarn gen:component $name` | Bootstraps a new component |
| Command | Runs |
| -------------------------- | ------------------------------------ |
| `yarn dev` | Runs a local development environment |
| `yarn test` | Tests all components |
| `yarn lint` | Lints all components |
| `yarn gen:component $name` | Bootstraps a new component |

## Development

If you want to work on Compound Web as a linked package within a larger React application, TypeScript might complain about there being multiple copies of @types/react in the tree. You can work around this by linking Compound Web's copy of @types/react to your application's copy:

```bash
$ cd my-application/node_modules/@types/react
$ yarn link
$ cd ../../../../compound-web
$ yarn link @types/react
```