Infer readonly from class properties

Author: ShukantPal

packages/webdoc-parser/src/symbols-babel/extract-symbol.js

@@ -101,6 +101,7 @@ export default function extractSymbol(
     name = node.key.name;
 
     nodeSymbol.meta.access = node.access || node.accessibility;
+    nodeSymbol.meta.readonly = node.readonly;
     nodeSymbol.meta.dataType = extractType(node);
     nodeSymbol.meta.scope = node.static ? "static" : "instance";
     nodeSymbol.meta.type = "PropertyDoc";

packages/webdoc-parser/test/lang-ts.js

@@ -8,12 +8,11 @@ describe("@webdoc/parser.LanguageIntegration{@lang ts}", function() {
   it("should parse classes correctly", function() {
     let symtree = buildSymbolTree(`
       class ClassName {
-        private initProperty: number = 11;
+        private readonly initProperty: number = 11;
 
         constructor() {
           /**
            * This is a property whose data-type & access should be inferred.
-           * @default 9
            */
           this.initProperty = 9;
         }
@@ -50,6 +49,7 @@ describe("@webdoc/parser.LanguageIntegration{@lang ts}", function() {
     expect(symbolInitProperty.meta.access).to.equal("private");
     expect(symbolInitProperty.meta.defaultValue).to.equal(11);
     expect(symbolInitProperty.comment).to.not.equal("");
+    expect(symbolInitProperty.meta.readonly).to.equal(true);
   });
 
   it("should be able to parse type-casted objects for property symbols", function() {

packages/webdoc-types/index.js.flow

@@ -70,6 +70,7 @@ export type BaseDoc = {
   fires?: [],
   license?: string,
   loc?: SymbolLocation,
+  readonly?: boolean,
   scope?: "static" | "instance" | "inner" | "default",
   see?: DocLink[],
   since?: string,
@@ -258,6 +259,7 @@ export type TagType =
   "NSTag" |
   "LicenseTag" |
   "ParamTag" |
+  "ReadonlyTag" |
   "ReturnTag" |
   "SeeTag" |
   "SinceTag" |
@@ -286,6 +288,7 @@ export type Tag =
   NSTag |
   LicenseTag |
   ParamTag |
+  ReadonlyTag |
   ReturnTag |
   SeeTag |
   SinceTag |
@@ -314,6 +317,7 @@ export type TagShape =
   $Shape<NSTag> |
   $Shape<LicenseTag> |
   $Shape<ParamTag> |
+  $Shape<ReadonlyTag> |
   $Shape<ReturnTag> |
   $Shape<SeeTag> |
   $Shape<SinceTag> |
@@ -455,6 +459,11 @@ export type ParamTag = {
   type: "ParamTag"
 };
 
+export type ReadonlyTag = {
+  ...BaseTag,
+  type: "ReadonlyTag"
+};
+
 export type ReturnTag = {
   ...TypedTag,
   type: "ReturnTag"