[api-extractor] cleanup and verify static readonly case

microsoft · May 23, 2022 · 48e4046 · 48e4046
1 parent b9d1d35
commit 48e4046
Show file tree

Hide file tree

Showing 10 changed files with 63 additions and 6 deletions.
diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json
@@ -790,6 +790,34 @@
               },
               "isStatic": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "api-documenter-test!DocClass1.staticReadonlyThing:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static readonly staticReadonlyThing: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "staticReadonlyThing",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": true
+            },
             {
               "kind": "Method",
               "canonicalReference": "api-documenter-test!DocClass1.sumWithExample:member(1)",

diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.md b/build-tests/api-documenter-test/etc/api-documenter-test.api.md
@@ -44,6 +44,8 @@ export class DocClass1 extends DocBaseClass implements IDocInterface1, IDocInter
     // (undocumented)
     get readonlyProperty(): string;
     regularProperty: SystemEvent;
+    // (undocumented)
+    static readonly staticReadonlyThing: boolean;
     static sumWithExample(x: number, y: number): number;
     tableExample(): void;
     // (undocumented)

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md
@@ -37,6 +37,7 @@ The constructor for this class is marked as internal. Third-party code should no
 |  --- | --- | --- | --- |
 |  [readonlyProperty](./api-documenter-test.docclass1.readonlyproperty.md) | <code>readonly</code> | string |  |
 |  [regularProperty](./api-documenter-test.docclass1.regularproperty.md) |  | [SystemEvent](./api-documenter-test.systemevent.md) | This is a regular property that happens to use the SystemEvent type. |
+|  [staticReadonlyThing](./api-documenter-test.docclass1.staticreadonlything.md) | <code>static</code><code>readonly</code> | boolean |  |
 |  [writeableProperty](./api-documenter-test.docclass1.writeableproperty.md) |  | string |  |
 |  [writeonlyProperty](./api-documenter-test.docclass1.writeonlyproperty.md) |  | string | API Extractor will surface an <code>ae-missing-getter</code> finding for this property. |
 

diff --git a/...cumenter-test/etc/markdown/api-documenter-test.docclass1.staticreadonlything.md b/...cumenter-test/etc/markdown/api-documenter-test.docclass1.staticreadonlything.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [staticReadonlyThing](./api-documenter-test.docclass1.staticreadonlything.md)
+
+## DocClass1.staticReadonlyThing property
+
+<b>Signature:</b>
+
+```typescript
+static readonly staticReadonlyThing: boolean;
+```
diff --git a/build-tests/api-documenter-test/etc/yaml/api-documenter-test/docclass1.yml b/build-tests/api-documenter-test/etc/yaml/api-documenter-test/docclass1.yml
@@ -45,6 +45,19 @@ properties:
       content: 'regularProperty: SystemEvent;'
       return:
         type: '<xref uid="api-documenter-test!SystemEvent:class" />'
+  - name: staticReadonlyThing
+    uid: 'api-documenter-test!DocClass1.staticReadonlyThing:member'
+    package: api-documenter-test!
+    fullName: staticReadonlyThing
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'static readonly staticReadonlyThing: boolean;'
+      return:
+        type: boolean
   - name: writeableProperty
     uid: 'api-documenter-test!DocClass1#writeableProperty:member'
     package: api-documenter-test!

diff --git a/build-tests/api-documenter-test/src/DocClass1.ts b/build-tests/api-documenter-test/src/DocClass1.ts
@@ -169,6 +169,8 @@ export class DocClass1 extends DocBaseClass implements IDocInterface1, IDocInter
     super();
   }
 
+  static readonly staticReadonlyThing: boolean;
+
   /**
    * This is an overloaded function.
    * @param a - the first string

diff --git a/...xtractor-scenarios/etc/test-outputs/readonlyDeclarations/api-extractor-scenarios.api.json b/...xtractor-scenarios/etc/test-outputs/readonlyDeclarations/api-extractor-scenarios.api.json
@@ -317,12 +317,12 @@
             },
             {
               "kind": "Property",
-              "canonicalReference": "api-extractor-scenarios!MyClass#declaredReadonlyThing:member",
+              "canonicalReference": "api-extractor-scenarios!MyClass.declaredReadonlyThing:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "readonly declaredReadonlyThing: "
+                  "text": "static readonly declaredReadonlyThing: "
                 },
                 {
                   "kind": "Reference",
@@ -342,7 +342,7 @@
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "isStatic": false
+              "isStatic": true
             },
             {
               "kind": "Property",

diff --git a/...-scenarios/etc/test-outputs/readonlyDeclarations/api-extractor-scenarios.api.md b/...-scenarios/etc/test-outputs/readonlyDeclarations/api-extractor-scenarios.api.md
@@ -16,7 +16,7 @@ export interface _IInternalThing {
 // @public (undocumented)
 export class MyClass {
     // (undocumented)
-    readonly declaredReadonlyThing: _IInternalThing;
+    static readonly declaredReadonlyThing: _IInternalThing;
     // (undocumented)
     get _onlyHasGetterThing(): _IInternalThing;
     tsDocReadonlyThing: _IInternalThing;

diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/readonlyDeclarations/rollup.d.ts b/build-tests/api-extractor-scenarios/etc/test-outputs/readonlyDeclarations/rollup.d.ts
@@ -11,7 +11,7 @@ export declare class MyClass {
     get _writableThing(): _IInternalThing;
     set _writableThing(value: _IInternalThing);
     get _onlyHasGetterThing(): _IInternalThing;
-    readonly declaredReadonlyThing: _IInternalThing;
+    static readonly declaredReadonlyThing: _IInternalThing;
     /**
      * Technically isn't but for testing purposes
      * @readonly

diff --git a/build-tests/api-extractor-scenarios/src/readonlyDeclarations/index.ts b/build-tests/api-extractor-scenarios/src/readonlyDeclarations/index.ts
@@ -21,7 +21,7 @@ export class MyClass {
     return { title: 'thing' };
   }
 
-  readonly declaredReadonlyThing: _IInternalThing;
+  static readonly declaredReadonlyThing: _IInternalThing;
 
   /**
    * Technically isn't but for testing purposes