Skip to content

ESLint plugin for logging the paths of all files being linted to the console

License

Notifications You must be signed in to change notification settings

justlep/eslint-plugin-log-filenames

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eslint-plugin-log-filenames Build Status NPM Version

ESLint plugin for logging the paths of all linted files to the console

Why?

ESLint doesn't provide a summary of which or how many files have been linted. Thus, misconfiguration can easily lead to a falsely "clean" linting results just because not all intended files got checked.

By adding this plugin to an ESLint config, a list of all linted files will be output, regardless of actual linting errors.

How?

Add the plugin to your project

$ npm install -D eslint-plugin-log-filenames

Then include it in your ESLint configuration (e.g .eslintrc)

{
  "plugins": [
    "log-filenames"
  ],
  "rules": {...},
  ...
}

or via CLI

eslint --plugin log-filenames

Logged file types are *.{js,jsx,es,es6,cjs,mjs,jsm,ts,tsx,html,vue}.
If you need more exotic extensions, simply add an overrides section to your .eslintrc, making the plugin log every file regardless of its extension:

{
  "plugins": [
    "log-filenames"
  ],
  "overrides": [
    {
      "files": "*.*",
      "processor": "log-filenames/.js"
    }
  ],
  ...
}

Important

If ESLint is run with the --format=checkstyle CLI option (as IntelliJ's ESLint integration does), logging filenames is skipped in order to not produce invalid checkstyle XML in the console.

About

ESLint plugin for logging the paths of all files being linted to the console

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •