tools: force common be required before any other modules

[ZYSzys]

Add a new eslint rule require-common-first to enforce common be loaded in tests before any other modules.

The common module should be required in tests before any other module: https://github.com/nodejs/node/blob/master/doc/guides/writing-tests.md#lines-1-3

Refs: #27455 (comment)

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• tests and/or benchmarks are included
• commit message follows commit guidelines

[lpinca]

Doesn't this change the original rule? It could have been configured to enforce multiple modules before, now it only supports a single one.

[ZYSzys]

Theoretically yes, but the usage of this rule is only for the common module under test directory, so it wouldn't break our linter and I think maybe it acceptable ?

node/test/.eslintrc.yaml

Lines 23 to 24 in 56ab82e

	## common module is mandatory in tests
	node-core/required-modules: [error, common]

I'm also not sure to limit this rule for a single one module configuration, or maybe should I write a new rule(maybe named require-top-level-common) to force common be required before any other modules ?

Any advice ?

[lpinca]

I think a new rule makes sense or also change this rule name as required-modules is misleading.

cc: @Trott

[Trott]

I'm fine with the approach in this pull request + a name change to required-module.

Alternatively, can we add a configuration object to the rule that allows you to specify that one of the modules must be loaded before all the others and only do this "load first" check for the module that has that option set?? It might look like this:

  node-core/required-modules: [error, [common, assert, foo], { first: common}]

That might be over-engineering or it might be good flexibility to build in for the future. I'm fine with either approach.

[ZYSzys]

Yup 👍, that sounds great, will try to implement this in the next PR.

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/23071/

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/23081/

[ZYSzys]

Landed in dcc5e51