feat: Add detecting read-only properties (#1268)

TypeStrong · Apr 20, 2020 · 91644a9 · 91644a9
1 parent 8c2b698
commit 91644a9
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 10 deletions.
diff --git a/src/lib/converter/factories/declaration.ts b/src/lib/converter/factories/declaration.ts
@@ -179,6 +179,7 @@ function setupDeclaration(context: Context, reflection: DeclarationReflection, n
     reflection.setFlag(ReflectionFlag.Protected, !!(modifiers & ts.ModifierFlags.Protected));
     reflection.setFlag(ReflectionFlag.Public,    !!(modifiers & ts.ModifierFlags.Public));
     reflection.setFlag(ReflectionFlag.Optional,  !!(node['questionToken']));
+    reflection.setFlag(ReflectionFlag.Readonly,  !!(modifiers & ts.ModifierFlags.Readonly));
 
     if (
         context.isInherit &&

diff --git a/src/lib/converter/nodes/variable.ts b/src/lib/converter/nodes/variable.ts
@@ -85,8 +85,8 @@ export class VariableConverter extends ConverterNodeComponent<ts.VariableDeclara
                     break;
                 case ReflectionKind.Property:
                     if (node.modifiers
-                        && node.modifiers.some( m => m.kind === ts.SyntaxKind.AbstractKeyword )) {
-                    variable.setFlag(ReflectionFlag.Abstract, true);
+                        && node.modifiers.some( m => m.kind === ts.SyntaxKind.AbstractKeyword)) {
+                        variable.setFlag(ReflectionFlag.Abstract, true);
                     }
                     break;
             }

diff --git a/src/lib/models/reflections/abstract.ts b/src/lib/models/reflections/abstract.ts
@@ -86,7 +86,8 @@ export enum ReflectionFlag {
     ConstructorProperty = 1024,
     Abstract = 2048,
     Const = 4096,
-    Let = 8192
+    Let = 8192,
+    Readonly = 16384
 }
 
 const relevantFlags: ReflectionFlag[] = [
@@ -99,7 +100,8 @@ const relevantFlags: ReflectionFlag[] = [
     ReflectionFlag.Rest,
     ReflectionFlag.Abstract,
     ReflectionFlag.Let,
-    ReflectionFlag.Const
+    ReflectionFlag.Const,
+    ReflectionFlag.Readonly
 ];
 
 /**
@@ -201,6 +203,10 @@ export class ReflectionFlags extends Array<string> {
         return this.hasFlag(ReflectionFlag.Let);
     }
 
+    get isReadonly() {
+        return this.hasFlag(ReflectionFlag.Readonly);
+    }
+
     setFlag(flag: ReflectionFlag, set: boolean) {
         switch (flag) {
             case ReflectionFlag.Private:

diff --git a/src/test/converter/class/specs-with-lump-categories.json b/src/test/converter/class/specs-with-lump-categories.json
@@ -1629,7 +1629,8 @@
               "kind": 1024,
               "kindString": "Property",
               "flags": {
-                "isConstructorProperty": true
+                "isConstructorProperty": true,
+                "isReadonly": true
               },
               "comment": {
                 "shortText": "Vector name\n"
@@ -1807,7 +1808,8 @@
               "kind": 1024,
               "kindString": "Property",
               "flags": {
-                "isConstructorProperty": true
+                "isConstructorProperty": true,
+                "isReadonly": true
               },
               "comment": {
                 "shortText": "Vector name\n"

diff --git a/src/test/converter/class/specs.json b/src/test/converter/class/specs.json
@@ -1625,7 +1625,8 @@
               "kind": 1024,
               "kindString": "Property",
               "flags": {
-                "isConstructorProperty": true
+                "isConstructorProperty": true,
+                "isReadonly": true
               },
               "comment": {
                 "shortText": "Vector name\n"
@@ -1803,7 +1804,8 @@
               "kind": 1024,
               "kindString": "Property",
               "flags": {
-                "isConstructorProperty": true
+                "isConstructorProperty": true,
+                "isReadonly": true
               },
               "comment": {
                 "shortText": "Vector name\n"

diff --git a/src/test/renderer/specs/classes/_classes_.genericclass.html b/src/test/renderer/specs/classes/_classes_.genericclass.html
@@ -237,7 +237,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> p4</h3>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
 					<a name="p5" class="tsd-anchor"></a>
-					<h3>p5</h3>
+					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> p5</h3>
 					<div class="tsd-signature tsd-kind-icon">p5<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 					</aside>

diff --git a/src/test/renderer/specs/classes/_classes_.nongenericclass.html b/src/test/renderer/specs/classes/_classes_.nongenericclass.html
@@ -214,7 +214,7 @@ <h3>p3</h3>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
 					<a name="p5" class="tsd-anchor"></a>
-					<h3>p5</h3>
+					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> p5</h3>
 					<div class="tsd-signature tsd-kind-icon">p5<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="_classes_.genericclass.html">GenericClass</a>.<a href="_classes_.genericclass.html#p5">p5</a></p>