feat: parserOptions.project=true

closes #1230

Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>

.eslintrc.json

@@ -2,10 +2,7 @@
   "overrides": [
     {
       "files": ["*.js", "*.ts"],
-      "extends": "./lib/index.js",
-      "parserOptions": {
-        "project": "./tsconfig.json"
-      }
+      "extends": "./lib/index.js"
     }
   ]
 }

readme.md

@@ -57,16 +57,14 @@ module.exports = {
   overrides: [
     {
       files: ['*.js', '*.jsx', '*.ts', '*.tsx'],
-      extends: 'standard-with-typescript',
-      parserOptions: {
-        project: './tsconfig.json'
-      }
+      extends: 'standard-with-typescript'
     }
   ],
 }
 ```
 
-Note: Please read some important instructions regarding the `project` option [here](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/README.md#configuration).
+Note: the config exported by this package sets `parserOptions.project = true`.
+Read about the `project` option [here](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/README.md#configuration).
 
 There are [some more `parserOptions`](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/README.md#configuration) you may care about.
 

src/index.test.ts

@@ -52,6 +52,9 @@ test('export', (t): void => {
     extends: 'eslint-config-standard',
     plugins: ['@typescript-eslint'],
     parser: '@typescript-eslint/parser',
+    parserOptions: {
+      project: true
+    },
     rules: {
       'block-spacing': 'off',
       'brace-style': 'off',

src/index.ts

@@ -47,6 +47,9 @@ const config: Linter.Config = {
   extends: 'eslint-config-standard',
   plugins: ['@typescript-eslint'],
   parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: true
+  },
   rules: {
     'comma-dangle': 'off',