eslint-docgen 0.6.2 → 0.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-docgen",
-	"version": "0.6.2",
+	"version": "0.7.0",
 	"description": "Automatically generate ESLint plugin documentation from rule metadata and test cases.",
 	"repository": {
 		"type": "git",
@@ -25,7 +25,7 @@
 	"dependencies": {
 		"chalk": "^4.1.2",
 		"ejs": "^3.1.6",
-		"eslint": ">=5.0.0",
+		"eslint": ">=8.0.0",
 		"import-fresh": "^3.3.0",
 		"jsonschema": "^1.4.0",
 		"merge-options": "^3.0.4",
@@ -36,9 +36,9 @@
 		"upath": "^2.0.1"
 	},
 	"devDependencies": {
-		"eslint-config-wikimedia": "^0.21.0",
+		"eslint-config-wikimedia": "^0.22.1",
 		"eslint-plugin-node": "^11.1.0",
-		"mocha": "^9.1.3",
+		"mocha": "^9.2.0",
 		"nyc": "^15.1.0"
 	}
 }

package/src/build-docs-from-tests.js

@@ -37,7 +37,7 @@ function mdLink( target, label ) {
 	return '[' + label + '](' + target + ')';
 }
 
-function buildDocsFromTests(
+async function buildDocsFromTests(
 	name, ruleMeta, tests, configMap, config, globalTemplates, loadRuleTemplate, testerConfig
 ) {
 
@@ -78,7 +78,7 @@ function buildDocsFromTests(
 		return path.basename( test.filename );
 	}
 
-	function buildRuleDetails( testList, isValid, showFixes ) {
+	async function buildRuleDetails( testList, isValid, showFixes ) {
 		testList = testList.filter( ( test ) =>
 			test.docgen === undefined ?
 				!config.excludeExamplesByDefault :
@@ -91,7 +91,7 @@ function buildDocsFromTests(
 		const codeList = testList.map( getCode );
 		if ( config.fixCodeExamples ) {
 			const fix = require( './fix' );
-			fixedCode = fix.batchLintFix( codeList, testerConfig );
+			fixedCode = await fix.batchLintFix( codeList, testerConfig );
 		} else {
 			fixedCode = codeList;
 		}
@@ -110,7 +110,7 @@ function buildDocsFromTests(
 			const outputList = testList.map( ( test ) => test.output );
 			if ( config.fixCodeExamples ) {
 				const fix = require( './fix' );
-				fixedOutput = fix.batchLintFix( outputList, testerConfig );
+				fixedOutput = await fix.batchLintFix( outputList, testerConfig );
 			} else {
 				fixedOutput = outputList;
 			}
@@ -215,7 +215,7 @@ function buildDocsFromTests(
 			if ( config.fixCodeExamples ) {
 				const fix = require( './fix' );
 				// Fixes whitespace in block comment. Too expensive for such a small fix?
-				comments = fix.batchLintFix( comments, testerConfig );
+				comments = await fix.batchLintFix( comments, testerConfig );
 			}
 		}
 
@@ -268,8 +268,8 @@ function buildDocsFromTests(
 		} );
 	}
 
-	const invalid = buildRuleDetails( tests.invalid, false );
-	const valid = buildRuleDetails( tests.valid, true );
+	const invalid = await buildRuleDetails( tests.invalid, false );
+	const valid = await buildRuleDetails( tests.valid, true );
 
 	const validInvalid = invalid.concat( valid ).sort( ( a, b ) => {
 		return a.key === b.key ?
@@ -279,7 +279,7 @@ function buildDocsFromTests(
 
 	let fixed = [];
 	if ( ruleMeta.fixable && config.showFixExamples ) {
-		fixed = buildRuleDetails(
+		fixed = await buildRuleDetails(
 			tests.invalid.filter( ( test ) => !!test.output ),
 			false,
 			true

package/src/fix.js

@@ -1,23 +1,29 @@
 'use strict';
 
-const eslint = require( 'eslint' );
-const linter = new eslint.Linter();
-const cli = new eslint.CLIEngine();
-const config = cli.getConfigForFile( require( './main' ) );
-const rules = cli.getRules();
+const { Linter, ESLint } = require( 'eslint' );
+const linter = new Linter();
+const eslint = new ESLint();
 const mergeOptions = require( 'merge-options' );
+// eslint-disable-next-line node/no-missing-require
+const { builtinRules } = require( 'eslint/use-at-your-own-risk' );
 
-// Optimization: Only use fixable rules
-const fixableRules = {};
-Object.keys( config.rules ).forEach( function ( ruleName ) {
-	if ( rules.has( ruleName ) ) {
-		const rule = rules.get( ruleName );
-		if ( rule.meta.fixable ) {
-			fixableRules[ ruleName ] = config.rules[ ruleName ];
+async function getConfig() {
+	const config = await eslint.calculateConfigForFile( require( './main' ) );
+
+	// Optimization: Only use fixable rules
+	const fixableRules = {};
+	Object.keys( config.rules ).forEach( function ( ruleName ) {
+		if ( builtinRules.has( ruleName ) ) {
+			const rule = builtinRules.get( ruleName );
+			if ( rule.meta.fixable ) {
+				fixableRules[ ruleName ] = config.rules[ ruleName ];
+			}
 		}
-	}
-} );
-config.rules = fixableRules;
+	} );
+	config.rules = fixableRules;
+
+	return config;
+}
 
 /**
  * Lint and fix some code
@@ -26,8 +32,8 @@ config.rules = fixableRules;
  * @param {Object} testerConfig Config
  * @return {string} Fixed code
  */
-function lintFix( code, testerConfig ) {
-	const mergedConfig = mergeOptions( config, testerConfig );
+async function lintFix( code, testerConfig ) {
+	const mergedConfig = mergeOptions( await getConfig(), testerConfig );
 
 	// TODO
 	// istanbul ignore next
@@ -55,11 +61,12 @@ function lintFix( code, testerConfig ) {
  * @param {Object} testerConfig Config
  * @return {string[]} Fixed code list
  */
-function batchLintFix( codeList, testerConfig ) {
+async function batchLintFix( codeList, testerConfig ) {
 	const separator = '\n/* - */\n';
 	const codeBlock = codeList.join( ';' + separator );
 	// Add an extra semicolon to avoid syntax error
-	return lintFix( codeBlock, testerConfig ).split( separator ).map( ( code ) => code.trim() );
+	const fixed = await lintFix( codeBlock, testerConfig );
+	return fixed.split( separator ).map( ( code ) => code.trim() );
 }
 
 module.exports = {

package/src/write-docs-from-tests.js

@@ -35,7 +35,7 @@ if ( config.globalTemplatePath ) {
 }
 const { globalTemplates, loadRuleTemplate } = loadTemplates( templatePaths );
 
-function writeDocsFromTests( name, rule, tests, testerConfig, done ) {
+async function writeDocsFromTests( name, rule, tests, testerConfig, done ) {
 	// If the tests have a `docgenConfig` property, this overrides the global configuration
 	let configForRule = config;
 	if ( tests.docgenConfig !== undefined ) {
@@ -51,7 +51,7 @@ function writeDocsFromTests( name, rule, tests, testerConfig, done ) {
 	const configMap = rulesWithConfig.get( name ).configMap;
 	let output, messages;
 	try {
-		( { output, messages } = buildDocsFromTests(
+		( { output, messages } = await buildDocsFromTests(
 			name, rule.meta, tests, configMap, configForRule,
 			globalTemplates, loadRuleTemplate, testerConfig
 		) );