Skip to content

Commit

Permalink
docs(parser): clarify project references
Browse files Browse the repository at this point in the history
Closes #856
  • Loading branch information
bradzacher committed Aug 19, 2019
1 parent 9e5f21e commit 8ff2ef1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion packages/parser/README.md
Expand Up @@ -66,9 +66,11 @@ The following additional configuration options are available by specifying them
];
```

- Note that if you use project references, TypeScript will not automatically use project references to resolve files. This means that you will have to add each referenced tsconfig to the `project` field either separately, or via a glob.

- Note that if this setting is specified and `createDefaultProgram` is not, you must only lint files that are included in the projects as defined by the provided `tsconfig.json` files. If your existing configuration does not include all of the files you would like to lint, you can create a separate `tsconfig.eslint.json` as follows:

```js
```jsonc
{
// extend your base config so you don't have to redefine your compilerOptions
"extends": "./tsconfig.json",
Expand Down

0 comments on commit 8ff2ef1

Please sign in to comment.