# LintLens - VSCode extension [![Visual Studio Marketplace](https://img.shields.io/vscode-marketplace/v/ghmcadams.lintlens.svg)](https://marketplace.visualstudio.com/items?itemName=ghmcadams.lintlens) [![Visual Studio Marketplace](https://vsmarketplacebadge.apphb.com/installs-short/ghmcadams.lintlens.svg?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=ghmcadams.lintlens) [![David](https://img.shields.io/david/dev/ghmcadams/vscode-lintlens.svg?style=flat-square)](https://david-dm.org/ghmcadams/vscode-lintlens) [![David](https://img.shields.io/david/dev/ghmcadams/vscode-lintlens.svg?style=flat-square)](https://david-dm.org/ghmcadams/vscode-lintlens?type=dev) [![The MIT License](https://img.shields.io/badge/license-MIT-orange.svg?style=flat-square)](http://opensource.org/licenses/MIT) Augment your ESLint rules in Visual Studio Code — Adds metadata beside each ESLint rule.

LintLens Screenshot

## Features Adds details and a documentation link beside each [ESLint rule](https://eslint.org/docs/rules/) in your configuration file (including [plugins](https://www.npmjs.com/search?q=eslint-plugin-&ranking=popularity)) located anywhere in your workspace folders (supports multiple config files). Supports all configuration file formats currently [supported by ESLint](https://eslint.org/docs/user-guide/configuring#configuration-file-formats) - JavaScript - use `.eslintrc.js` and export an object containing your configuration. - YAML - use `.eslintrc.yaml` or `.eslintrc.yml` to define the configuration structure. - JSON - use `.eslintrc.json` to define the configuration structure. ESLint’s JSON files also allow JavaScript-style comments. - **Deprecated** - use `.eslintrc`, which can be either JSON or YAML. - package.json - create an `eslintConfig` property in your `package.json` file and define your configuration there. If you are new to ESLint check the [documentation](http://eslint.org/). Auto-updates as you type:

LintLens Preview Main

Click for more information on each rule:

LintLens Preview Links

## Requirements In an effort to support all possible plugins and to keep size small, this extension uses ESLint plugins installed in the opened workspace folder(s). Due to restrictions in vscode, this extension does not support globally installed packages. ## Known Issues - Does not support globally installed eslint plugin packages - ESLint v4.15.0 added an official location for rules to store a URL to their documentation in the rule metadata in [eslint/eslint#9788](https://github.com/eslint/eslint/pull/9788). This adds the URL to all the existing rules so anything consuming them can know where their documentation is without having to resort to external packages to guess. If your plugin hasn't included this metadata, its possible you have an older version that needs to be updated. - When using the JS configuration file format, this extension currently only supports rules existing in a single exports object at the root (`module.exports.rules`).