Implement automatic fixes for our custom eslint rules

[joyeecheung]

• Version: master
• Subsystem: tools

The rules are in https://github.com/nodejs/node/tree/master/tools/eslint-rules
Some of them should be possible to get fixed automatically e.g. to fix require-buffer simply put a line below 'use strict' and stuff.

ESLint documentation on how to implement custom fixes: https://eslint.org/docs/developer-guide/working-with-rules#applying-fixes

[shobhitchittora]

Hi @joyeecheung. I'd like to pick this up as a good first issue. I've already forked, built and tested the master. Please provide further steps to test my fixer methods. Any guidance is more than appreciated.

[gibfahn]

@shobhitchittora a good way to get started would be to:

• pick a rule in https://github.com/nodejs/node/tree/master/tools/eslint-rules.
• Run the linter command*, hopefully it passes
• Modify the node source code so that the linter command fails with the rule you picked
• Try the lint command with --fix on the end and see if it fixes the problem (it probably won't).
• Read the eslint docs about writing error fixes
• Implement the automatic fix (if possible)
• Get lint command + --fix to pass
• Open a PR with your changes (see the contributing guide) for more info.

* Command is:

./node tools/eslint/bin/eslint.js --cache --rulesdir=tools/eslint-rules --ext=.js,.mjs,.md benchmark doc lib test tools

Feel free to comment here if you run into any issues.

BTW the linter command is what gets run when you run make lint (which calls lint-js):

node/Makefile

Lines 994 to 1000 in 46ca177

	lint-js:
	@echo "Running JS linter..."
	@if [ -x $(NODE) ]; then \
	$(NODE) $(LINT_JS_CMD); \
	else \
	node $(LINT_JS_CMD); \
	fi

[shobhitchittora]

Thanks for the help. I'm working on writing fixture functions and will create a PR.

[shobhitchittora]

@gibfahn Seems like that the path to eslint got changed from - tools/eslint/bin/eslint.js to tools/node_modules/eslint/bin/eslint.js. Thanks ! 👍🏻