Skip to content

Commit adc5e53

Browse files
committed
docs: synchronize snippet reference
- expose every configuration default in a responsive layout - align documented examples with the generated catalog - enforce exact prefix and manifest-default parity in tests
1 parent a5e6d19 commit adc5e53

5 files changed

Lines changed: 273 additions & 167 deletions

File tree

‎README.md‎

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,39 @@ See [CHANGELOG.md](./CHANGELOG.md) for the full list.
6767

6868
Settings live under `reactSnippets.settings.*`. They are application-scoped because VS Code windows share one generated snippet artifact. Reload VS Code when prompted after a change.
6969

70-
- **`importReactOnTop`** — boolean, default: `false`. Adds `import React from 'react'` to component snippets for projects using the legacy JSX transform.
71-
- **`typescript`** — boolean, default: `true`. Includes TypeScript-specific `ts*`, `exptp`, and `expint` snippets.
72-
- **`languageScopes`** — string. Defaults to TypeScript, TypeScript React, JavaScript, and JavaScript React. Accepts a comma-separated list of VS Code language identifiers.
73-
- **`typescriptPropsStatePrefix`** — string, default: `type`. Use `type` or `interface` for Props and State declarations in TypeScript snippets.
70+
### `importReactOnTop`
71+
72+
**Type:** `boolean`
73+
74+
**Default:** `false`
75+
76+
Adds `import React from 'react'` to component snippets for projects using the legacy JSX transform.
77+
78+
### `typescript`
79+
80+
**Type:** `boolean`
81+
82+
**Default:** `true`
83+
84+
Includes TypeScript-specific `ts*`, `exptp`, and `expint` snippets.
85+
86+
### `languageScopes`
87+
88+
**Type:** `string`
89+
90+
**Default:** `typescript`, `typescriptreact`, `javascript`, `javascriptreact`
91+
92+
Accepts a comma-separated list of VS Code language identifiers.
93+
94+
### `typescriptPropsStatePrefix`
95+
96+
**Type:** `string`
97+
98+
**Default:** `type`
99+
100+
**Allowed values:** `type`, `interface`
101+
102+
Controls whether Props and State declarations use type aliases or interfaces in TypeScript snippets.
74103

75104
## Editor support
76105

0 commit comments

Comments
 (0)