@wordpress/docgen 1.23.0 → 1.25.0

package/lib/get-export-entries.js

@@ -1,8 +1,3 @@
-/**
- * External dependencies
- */
-const { get } = require( 'lodash' );
-
 /**
  * Returns the export entry records of the given export statement.
  * Unlike [the standard](http://www.ecma-international.org/ecma-262/9.0/#exportentry-record),
@@ -31,7 +26,7 @@ module.exports = ( token ) => {
 					name = t.declaration.left.name;
 					break;
 				default:
-					name = get( t.declaration, [ 'id', 'name' ], '*default*' );
+					name = t.declaration.id?.name ?? '*default*';
 			}
 			return name;
 		};
@@ -64,7 +59,7 @@ module.exports = ( token ) => {
 			name.push( {
 				localName: specifier.local.name,
 				exportName: specifier.exported.name,
-				module: get( token.source, [ 'value' ], null ),
+				module: token.source?.value ?? null,
 				lineStart: specifier.loc.start.line,
 				lineEnd: specifier.loc.end.line,
 			} )

package/lib/get-intermediate-representation.js

@@ -1,8 +1,3 @@
-/**
- * External dependencies
- */
-const { get } = require( 'lodash' );
-
 /**
  * Internal dependencies
  */
@@ -154,8 +149,8 @@ module.exports = (
 			ir.push( {
 				path,
 				name: entry.exportName,
-				description: get( doc, [ 'description' ], UNDOCUMENTED ),
-				tags: get( doc, [ 'tags' ], [] ),
+				description: doc?.description ?? UNDOCUMENTED,
+				tags: doc?.tags ?? [],
 				lineStart: entry.lineStart,
 				lineEnd: entry.lineEnd,
 			} );

package/lib/get-leading-comments.js

@@ -1,8 +1,3 @@
-/**
- * External dependencies
- */
-const { last } = require( 'lodash' );
-
 /**
  * Function that returns the leading comment
  * of a Espree node.
@@ -14,7 +9,10 @@ const { last } = require( 'lodash' );
 module.exports = ( declaration ) => {
 	let comments;
 	if ( declaration.leadingComments ) {
-		const lastComment = last( declaration.leadingComments );
+		const lastComment =
+			declaration.leadingComments[
+				declaration.leadingComments.length - 1
+			];
 		if ( lastComment ) {
 			comments = lastComment.value;
 		}

package/lib/get-type-annotation.js

@@ -394,7 +394,7 @@ function getTypeAnnotation( typeAnnotation ) {
  *
  * @param {ASTNode} token Contains either a function or a call to a function-wrapper.
  *
- * TODO: Remove the special-casing here once we're able to infer the types from TypeScript itself.
+ *                        TODO: Remove the special-casing here once we're able to infer the types from TypeScript itself.
  */
 function unwrapWrappedSelectors( token ) {
 	if ( babelTypes.isFunctionDeclaration( token ) ) {

package/lib/index.js

@@ -3,7 +3,6 @@
  */
 const fs = require( 'fs' );
 const path = require( 'path' );
-const { last } = require( 'lodash' );
 
 /**
  * Internal dependencies
@@ -11,6 +10,7 @@ const { last } = require( 'lodash' );
 const engine = require( './engine' );
 const defaultMarkdownFormatter = require( './markdown' );
 const isSymbolPrivate = require( './is-symbol-private' );
+const isSymbolIgnore = require( './is-symbol-ignore' );
 
 /**
  * Helpers functions.
@@ -59,7 +59,10 @@ const processFile = ( rootDir, inputFile ) => {
 		const result = engine(
 			relativePath,
 			data,
-			getIRFromRelativePath( rootDir, last( currentFileStack ) )
+			getIRFromRelativePath(
+				rootDir,
+				currentFileStack[ currentFileStack.length - 1 ]
+			)
 		);
 		currentFileStack.pop();
 		return result;
@@ -119,7 +122,7 @@ module.exports = ( sourceFile, options ) => {
 	// Process.
 	const result = processFile( processDir, sourceFile );
 	const filteredIR = result.ir.filter( ( symbol ) => {
-		if ( isSymbolPrivate( symbol ) ) {
+		if ( isSymbolPrivate( symbol ) || isSymbolIgnore( symbol ) ) {
 			return false;
 		}
 

package/lib/is-symbol-ignore.js

@@ -0,0 +1,17 @@
+/**
+ * Internal dependencies
+ */
+const getSymbolTagsByName = require( './get-symbol-tags-by-name' );
+
+/**
+ * Returns true if, given a symbol object, it contains a @ignore tag, or false
+ * otherwise.
+ *
+ * @param {Object} symbol Symbol object.
+ *
+ * @return {boolean} Whether symbol is private.
+ */
+const isSymbolIgnore = ( symbol ) =>
+	getSymbolTagsByName( symbol, 'ignore' ).length > 0;
+
+module.exports = isSymbolIgnore;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/docgen",
-	"version": "1.23.0",
+	"version": "1.25.0",
 	"description": "Autogenerate public API documentation from exports and JSDoc comments.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -29,7 +29,6 @@
 	"dependencies": {
 		"@babel/core": "^7.16.0",
 		"comment-parser": "^1.1.1",
-		"lodash": "^4.17.21",
 		"mdast-util-inject": "1.1.0",
 		"optionator": "0.8.2",
 		"remark": "10.0.1",
@@ -39,5 +38,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "a80eeb62ec7cb1418b9915c277e084a29d6665e3"
+	"gitHead": "171b87c7465b93e685e081c5f57f153507363c95"
 }