search

microsoft / vscode-typescript-tslint-plugin

VS Code extension that provides TSLint support using the typescript-tslint-plugin
https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-tslint-plugin
MIT License
188 stars 34 forks source link

Unclear README wording around usage and requirements #28

Closed jmlane closed 5 years ago

jmlane commented 5 years ago

As per the README.md:

Usage

[...] This extension works out of the box with VS Code's built-in version of TypeScript. You do not need to configure the plugin in your tsconfig.json if you are using VS Code's version of TypeScript. [...]

Differences with the vscode-TSLint extension

[...] This extension requires that the tslint and typescript modules are installed either locally or globally. [...]

The quoted statements are confusing and seemingly contradictory: if the extension "works out of the box with VS Code's built-in version of TypeScript", why are the tslint and typescript modules required?

If the npm modules are required, that should probably be stated upfront, rather than left to the bottom of the readme.

If "works out of the box" means you don't need to specify the plugin config, that statement needs to be reworded to make this clear. The current wording reads as if you don't need to install anything additional (tslint, typescript) and can use a bundled version of TypeScript.

I will happily submit a PR with changes once the intended information is clarified for me.

mjbvz commented 5 years ago

Yes you need to install tslint either locally or globally