Skip to content

Commit fcec978

Browse files
committed
docs: add a note about tsconfig.json and path aliases
1 parent 16960c1 commit fcec978

File tree

1 file changed

+5
-0
lines changed
  • packages/eslint-config-standard-with-typescript

1 file changed

+5
-0
lines changed

packages/eslint-config-standard-with-typescript/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ module.exports = {
3434
}
3535
```
3636

37+
## Aliases
38+
39+
This ruleset automatically reads the [TypeScript path mappings](https://www.typescriptlang.org/tsconfig#paths) from `**/tsconfig.json` and `**/tsconfig.*.json` files in the project. You don't need any additional configuration to set up aliases.
40+
If your TSConfig files are in a different location, please refer to the [Non-Conventional TSConfig Locations](#non-conventional-tsconfig-locations) section.
41+
3742
## JS Support in `.vue` Files
3843

3944
By default this ruleset only allows using `<script lang="ts">` (and `<script setup lang="ts">`) in `.vue` files.

0 commit comments

Comments
 (0)