Skip to content

Latest commit

 

History

History
executable file
·
59 lines (41 loc) · 3.6 KB

README.md

File metadata and controls

executable file
·
59 lines (41 loc) · 3.6 KB
Raw

LintLens - VSCode extension

Visual Studio Marketplace Visual Studio Marketplace David David The MIT License

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 in your configuration file (including plugins) located anywhere in your workspace folders (supports multiple config files).

Supports all configuration file formats currently supported by ESLint

  • JavaScript - use .eslintrc.js or .eslintrc.cjs 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.

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 both ESLint and 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 or 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. 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). Additionally, the language mode must match javascript or javascriptreact.