Skip to content

Commit

Permalink
docs: remove misleading part about module resolution (#596)
Browse files Browse the repository at this point in the history
TypeScript module resolution works differently than stated in the
README.md
  • Loading branch information
piotr-oles committed Apr 21, 2021
1 parent b38cbcb commit 5b7c333
Showing 1 changed file with 0 additions and 1 deletion.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ module.exports = {

It's very important to be aware that **this plugin uses [TypeScript](https://github.com/Microsoft/TypeScript)'s, not
[webpack](https://github.com/webpack/webpack)'s modules resolution**. It means that you have to setup `tsconfig.json` correctly.
For example if you set `files: ['./src/index.ts']` in `tsconfig.json`, this plugin will check only `index.ts` for errors.

> It's because of the performance - with TypeScript's module resolution we don't have to wait for webpack to compile files.
>
Expand Down

0 comments on commit 5b7c333

Please sign in to comment.