From cbe2df7776a0a8a732f0f33732cf4d7d061de2ca Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Thu, 10 Dec 2020 09:04:00 -0800 Subject: [PATCH] Clarify example in README --- README.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index ebe384f..b27871b 100644 --- a/README.md +++ b/README.md @@ -62,33 +62,26 @@ Add the following to your `.eslintrc` config: "@typescript-eslint/parser": [".ts", ".tsx"] }, "import/resolver": { - // use /tsconfig.json "typescript": { - "alwaysTryTypes": true // always try to resolve types under `@types` directory even it doesn't contain any source code, like `@types/unist` - }, + "alwaysTryTypes": true, // always try to resolve types under `@types` directory even it doesn't contain any source code, like `@types/unist` - // use /path/to/folder/tsconfig.json - "typescript": { - "project": "path/to/folder" - }, + // Choose from one of the "project" configs below or omit to use /tsconfig.json by default - // Multiple tsconfigs (Useful for monorepos) + // use /path/to/folder/tsconfig.json + "project": "path/to/folder", - // use a glob pattern - "typescript": { - "project": "packages/*/tsconfig.json" - }, + // Multiple tsconfigs (Useful for monorepos) - // use an array - "typescript": { + // use a glob pattern + "project": "packages/*/tsconfig.json", + + // use an array "project": [ "packages/module-a/tsconfig.json", "packages/module-b/tsconfig.json" - ] - }, + ], - // use an array of glob patterns - "typescript": { + // use an array of glob patterns "project": [ "packages/*/tsconfig.json", "other-packages/*/tsconfig.json"