https://github.com/pinterest/vscode-gestalt
Visual Studio Code extension for Gestalt, Pinterest's design system
https://github.com/pinterest/vscode-gestalt
gestalt vscode
Last synced: 3 months ago
JSON representation
Visual Studio Code extension for Gestalt, Pinterest's design system
- Host: GitHub
- URL: https://github.com/pinterest/vscode-gestalt
- Owner: pinterest
- License: apache-2.0
- Created: 2021-07-29T17:01:42.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-27T04:23:09.000Z (5 months ago)
- Last Synced: 2025-06-09T15:11:29.550Z (4 months ago)
- Topics: gestalt, vscode
- Language: TypeScript
- Homepage:
- Size: 3.8 MB
- Stars: 9
- Watchers: 14
- Forks: 9
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VSCode Gestalt
Visual Studio Code extension for [Gestalt](https://gestalt.pinterest.systems/), Pinterest's design system
## Features
### Snippets
- **List Gestalt components** by typing `<` or pressing `Alt+G`/`Option+G`
- **Required props** are included
- **Quick select** boolean & enum props
## Extension Settings
| Setting | Type (default) | Description |
| :------------------------ | :----------------- | :----------------------- |
| `gestalt.enableTelemetry` | `boolean` (`true`) | Enable/disable telemetry |
## Release Notes
See [Changelog](./CHANGELOG.md)
## Publish
Publish a new version:
1. Update `CHANGELOG.md` and add a new version
2. Publish with `vsce`
```
npm i -g vsce
vsce publish patch
```
## TODO
- React hooks support. Depends on https://github.com/reactjs/react-docgen/issues/332
- Change testing framework from `mocha` to `jest`: https://github.com/microsoft/vscode-extension-samples/pull/251/files
## FAQ
### How do the snippets work?
- Use [react-docgen](https://github.com/reactjs/react-docgen) to get required React props for every Gestalt component
- Generate the `snippets.json` file
### The extension doesn't seem to work, what can I do to debug?
1. Do not override `editor.quickSuggestions` in your user settings
2. Use VSCode >= 1.58.0
Then restart your editor and copy/paste the output in the `Gestalt` output log.