auto add '@readonly' to jsdoc

Author: John Jenkins

src/compiler/types/generate-prop-types.ts

@@ -11,14 +11,22 @@ import { updateTypeIdentifierNames } from './stencil-types';
  */
 export const generatePropTypes = (cmpMeta: d.ComponentCompilerMeta, typeImportData: d.TypesImportData): d.TypeInfo => {
   return [
-    ...cmpMeta.properties.map((cmpProp) => ({
-      name: cmpProp.name,
-      type: getType(cmpProp, typeImportData, cmpMeta.sourceFilePath),
-      optional: cmpProp.optional,
-      required: cmpProp.required,
-      internal: cmpProp.internal,
-      jsdoc: getTextDocs(cmpProp.docs),
-    })),
+    ...cmpMeta.properties.map((cmpProp) => {
+      let doc = getTextDocs(cmpProp.docs);
+      if (cmpProp.getter && !cmpProp.setter && !doc?.match('@readonly')) {
+        cmpProp.docs = cmpProp.docs || { tags: [], text: '' };
+        cmpProp.docs.tags = [...(cmpProp.docs.tags || []), { name: 'readonly', text: '' }];
+        doc = getTextDocs(cmpProp.docs);
+      }
+      return {
+        name: cmpProp.name,
+        type: getType(cmpProp, typeImportData, cmpMeta.sourceFilePath),
+        optional: cmpProp.optional,
+        required: cmpProp.required,
+        internal: cmpProp.internal,
+        jsdoc: doc,
+      };
+    }),
     ...cmpMeta.virtualProperties.map((cmpProp) => ({
       name: cmpProp.name,
       type: cmpProp.type,

src/compiler/types/tests/generate-prop-types.spec.ts

@@ -1,5 +1,4 @@
 import type * as d from '../../../declarations';
-import * as Util from '../../../utils/util';
 import { generatePropTypes } from '../generate-prop-types';
 import * as StencilTypes from '../stencil-types';
 import { stubComponentCompilerMeta } from './ComponentCompilerMeta.stub';
@@ -13,7 +12,6 @@ describe('generate-prop-types', () => {
       ReturnType<typeof StencilTypes.updateTypeIdentifierNames>,
       Parameters<typeof StencilTypes.updateTypeIdentifierNames>
     >;
-    let getTextDocsSpy: jest.SpyInstance<ReturnType<typeof Util.getTextDocs>, Parameters<typeof Util.getTextDocs>>;
 
     beforeEach(() => {
       updateTypeIdentifierNamesSpy = jest.spyOn(StencilTypes, 'updateTypeIdentifierNames');
@@ -25,14 +23,10 @@ describe('generate-prop-types', () => {
           initialType: string,
         ) => initialType,
       );
-
-      getTextDocsSpy = jest.spyOn(Util, 'getTextDocs');
-      getTextDocsSpy.mockReturnValue('');
     });
 
     afterEach(() => {
       updateTypeIdentifierNamesSpy.mockRestore();
-      getTextDocsSpy.mockRestore();
     });
 
     it('returns an empty array when no props are provided', () => {
@@ -141,5 +135,59 @@ describe('generate-prop-types', () => {
 
       expect(actualTypeInfo).toEqual(expectedTypeInfo);
     });
+
+    it('appends `@readonly` to jsdoc when the property has a getter and no setter', () => {
+      const stubImportTypes = stubTypesImportData();
+      const componentMeta = stubComponentCompilerMeta({
+        properties: [
+          stubComponentCompilerProperty({
+            getter: true,
+            setter: false,
+          }),
+        ],
+      });
+
+      const expectedTypeInfo: d.TypeInfo = [
+        {
+          jsdoc: '@readonly',
+          internal: false,
+          name: 'propName',
+          optional: false,
+          required: false,
+          type: 'UserCustomPropType',
+        },
+      ];
+
+      const actualTypeInfo = generatePropTypes(componentMeta, stubImportTypes);
+
+      expect(actualTypeInfo).toEqual(expectedTypeInfo);
+    });
+
+    it('does not include `@readonly` to jsdoc when the property has a getter and a setter', () => {
+      const stubImportTypes = stubTypesImportData();
+      const componentMeta = stubComponentCompilerMeta({
+        properties: [
+          stubComponentCompilerProperty({
+            getter: true,
+            setter: true,
+          }),
+        ],
+      });
+
+      const expectedTypeInfo: d.TypeInfo = [
+        {
+          jsdoc: '',
+          internal: false,
+          name: 'propName',
+          optional: false,
+          required: false,
+          type: 'UserCustomPropType',
+        },
+      ];
+
+      const actualTypeInfo = generatePropTypes(componentMeta, stubImportTypes);
+
+      expect(actualTypeInfo).toEqual(expectedTypeInfo);
+    });
   });
 });