Skip to content

Commit 555a5e4

Browse files
committed
docs: add TypeScript Aware Rules
1 parent c04fbb1 commit 555a5e4

File tree

4 files changed

+10
-1
lines changed

4 files changed

+10
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ add you like rules to your `.eslintrc` file:
9090
```
9191
### TypeScript Aware Rules
9292

93-
Type aware rules are enabled when a `tsconfig.eslint.json` is found in the project root. Refer to [this file](https://github.com/kirklin/eslint-config/blob/main/packages/typescript/index.js#L17).
93+
Type aware rules are enabled when a `tsconfig.eslint.json` is found in the project root. Refer to [this file](https://github.com/kirklin/eslint-config/blob/master/packages/typescript/index.js#L17).
9494

9595
## Badge
9696

README.zh-cn.md

+3
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ pnpm add -D eslint @kirklin/eslint-config
9292
}
9393
}
9494
```
95+
### TypeScript Aware Rules
96+
97+
当在项目根目录中找到`tsconfig.eslint.json`时,将启用Type Aware Rules, [参阅此处](https://github.com/kirklin/eslint-config/blob/master/packages/typescript/index.js#L17).
9598

9699
## 徽章
97100
在你的README中包括一个这样的徽章,以便让人们知道你的代码使用的是哪种ESLint样式。

packages/all/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,9 @@ add you like rules to your `.eslintrc` file:
8888
}
8989
}
9090
```
91+
### TypeScript Aware Rules
92+
93+
Type aware rules are enabled when a `tsconfig.eslint.json` is found in the project root. Refer to [this file](https://github.com/kirklin/eslint-config/blob/master/packages/typescript/index.js#L17).
9194

9295
## Badge
9396

packages/all/README.zh-cn.md

+3
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ pnpm add -D eslint @kirklin/eslint-config
9292
}
9393
}
9494
```
95+
### TypeScript Aware Rules
96+
97+
当在项目根目录中找到`tsconfig.eslint.json`时,将启用Type Aware Rules, [参阅此处](https://github.com/kirklin/eslint-config/blob/master/packages/typescript/index.js#L17).
9598

9699
## 徽章
97100
在你的README中包括一个这样的徽章,以便让人们知道你的代码使用的是哪种ESLint样式。

0 commit comments

Comments
 (0)