VisualLinter

Visual Studio JavaScript linter using ESLint.

See the change log for changes and road map.

Table of Contents

• Features
• Getting Started
• Language Support
• Troubleshooting
• Contribute
• Thanks to

Features

• Lint files using ESLint on file open/save. (see Language Support)
• Visually mark errors in open document
• Include tooltip (mouseover) content with info on errors/warnings
• Works together with other popular extensions like ReSharper

• Fully integrated with Visual Studio error list

Getting Started

Requirements

• ESLint installed locally (per project) or globally (ESLint added to PATH)
• A valid ESLint config located in the current project directory (local) or your user home directory (~/.eslintrc, global)

Notes

VisualLinter will always use the closest installation/config found relative to the file being linted. If no node_modules directory or .eslintrc file is found in the same directory as the file being linted, VisualLinter will try and resolve the paths from ancestor directories up to, but not including the root directory (e.g. C:\\ on Windows).

For instance, suppose you have the following structure:

  your-project
   ├── .eslintrc
   ├── lib
   │ └── source.js
   └─┬ tests
     ├── .eslintrc
     └── test.js

When you open or save source.js VisualLinter will use the .eslintrc file at the root of the project as its config.

When you open or save test.js VisualLinter will use the .eslintrc file in the tests/ directory.

If you prefer using a personal config file located in your user home directory (e.g. ~/.eslintrc), be sure to tick the checkbox 'Use personal ESLint config instead of local' under Tools > Options > VisualLinter.

If there are multiple config files in the same directory, VisualLinter will only use one. The priority order is:

1.   .eslintrc.js
2.   .eslintrc.yaml
3.   .eslintrc.yml
4.   .eslintrc.json
5.   .eslintrc

Currently, this extension does NOT support the use of package.json as its config file.

Please note that additional ESLint plugins may be required in order to lint files depending on your config. The VisualLinter output window could help identify these plugins.

Language Support

JavaScript using ESLint

Troubleshooting

• If you receive a error message when starting Visual Studio with the extension installed saying that ESLint could not be found in PATH, restarting your computer would reload the environment variables.
• If you receive a message saying that eslint could not verify your config, refer to the docs on how to configure ESLint
• Visual Studio 2017 is using ESLint by default, however it does not visually mark errors in buffer, if you're seeing duplicate messages in the error list window, you can disable the built in linter by setting Enable ESLint to false in:

  Options > Text Editor > JavaScript/TypeScript > ESLint

Contribute

See all contributors on GitHub.

Check out the contribution guidelines if you want to contribute to this project.

For cloning and building this project yourself, make sure to install the Extensibility Tools 2015 extension for Visual Studio which enables some features used by this project.

Thanks to

Creators of..

• SonarSource/SonarLint extension for Visual Studio.
• AtomLinter/linter-eslint eslint package for the Atom text editor.

License

MIT