Giters

xojs / eslint-config-xo

ESLint shareable config for XO

Home Page:https://github.com/xojs/xo

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

eslint-index

wagerfield opened this issue · comments

commented

I have created an ESLint utility module that I thought you might find useful.

The module is called eslint-index and you can read the full documentation on npm.

eslint-index provides a great deal of functionality including:

  • List all available rules declared by ESLint and any plugins you have included
  • Colour code rules depending on their status:
    • omitted (not declared anywhere in you ESLint config file)
    • 0|off (declared, but set to 0|off)
    • 1|warn
    • 2|error
  • Display links to the rule documentation page next to each rule
  • Filter/reject rules by their status and/or their group
    • status is as described above (omitted|off|warn|error)
    • group is eslint for the core ESLint rules or the name of any of your plugins like react|import|flowtype
  • Format the output as a number or a table to get an overview of your rule settings
  • Rules that have been marked as deprecated are removed from all outputs
  • All of the above filters and formatting can be combined, for example:
    • filter omitted and off rules, output them as a list and display the rule doc links alongside
    • filter eslint rules and display the rule setting counters in a table

I wrote this plugin to aid the development of my own ESLint config settings and found it incredibly useful for keeping track of everything. I hope you find this module useful and please do let me know if you have any ideas on how to improve it.

commented

The issue tracker is for actual issues. You could have tweeted this at me instead. Also feels spammy when the exact same thing is posted in other issue trackers too: gajus/eslint-config-canonical#6

I would recommend submitting it to https://github.com/dustinspecker/awesome-eslint ;)

commented

Sorry for not using your preferred channel of communication to draw your attention to this module. I will endeavour to communicate with you over Twitter in future.

Though this is not an issue per se, it remains pertinent to all eslint-config-* repositories—hence why I have posted it to a number of them which I discovered through awesome-eslint (yours included).

I genuinely thought this might be a useful tool to this repository, but given your response I guess I was wrong.