@microsoft/api-extractor - npm Package Compare versions

Comparing version 7.37.3 to 7.38.0

dist/rollup.d.ts

@@ -499,2 +499,20 @@ /**
     /**
+     * "Missing documentation for ___."
+     * @remarks
+     * The `ae-undocumented` message is only generated if the API report feature is enabled.
+     *
+     * Because the API report file already annotates undocumented items with `// (undocumented)`,
+     * the `ae-undocumented` message is not logged by default.  To see it, add a setting such as:
+     * ```json
+     * "messages": {
+     *   "extractorMessageReporting": {
+     *     "ae-undocumented": {
+     *       "logLevel": "warning"
+     *     }
+     *   }
+     *  }
+     * ```
+     */
+    Undocumented = "ae-undocumented",
+    /**
      * "This symbol has another declaration with a different release tag."
@@ -501,0 +519,0 @@ */

lib/api/ExtractorMessageId.d.ts

@@ -17,2 +17,20 @@ /**
     /**
+     * "Missing documentation for ___."
+     * @remarks
+     * The `ae-undocumented` message is only generated if the API report feature is enabled.
+     *
+     * Because the API report file already annotates undocumented items with `// (undocumented)`,
+     * the `ae-undocumented` message is not logged by default.  To see it, add a setting such as:
+     * ```json
+     * "messages": {
+     *   "extractorMessageReporting": {
+     *     "ae-undocumented": {
+     *       "logLevel": "warning"
+     *     }
+     *   }
+     *  }
+     * ```
+     */
+    Undocumented = "ae-undocumented",
+    /**
      * "This symbol has another declaration with a different release tag."
@@ -19,0 +37,0 @@ */

lib/api/ExtractorMessageId.js

@@ -8,2 +8,3 @@ "use strict";
     'ae-extra-release-tag',
+    'ae-undocumented',
     'ae-different-release-tags',
@@ -10,0 +11,0 @@ 'ae-incompatible-release-tags',

lib/collector/ApiItemMetadata.d.ts

@@ -64,3 +64,3 @@ import type * as tsdoc from '@microsoft/tsdoc';
     tsdocComment: tsdoc.DocComment | undefined;
-    needsDocumentation: boolean;
+    undocumented: boolean;
     docCommentEnhancerVisitorState: VisitorState;
@@ -67,0 +67,0 @@ constructor(options: IApiItemMetadataOptions);

lib/collector/ApiItemMetadata.js

@@ -34,3 +34,3 @@ "use strict";
         // Assigned by DocCommentEnhancer
-        this.needsDocumentation = true;
+        this.undocumented = true;
         this.docCommentEnhancerVisitorState = VisitorState_1.VisitorState.Unvisited;
@@ -37,0 +37,0 @@ this.declaredReleaseTag = options.declaredReleaseTag;

lib/enhancers/DocCommentEnhancer.js

@@ -78,3 +78,3 @@ "use strict";
             // will auto-generate one.
-            metadata.needsDocumentation = false;
+            metadata.undocumented = false;
             // The class that contains this constructor
@@ -129,6 +129,6 @@ const classDeclaration = astDeclaration.parent;
             // Require the summary to contain at least 10 non-spacing characters
-            metadata.needsDocumentation = !tsdoc.PlainTextEmitter.hasAnyTextContent(metadata.tsdocComment.summarySection, 10);
+            metadata.undocumented = !tsdoc.PlainTextEmitter.hasAnyTextContent(metadata.tsdocComment.summarySection, 10);
         }
         else {
-            metadata.needsDocumentation = true;
+            metadata.undocumented = true;
         }
@@ -135,0 +135,0 @@ }

lib/generators/ApiReportGenerator.js

@@ -423,4 +423,5 @@ "use strict";
             }
-            if (apiItemMetadata.needsDocumentation) {
+            if (apiItemMetadata.undocumented) {
                 footerParts.push('(undocumented)');
+                collector.messageRouter.addAnalyzerIssue("ae-undocumented" /* ExtractorMessageId.Undocumented */, `Missing documentation for "${astDeclaration.astSymbol.localName}".`, astDeclaration);
             }
@@ -427,0 +428,0 @@ if (footerParts.length > 0) {

lib/schemas/api-extractor-defaults.json

@@ -72,2 +72,5 @@ {
       },
+      "ae-undocumented": {
+        "logLevel": "none"
+      },
       "ae-unresolved-inheritdoc-reference": {
@@ -74,0 +77,0 @@ "logLevel": "warning",

package.json

 {
   "name": "@microsoft/api-extractor",
-  "version": "7.37.3",
+  "version": "7.38.0",
   "description": "Analyze the exported API for a TypeScript library and generate reviews, documentation, and .d.ts rollups",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

1564880

increased by0.16%

Lines of code

15522

increased by0.26%

No dependency changes