@microsoft/api-extractor - npm Package Compare versions

Comparing version 7.38.2 to 7.38.3

lib/generators/ApiReportGenerator.d.ts

@@ -17,2 +17,3 @@ import { Collector } from '../collector/Collector';
     private static _modifySpan;
+    private static _shouldIncludeInReport;
     /**
@@ -19,0 +20,0 @@ * For declarations marked as `@preapproved`, this is used instead of _modifySpan().

lib/generators/ApiReportGenerator.js

@@ -216,3 +216,3 @@ "use strict";
         // eslint-disable-next-line no-bitwise
-        if ((astDeclaration.modifierFlags & ts.ModifierFlags.Private) !== 0) {
+        if (!ApiReportGenerator._shouldIncludeInReport(astDeclaration)) {
             span.modification.skipAll();
@@ -328,11 +328,14 @@ return;
                     childAstDeclaration = collector.astSymbolTable.getChildAstDeclarationByNode(child.node, astDeclaration);
-                    if (sortChildren) {
-                        span.modification.sortChildren = true;
-                        child.modification.sortKey = Collector_1.Collector.getSortKeyIgnoringUnderscore(childAstDeclaration.astSymbol.localName);
+                    if (ApiReportGenerator._shouldIncludeInReport(childAstDeclaration)) {
+                        if (sortChildren) {
+                            span.modification.sortChildren = true;
+                            child.modification.sortKey = Collector_1.Collector.getSortKeyIgnoringUnderscore(childAstDeclaration.astSymbol.localName);
+                        }
+                        if (!insideTypeLiteral) {
+                            const messagesToReport = collector.messageRouter.fetchAssociatedMessagesForReviewFile(childAstDeclaration);
+                            // NOTE: This generates ae-undocumented messages as a side effect
+                            const aedocSynopsis = ApiReportGenerator._getAedocSynopsis(collector, childAstDeclaration, messagesToReport);
+                            child.modification.prefix = aedocSynopsis + child.modification.prefix;
+                        }
                     }
-                    if (!insideTypeLiteral) {
-                        const messagesToReport = collector.messageRouter.fetchAssociatedMessagesForReviewFile(childAstDeclaration);
-                        const aedocSynopsis = ApiReportGenerator._getAedocSynopsis(collector, childAstDeclaration, messagesToReport);
-                        child.modification.prefix = aedocSynopsis + child.modification.prefix;
-                    }
                 }
@@ -343,2 +346,7 @@ ApiReportGenerator._modifySpan(collector, child, entity, childAstDeclaration, insideTypeLiteral);
     }
+    static _shouldIncludeInReport(astDeclaration) {
+        // Private declarations are not included in the API report
+        // eslint-disable-next-line no-bitwise
+        return (astDeclaration.modifierFlags & ts.ModifierFlags.Private) === 0;
+    }
     /**
@@ -345,0 +353,0 @@ * For declarations marked as `@preapproved`, this is used instead of _modifySpan().

package.json

 {
   "name": "@microsoft/api-extractor",
-  "version": "7.38.2",
+  "version": "7.38.3",
   "description": "Analyze the exported API for a TypeScript library and generate reviews, documentation, and .d.ts rollups",
@@ -45,4 +45,4 @@ "keywords": [
     "@rushstack/ts-command-line": "4.17.1",
-    "@rushstack/rig-package": "0.5.1",
-    "@rushstack/node-core-library": "3.61.0"
+    "@rushstack/node-core-library": "3.61.0",
+    "@rushstack/rig-package": "0.5.1"
   },
@@ -49,0 +49,0 @@ "devDependencies": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1566123

increased by0.08%

Lines of code

15531

increased by0.06%

No dependency changes