@wordpress/docgen 1.19.0 → 1.19.2-next.a55ed9455a.0

package/README.md

@@ -254,8 +254,6 @@ console.log( result ); // Will log 3
 `number` The result of subtracting the two numbers.
 ````
 
-<br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
-
 ### TypeScript support
 
 Entry point `index.ts`:
@@ -293,3 +291,11 @@ Adds two numbers.
 
 `number` The result of adding the two numbers.
 ```
+
+## Contributing to this package
+
+This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects.
+
+To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md).
+
+<br /><br /><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

package/lib/get-export-entries.js

@@ -30,8 +30,6 @@ module.exports = ( token ) => {
 				case 'AssignmentExpression':
 					name = t.declaration.left.name;
 					break;
-				//case 'FunctionDeclaration'
-				//case 'ClassDeclaration'
 				default:
 					name = get( t.declaration, [ 'id', 'name' ], '*default*' );
 			}

package/lib/get-type-annotation.js

@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-// See https://babeljs.io/docs/en/babel-types
+// See https://babeljs.io/docs/en/babel-types.
 const { types: babelTypes } = require( '@babel/core' );
 
 /* eslint-disable jsdoc/valid-types */
@@ -270,14 +270,14 @@ function getTypeAnnotation( typeAnnotation ) {
 			return 'boolean';
 		}
 		case 'TSConditionalType': {
-			// Unsure what this is
+			// Unsure what this is.
 			return '';
 		}
 		case 'TSConstructorType': {
 			return `new ${ getFunctionTypeAnnotation( typeAnnotation, ': ' ) }`;
 		}
 		case 'TSExpressionWithTypeArguments': {
-			// Unsure with this is
+			// Unsure with this is.
 			return '';
 		}
 		case 'TSFunctionType': {
@@ -349,7 +349,7 @@ function getTypeAnnotation( typeAnnotation ) {
 			) }`;
 		}
 		case 'TSTypeQuery': {
-			// unsure what this is
+			// Unsure what this is.
 			return '';
 		}
 		case 'TSTypeReference': {
@@ -388,7 +388,7 @@ function getFunctionToken( token ) {
 	}
 
 	if ( babelTypes.isVariableDeclaration( resolvedToken ) ) {
-		// ignore multiple variable declarations
+		// Ignore multiple variable declarations.
 		resolvedToken = resolvedToken.declarations[ 0 ].init;
 	}
 
@@ -418,7 +418,7 @@ function getArrayTagNamePosition( tag ) {
 function getQualifiedArrayPatternTypeAnnotation( tag, paramType ) {
 	if ( babelTypes.isTSArrayType( paramType ) ) {
 		if ( babelTypes.isTSTypeReference( paramType.elementType ) ) {
-			// just get the element type for the array
+			// Just get the element type for the array.
 			return paramType.elementType.typeName.name;
 		}
 		return getTypeAnnotation( paramType.elementType.typeAnnotation );
@@ -428,7 +428,7 @@ function getQualifiedArrayPatternTypeAnnotation( tag, paramType ) {
 		);
 	}
 
-	// anything else, `Alias[ position ]`
+	// Anything else, `Alias[ position ]`.
 	return `( ${ getTypeAnnotation( paramType ) } )[ ${ getArrayTagNamePosition(
 		tag
 	) } ]`;
@@ -437,7 +437,7 @@ function getQualifiedArrayPatternTypeAnnotation( tag, paramType ) {
 function getQualifiedObjectPatternTypeAnnotation( tag, paramType ) {
 	const memberName = tag.name.split( '.' ).slice( -1 )[ 0 ];
 	if ( babelTypes.isTSTypeLiteral( paramType ) ) {
-		// if it's a type literal we can try to find the member on the type
+		// If it's a type literal we can try to find the member on the type.
 		const member = paramType.members.find(
 			( m ) => m.key.name === memberName
 		);
@@ -445,7 +445,7 @@ function getQualifiedObjectPatternTypeAnnotation( tag, paramType ) {
 			return getTypeAnnotation( member.typeAnnotation.typeAnnotation );
 		}
 	}
-	// If we couldn't find a specific member for the type then we'll just return something like `Type[ memberName ]` to indicate the parameter is a member of that type
+	// If we couldn't find a specific member for the type then we'll just return something like `Type[ memberName ]` to indicate the parameter is a member of that type.
 	const typeAnnotation = getTypeAnnotation( paramType );
 	return `${ typeAnnotation }[ '${ memberName }' ]`;
 }
@@ -459,7 +459,7 @@ function getQualifiedObjectPatternTypeAnnotation( tag, paramType ) {
 function getParamTypeAnnotation( tag, declarationToken, paramIndex ) {
 	const functionToken = getFunctionToken( declarationToken );
 
-	// otherwise find the corresponding parameter token for the documented parameter
+	// Otherwise find the corresponding parameter token for the documented parameter.
 	let paramToken = functionToken.params[ paramIndex ];
 
 	// This shouldn't happen due to our ESLint enforcing correctly documented parameter names but just in case
@@ -525,7 +525,7 @@ function getVariableTypeAnnotation( declarationToken ) {
 	}
 
 	if ( babelTypes.isClassDeclaration( resolvedToken ) ) {
-		// just use the classname if we're exporting a class
+		// Just use the classname if we're exporting a class.
 		return resolvedToken.id.name;
 	}
 
@@ -536,7 +536,7 @@ function getVariableTypeAnnotation( declarationToken ) {
 	try {
 		return getTypeAnnotation( resolvedToken.typeAnnotation.typeAnnotation );
 	} catch ( e ) {
-		// assume it's a fully undocumented variable, there's nothing we can do about that but fail silently.
+		// Assume it's a fully undocumented variable, there's nothing we can do about that but fail silently.
 	}
 }
 

package/lib/index.js

@@ -93,7 +93,7 @@ const runCustomFormatter = (
 const currentFileStack = [];
 
 module.exports = ( sourceFile, options ) => {
-	// Input: process CLI args, prepare files, etc
+	// Input: process CLI args, prepare files, etc.
 	const processDir = process.cwd();
 	if ( sourceFile === undefined ) {
 		process.stderr.write( '\n' );
@@ -116,7 +116,7 @@ module.exports = ( sourceFile, options ) => {
 		? path.join( processDir, options.output )
 		: inputBase + '-api.md';
 
-	// Process
+	// Process.
 	const result = processFile( processDir, sourceFile );
 	const filteredIR = result.ir.filter( ( symbol ) => {
 		if ( isSymbolPrivate( symbol ) ) {
@@ -130,7 +130,7 @@ module.exports = ( sourceFile, options ) => {
 		return true;
 	} );
 
-	// Ouput
+	// Ouput.
 	if ( result === undefined ) {
 		process.stdout.write(
 			'\nFile was processed, but contained no ES6 module exports:'

package/lib/markdown/formatter.js

@@ -190,7 +190,7 @@ module.exports = (
 			docs.push( '\n' );
 			docs.push( '\n' );
 		} );
-		docs.pop(); // remove last \n, we want one blank line at the end of the file.
+		docs.pop(); // Remove last \n, we want one blank line at the end of the file.
 	} else {
 		docs.push( 'Nothing to document.' );
 		docs.push( '\n' );

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/docgen",
-	"version": "1.19.0",
+	"version": "1.19.2-next.a55ed9455a.0",
 	"description": "Autogenerate public API documentation from exports and JSDoc comments.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -39,5 +39,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "d95ccb9366e249133cdb1d7b25c382446b9ee502"
+	"gitHead": "c5108185851b824d531bce55991a3589947e8551"
 }