Skip to content

Commit 791be37

Browse files
committed
fix(config): simplify instructions for generating type definitions
1 parent 8509b8c commit 791be37

File tree

2 files changed

+2
-26
lines changed

2 files changed

+2
-26
lines changed

packages/config/lib/eslint.ts

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,7 @@ type Severity = boolean | 'error' | 'warn';
3737
*
3838
* ⚠️ **Type definitions not generated**
3939
*
40-
* Please add `@tsslint/config` to `pnpm.onlyBuiltDependencies` in your `package.json` to allow the postinstall script to run.
41-
*
42-
* ```json
43-
* {
44-
* "pnpm": {
45-
* "onlyBuiltDependencies": ["@tsslint/config"]
46-
* }
47-
* }
48-
* ```
49-
*
50-
* After that, run `pnpm install` again to generate type definitions.
51-
*
52-
* If the type definitions become outdated, please run `npx tsslint-docgen` to update them.
40+
* Please run `npx tsslint-docgen` to update them.
5341
*/
5442
export async function importESLintRules(
5543
config: { [K in keyof ESLintRulesConfig]: Severity | [Severity, ...ESLintRulesConfig[K]] },

packages/config/lib/tslint.ts

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,7 @@ type Severity = boolean | 'error' | 'warn';
1414
*
1515
* ⚠️ **Type definitions not generated**
1616
*
17-
* Please add `@tsslint/config` to `pnpm.onlyBuiltDependencies` in your `package.json` to allow the postinstall script to run.
18-
*
19-
* ```json
20-
* {
21-
* "pnpm": {
22-
* "onlyBuiltDependencies": ["@tsslint/config"]
23-
* }
24-
* }
25-
* ```
26-
*
27-
* After that, run `pnpm install` again to generate type definitions.
28-
*
29-
* If the type definitions become outdated, please run `npx tsslint-docgen` to update them.
17+
* Please run `npx tsslint-docgen` to update them.
3018
*/
3119
export async function importTSLintRules(
3220
config: { [K in keyof TSLintRulesConfig]: Severity | [Severity, ...TSLintRulesConfig[K]] },

0 commit comments

Comments
 (0)