From 062f3be6ef6bc43576a78a9545251a8a41ac1a06 Mon Sep 17 00:00:00 2001 From: Mark Stacey Date: Wed, 16 Nov 2022 10:39:57 -0330 Subject: [PATCH] Add more setup instructions to `@metamask/typescript-eslint-config` README (#209) * Add more setup instructions to `@metamask/typescript-eslint-config` README Additional instructions have been added to explain how to configure ESLint to support rules that require type information. * Remove unnecessary tsconfig change * Remove unnecessary setting of project tsconfig --- packages/typescript/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/packages/typescript/README.md b/packages/typescript/README.md index adbae530..9fcdc59f 100644 --- a/packages/typescript/README.md +++ b/packages/typescript/README.md @@ -40,5 +40,11 @@ module.exports = { extends: ['@metamask/eslint-config-typescript'], }, ], + + // This is required for rules that use type information. + // See here for more information: https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TYPED_LINTING.md + parserOptions: { + tsconfigRootDir: __dirname, + }, }; ```