eslint-docgen 0.6.1 → 0.6.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-docgen",
-	"version": "0.6.1",
+	"version": "0.6.2",
 	"description": "Automatically generate ESLint plugin documentation from rule metadata and test cases.",
 	"repository": {
 		"type": "git",
@@ -36,7 +36,7 @@
 		"upath": "^2.0.1"
 	},
 	"devDependencies": {
-		"eslint-config-wikimedia": "^0.20.0",
+		"eslint-config-wikimedia": "^0.21.0",
 		"eslint-plugin-node": "^11.1.0",
 		"mocha": "^9.1.3",
 		"nyc": "^15.1.0"

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

@@ -78,7 +78,7 @@ function buildDocsFromTests(
 		return path.basename( test.filename );
 	}
 
-	function buildRuleDetails( testList, valid, showFixes ) {
+	function buildRuleDetails( testList, isValid, showFixes ) {
 		testList = testList.filter( ( test ) =>
 			test.docgen === undefined ?
 				!config.excludeExamplesByDefault :
@@ -176,9 +176,8 @@ function buildDocsFromTests(
 				};
 
 			if ( showFixes && test.output ) {
-				const output = fixedOutput[ i ];
 				const codeLines = code.split( '\n' );
-				const outputLines = output.split( '\n' );
+				const outputLines = fixedOutput[ i ].split( '\n' );
 				const maxLines = Math.max( codeLines.length, outputLines.length );
 				const exampleLines = [];
 				for ( let l = 0; l < maxLines; l++ ) {
@@ -237,7 +236,7 @@ function buildDocsFromTests(
 
 			return {
 				key: key,
-				valid: valid,
+				valid: isValid,
 				options: options ? JSON.stringify( options ) : '',
 				settings: settings ? JSON.stringify( settings ) : '',
 				filename: filename || '',

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

@@ -1,6 +1,5 @@
 'use strict';
 
-/* eslint-disable no-process-exit */
 const fs = require( 'fs' );
 const mkdirp = require( 'mkdirp' );
 const path = require( 'upath' );
@@ -14,20 +13,14 @@ let config, configPath;
 try {
 	( { config, configPath } = getConfig() );
 } catch ( e ) {
-	console.log( formatter.heading( 'eslint-docgen' ) );
-	console.log( formatter.error( e.message ) );
-	console.log();
-	process.exit( 1 );
+	throw new Error( [ formatter.heading( 'eslint-docgen' ), formatter.error( e.message ) ].join( '\n' ) );
 }
 
 const configValidator = require( './validate-config' );
 function assertValidConfig( maybeValidConfig, configSource ) {
 	const configErrors = configValidator( maybeValidConfig );
 	if ( configErrors.length ) {
-		console.log( formatter.heading( configSource ) );
-		configErrors.forEach( ( error ) => console.log( formatter.error( error ) ) );
-		console.log();
-		process.exit( 1 );
+		throw new Error( [ formatter.heading( configSource ), ...configErrors.map( formatter.error ) ].join( '\n' ) );
 	}
 }
 
@@ -53,11 +46,7 @@ function writeDocsFromTests( name, rule, tests, testerConfig, done ) {
 	const outputPath = packagePath( configForRule.docPath.replace( '{name}', name ) );
 	const ruleWithConfig = rulesWithConfig.get( name );
 	if ( !ruleWithConfig ) {
-		console.log();
-		console.log( formatter.heading( outputPath ) );
-		console.log( formatter.error( 'Rule not found.' ) );
-		console.log();
-		process.exit( 1 );
+		throw new Error( [ formatter.heading( outputPath ), formatter.error( 'Rule not found.' ) ].join( '\n' ) );
 	}
 	const configMap = rulesWithConfig.get( name ).configMap;
 	let output, messages;
@@ -67,11 +56,7 @@ function writeDocsFromTests( name, rule, tests, testerConfig, done ) {
 			globalTemplates, loadRuleTemplate, testerConfig
 		) );
 	} catch ( e ) {
-		console.log();
-		console.log( formatter.heading( outputPath ) );
-		console.log( formatter.error( e.message ) );
-		console.log();
-		process.exit( 1 );
+		throw new Error( [ formatter.heading( outputPath ), formatter.error( e.message ) ].join( '\n' ) );
 	}
 
 	const outputDir = path.dirname( outputPath );
@@ -92,8 +77,10 @@ function writeDocsFromTests( name, rule, tests, testerConfig, done ) {
 					console.log();
 				}
 
-				if ( messages.some( ( message ) => message.type === 'error' ) ) {
-					process.exit( 1 );
+				const errors = messages.filter( ( message ) => message.type === 'error' );
+
+				if ( errors.length ) {
+					throw new Error( errors.map( formatter.error ).join( '\n' ) );
 				}
 
 				done();

package/Changelog.md

@@ -1,99 +0,0 @@
-# eslint-docgen release history
-
-## v0.6.1
-* Fix: Filter out docgen:false tests before parsing (#120)
-
-## v0.6.0
-* Breaking change: Drop deprecated 'noDoc' option and '--doc' CLI flag (#115)
-* New: build-docs-from-tests: add Vue syntax highlighting (#105) (DannyS712)
-* New: Add TypeScript syntax highlighting
-* New: Add HTML syntax highlighting
-* New: Separate syntax highlighting support from showFilenames (#114)
-* Fix: Don't put an empty line before the first multi-line examples in a set (#117)
-* Code: Cleanup code for detecting highlight language (#113)
-
-## v0.5.1
-* Breaking change: Change the default icon for rules which are included in a preset (#109)
-* Breaking change: Add generated-file-warning comment to the top of MD files (#107)
-* Breaking change: Drop support for Node 10 (#110)
-* New: Add configuration to show file names for test cases (#101) (DannyS712)
-* New: Add per-rule config overrides (DannyS7123)
-* Docs: Various README fixes
-* Code: Update dependencies
-
-## v0.4.5
-* Code: Update dependencies
-
-## v0.4.4
-
-* Code: Ensure config.docPath exists before writing output path. (Raine Revere)
-* Code: Calculate outputDir from outputPath
-* Code: Fix reporting of writeFile error messages
-* Code: Output formatted error when rule not found (#92)
-* Docs: Fix config param heading level in README (#91)
-
-## v0.4.3
-
-* Code: Run one test 'it' per rule
-
-## v0.4.2
-
-* New: Introduce excludeExamplesByDefault config
-* Code: Remove some whitespace in config-schema
-* Code: Add a 'report' script
-
-## v0.4.1
-
-* Code: Update mocha to 8.0.1
-* Code: Replace path with upath for windows compatibility (#83)
-* Code: Use DOCGEN environment variable instead of --doc flag
-* Code: Add an editorconfig to make the tabs a reasonable width on GitHub (Jed Fox)
-* Code: Allow package.main to be empty
-* Code: Support scoped plugin names
-* Docs: Add more method documentation
-* Docs: Fix external links to examples
-* Docs: Add Migration section to README and move some pieces around
-
-## v0.4.0
-
-* Breaking change: New: Add fix message to introduction (#49)
-* Breaking change: New: Format long lists correctly ("a, b, and c")
-* Breaking change: New: Sort examples by options *then* valid/invalid (#48)
-* New: Refactor rulesData to rulesWithConfig and expose (#16)
-* New: Add ruleTemplatePath config (#14)
-* New: Add showFixExamples config (#49)
-* Code: Update eslint-config-wikimedia to 0.16.1 and use /mocha
-* Code: Use pkg-dir
-* Code: Create a JSON-schema to validate configs (#63)
-* Code: Update various dependencies
-* Tests: Separate config tests into get/validate
-* Tests: Increase timeout
-* Tests: Separate buildDocsFromTests cases
-* Docs: Fix example docpath
-
-## v0.3.1
-
-* Fix: Use plugin's version of ESLint
-
-## v0.3.0
-
-* Breaking change: New: Support multi-line test cases (#34)
-* New: Support multiple lines in formatter
-* New: Add min/maxExamples to config (#29)
-* New: Use chalk to do pretty output of warnings/errors (#38)
-* Code: Bump node dependency to 10 (#44)
-* Code: Use strict mode
-* Code: Use eslint-plugin-node/recommended
-* Code: Removed fixed length truncation from rules-data.js
-* Tests: Add tests for most utils (#39)
-* Tests: Increase code coverage to 100%
-* Docs: Add "plugin" to description
-
-## v0.2.0
-
-* Breaking change: Refactor templates. Users with existing template overrides will need to rewrite them.
-* Release: Update ejs to 3.1.3
-
-## v0.1.0
-
-* Initial release.