https://github.com/metonym/-types__carbon-pictograms-react

Generate source code for @types/carbon__pictograms-react
https://github.com/metonym/-types__carbon-pictograms-react

carbon-pictograms definitelytyped typescript

Last synced: about 1 month ago
JSON representation

Generate source code for @types/carbon__pictograms-react

• Host: GitHub
• URL: https://github.com/metonym/-types__carbon-pictograms-react
• Owner: metonym
• Created: 2024-01-20T16:29:15.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-09-15T18:03:40.000Z (2 months ago)
• Last Synced: 2024-09-16T19:17:34.879Z (2 months ago)
• Topics: carbon-pictograms, definitelytyped, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@types/carbon__pictograms-react
• Size: 25.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @types\_\_carbon-pictograms-react

This repository generates TypeScript definitions ([@types/carbon\_\_pictograms-react](https://www.npmjs.com/package/@types/carbon__pictograms-react)) for the [@carbon/pictograms-react](https://github.com/carbon-design-system/carbon/tree/main/packages/pictograms-react) pictogram library using the [@carbon/pictograms](https://www.npmjs.com/package/@carbon/pictograms) package.

## Prerequisites

- [Bun](https://bun.sh/docs/installation)

## Set-up

Install the dependencies:

```sh

bun install

```

## Runbook

### 1. Upgrade the minor version of `@carbon/pictograms`.

Manually upgrade the `@carbon/pictograms` version in the `package.json`.

> [!NOTE]  

> The `@carbon/pictograms` version should be pinned.

```json

{

  "dependencies": {

    "@carbon/pictograms": ""

  }

}

```

### 2. Run `bun generate-types`.

- 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:

1. Fork https://github.com/DefinitelyTyped/DefinitelyTyped.

2. Create a new branch (e.g., `carbon-pictograms-react-`).

3. Copy the generated files from `dist/` to `DefinitelyTyped/types/carbon__pictograms-react`.