kyaido / eslint-plugin-literal-blacklist Goto Github PK

We love this package in our project! Thank you!

It would be awesome to have the possibility to describe why a term is black-listed. So that the devs can see it when they hover over the black-listed word.

Possible implementation

In .eslintrc.json, there is a string[] inside of literal-blacklist/literal-blacklist. Change it to array of {term: string, message: string} instead of string.

"literal-blacklist/literal-blacklist": [
	"error", [
		{
			"term": "Teilnehmer",
			"message": "we use »Teilnehmende« to be gender-neutral",
		},
		{
			"term": "ebay",
			"message": "The brand is »eBay«, not »ebay« ;)",
		},
	],
],

Plugin code would change to something like this:

      options.forEach(option => {
        if(value.indexOf(option.term) !== -1) {
          message = `You should not use "${option.term}".\n${option.message}`;
          context.report({node: node, message: message});
        }
      });

PS:
Maybe there is a way to make it backwards compatible to still allow string[] AND {term: string, message: string}[] instead of only {term: string, message: string}[].

I saw you implemented support for RegEx in term. Nice one! But unfortunately it broke one of my terms. I had this one:

{ 
  "term": "...", 
  "message": "we use the ellipsis char `…` instead. On windows you get this with the following alt code: alt + 0133; on OSX: ⌥ ." 
},

The lint command in my pipeline seems to interpret this as RegEx ... which translates to 3 chars of any kind, which, as you might guess, happens a bazillion times in my project :D

Hi , let's say that i have in my code the following snippet:

if (appearance === 'dark') {
     source = require('assets/darkModeAssetBlabla.something');
 }

and I would like to exclude the term "dark", so I implemented the following rule:

'literal-blacklist/literal-blacklist': [
      ERROR,
      [
        {
          term: "=== 'dark'",
          message: "use ThemeModes.DARK instead of 'dark'",
          ignoreCase: true,
        },
      ],
    ],

what will happens is that both 'dark' and 'darkModeAssetBlabla.something' will be underlined by eslint, while I want to target exclusively entire words.

Can you add the option, after ignoreCase, matchWholeWord?
I think it will make senses
thanks