Change Request: Notify plugins when a fix has been applied

[Jason3S]

ESLint version

v8.20.0

What problem do you want to solve?

Context

As the author of the spellchecker plugin: @cspell/eslint-plugin, I would like to present the user a "fix" that allows the user to add a word to their custom dictionary. See: CSpell ESLint Plugin: Configuration option to add words to the dictionary · Issue #3233.

When used with an editor extension like VS Code ESLint, something like the following would show up:

If the fix is applied, the spellchecker plugin would add the word to the custom dictionary.

Problem

In the current ESLint implementation, a ReportFixer does not have the ability to provide a custom fix action or to know if a fix has been applied so it can take a custom action.

What do you think is the correct solution?

Two options came to mind:

1. context provides an event emitter than can be listen to:

   context.onFixApplied((fix) => console.log(fix));

   This provides the ability of any extension to listen for fixes and take an action.
2. Add an optional applied function to Fix that is called when a fix has been applied.
   This is the easiest fix:
   

   eslint/lib/linter/source-code-fixer.js

   Lines 102 to 106 in 0bcd225

   	// Make output to this fix.
   	output += text.slice(Math.max(0, lastPos), Math.max(0, start));
   	output += fix.text;
   	lastPos = end;
   	return true;

   
   Becomes something like this:

   output += text.slice(Math.max(0, lastPos), Math.max(0, start));
   output += fix.text;
   fix?.applied();
   lastPos = end;

Participation

• I am willing to submit a pull request for this change.

Additional comments

No response

[nzakas]

Interesting idea, though I’m actually not sure about the timing aspect as fixes are applied after linting is complete.

However, if you’d like to do some research and put together an RFC, we can certainly consider it.

[github-actions]

Oops! It looks like we lost track of this issue. What do we want to do here? This issue will auto-close in 7 days without an update.

[Jason3S]

@nzakas,

Thank you. I'll file an RFC.