test: ensure that CLI options are alphabetical

[avivkeller]

Blocked by #55788

This PR ensures that all options documented in CLI.md are in alphabetical order.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.40%. Comparing base (58a8eb4) to head (dd1d23e).
Report is 235 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #55790 +/- ##
==========================================
- Coverage 88.40% 88.40% -0.01% 
==========================================
Files 654 654 Lines 187815 187815 Branches 36136 36137 +1 ==========================================
- Hits 166045 166043 -2 - Misses 15001 15017 +16 + Partials 6769 6755 -14 

see 38 files with indirect coverage changes

[aduh95]

Suggested change

	constoptions=Array.from(filteredCLIText.matchAll(cliOptionPattern)).map((match)=>match[1]);
	constoptions=Array.from(filteredCLIText.matchAll(cliOptionPattern),(match)=>match[1]);

[aduh95]

Suggested change

	constsortedOptions=[...options].sort();
	/* eslint-disable no-restricted-syntax */
	assert.deepStrictEqual(options,sortedOptions,'CLI options are not in alphabetical order');
	assert.deepStrictEqual(options,options.toSorted());

[aduh95]

We should not disable lint rules like that:

• there are there for a reason. If the reason no longer holds, we should discuss removing the rule globally. For context, that rule was added in tools, test: forbid string literal as third argument for assert.strictEqual() and friends #22849 and tools: synchronize deepStrictEqual() message rules #22887
• We should disable only the next line, using // eslint-disable-next-line no-restricted-syntax. The comment you use disables it in the whole file, which is not OK

[aduh95]

The trimming is not useful, is it?

Suggested change

	constfilteredCLIText=cliText.slice(cliText.search(start),cliText.search(end)).trim();
	constfilteredCLIText=cliText.slice(cliText.search(start),cliText.search(end));

[aduh95]

IMO we also want env variables and V8 options to be sorted, it makes little sense to reduce it to our CLI options

Suggested change

	conststart=/^##Options/m;
	constend=/^##Environmentvariables/m;
	constfilteredCLIText=cliText.slice(cliText.search(start),cliText.search(end)).trim();
	constcliOptionPattern=/^###`(--[a-zA-Z0-9-]+)`/mg;
	constoptions=Array.from(filteredCLIText.matchAll(cliOptionPattern)).map((match)=>match[1]);
	constsortedOptions=[...options].sort();
	/* eslint-disable no-restricted-syntax */
	assert.deepStrictEqual(options,sortedOptions,'CLI options are not in alphabetical order');
	constsections=/^##(.+)$/mg;
	constcliOptionPattern=/^###(?:`-\w.*`,)?`([^`]+)`/mg;
	letmatch;
	letpreviousIndex=0;
	do{
	constsectionTitle=match?.[1];
	match=sections.exec(cliText);
	constfilteredCLIText=cliText.slice(previousIndex,match?.index);
	constoptions=Array.from(filteredCLIText.matchAll(cliOptionPattern),(match)=>match[1]);
	assert.deepStrictEqual(options,options.toSorted(),`${sectionTitle} subsections are not in alphabetical order`);
	previousIndex=match?.index;
	}while(match);

I can also do that as part of a follow-up PR

[aduh95]

Superseded by #56025