This repository has been archived by the owner on Oct 30, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Closes #1
- Loading branch information
Showing
1 changed file
with
15 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,23 @@ | ||
# @types\_\_carbon-icons-react | ||
|
||
> Generate source code for `@types/carbon__icons-react` | ||
> Generate source code for [@types/carbon\_\_icons-react](https://www.npmjs.com/package/@types/carbon__icons-react) | ||
This repo generates TypeScript definitions for the [@carbon/icons-react](https://github.com/carbon-design-system/carbon/tree/main/packages/icons-react) icon library using the [@carbon/icons](https://www.npmjs.com/package/@carbon/icons) package. | ||
|
||
## Prerequisites | ||
|
||
This repo uses `bun`. See the docs for [installation instructions](https://bun.sh/docs/installation). | ||
|
||
## Runbook | ||
|
||
1. Upgrade `@carbon/icons`. | ||
1. Manually upgrade the minor version of `@carbon/icons`. | ||
2. Run `bun generate-types`. | ||
3. Copy files from `dist/` to DefinitelyTyped. | ||
|
||
## License | ||
- This will generate the source code in `dist/`. | ||
- If there are changes, the `tests/index.test.ts` should expectedly fail. Fix the broken test and commit the changes. | ||
|
||
If there are changes, perform the following steps to update the type definitions: | ||
|
||
[MIT](LICENSE) | ||
1. Fork https://github.com/DefinitelyTyped/DefinitelyTyped. | ||
2. Create a new branch (e.g., `carbon-icons-react-<version>`). | ||
3. Copy the generated files from `dist/` to `DefinitelyTyped/types/carbon__icons-react`. |