diff --git a/README.md b/README.md
index 19f8fd52c..da24c56b7 100644
--- a/README.md
+++ b/README.md
@@ -142,7 +142,7 @@ Some of the guiding design goals for this library:
-## [@component-controls/react-docgen-info](https://github.com/ccontrols/component-controls/blob/master/frameworks/react)
+## [@component-controls/react-docgen-info](https://github.com/ccontrols/component-controls/blob/master/props-info/react-docgen)
Component controls react-docgen props info loader
@@ -156,7 +156,7 @@ Extract props info from react components. Although the latest version of `react-
-## [@component-controls/react-docgen-typescript-info](https://github.com/ccontrols/component-controls/blob/master/frameworks/react)
+## [@component-controls/react-docgen-typescript-info](https://github.com/ccontrols/component-controls/blob/master/props-info/react-docgen-typescript)
Component controls react-docgen-typescript props info loader
diff --git a/core/specification/README.md b/core/specification/README.md
index daaab1bea..0e9a9638a 100644
--- a/core/specification/README.md
+++ b/core/specification/README.md
@@ -3,7 +3,7 @@
- [Overview](#overview)
- [Installation](#installation)
- [API](#api)
- - [PropsInfoExtractorFunction](#propsinfoextractorfunction)
+ - [MethodParameterType](#methodparametertype)
# Overview
@@ -19,23 +19,20 @@ $ npm install @component-controls/specification --save-dev
# API
-
+
-## PropsInfoExtractorFunction
+## MethodParameterType
-callback function to extract props info table - ie docgen type libraries
-used to extract displayName, and props tables for a component
+_defined in [@component-controls/specification/src/test.ts](https://github.com/ccontrols/component-controls/tree/master/core/specification/src/test.ts#L1)_
-(`fileName`\*: string, `componentName`: undefined | string, `source`: undefined | string): Promise<[ComponentInfo](#componentinfo) | undefined> | [ComponentInfo](#componentinfo) | undefined;
-### parameters
-| Name | Type | Description |
-| --------------- | ------------------- | ----------- |
-| `fileName*` | string | |
-| `componentName` | undefined \| string | |
-| `source` | undefined \| string | |
+### properties
+
+| Name | Type | Description |
+| ------- | ------ | ----------- |
+| `name*` | string | |
diff --git a/core/specification/src/test.ts b/core/specification/src/test.ts
new file mode 100644
index 000000000..c0563daa1
--- /dev/null
+++ b/core/specification/src/test.ts
@@ -0,0 +1,3 @@
+export interface MethodParameterType {
+ name: string;
+}
diff --git a/core/specification/tmp-out-typedoc.json b/core/specification/tmp-out-typedoc.json
index 3a3d1b236..74c784dce 100644
--- a/core/specification/tmp-out-typedoc.json
+++ b/core/specification/tmp-out-typedoc.json
@@ -7,182 +7,66 @@
"children": [
{
"id": 1,
- "name": "\"propsinfo\"",
+ "name": "\"test\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
- "originalName": "/Users/atanasster/component-controls/core/specification/src/propsinfo.ts",
+ "originalName": "/Users/atanasster/component-controls/core/specification/src/test.ts",
"children": [
{
"id": 2,
- "name": "PropsInfoExtractorFunction",
- "kind": 4194304,
- "kindString": "Type alias",
+ "name": "MethodParameterType",
+ "kind": 256,
+ "kindString": "Interface",
"flags": {
"isExported": true
},
- "comment": {
- "shortText": "callback function to extract props info table - ie docgen type libraries\nused to extract displayName, and props tables for a component",
- "tags": [
- {
- "tag": "param",
- "text": "full name and path of the component path react-docgen needs it to extract babel configurations.",
- "param": "fileName"
- },
- {
- "tag": "param",
- "text": "optional component name react-docgen-typescript supports multiple exports for a file react-docgne does not use it.",
- "param": "componentName"
- },
- {
- "tag": "param",
- "text": "optional soure, saves time if its already loaded react-docgen accepts source as input parameter react-docgen-typescript does not use it.\n",
- "param": "source"
- },
- {
- "tag": "returns",
- "text": "async or normal function that loads ComponentInfo props info.\n"
- }
- ]
- },
- "sources": [
+ "children": [
{
- "fileName": "propsinfo.ts",
- "line": 13,
- "character": 38
- }
- ],
- "type": {
- "type": "reflection",
- "declaration": {
"id": 3,
- "name": "__type",
- "kind": 65536,
- "kindString": "Type literal",
+ "name": "name",
+ "kind": 1024,
+ "kindString": "Property",
"flags": {
"isExported": true
},
- "signatures": [
- {
- "id": 4,
- "name": "__call",
- "kind": 4096,
- "kindString": "Call signature",
- "flags": {
- "isExported": true
- },
- "parameters": [
- {
- "id": 5,
- "name": "fileName",
- "kind": 32768,
- "kindString": "Parameter",
- "flags": {
- "isExported": true
- },
- "type": {
- "type": "intrinsic",
- "name": "string"
- }
- },
- {
- "id": 6,
- "name": "componentName",
- "kind": 32768,
- "kindString": "Parameter",
- "flags": {
- "isExported": true,
- "isOptional": true
- },
- "type": {
- "type": "union",
- "types": [
- {
- "type": "intrinsic",
- "name": "undefined"
- },
- {
- "type": "intrinsic",
- "name": "string"
- }
- ]
- }
- },
- {
- "id": 7,
- "name": "source",
- "kind": 32768,
- "kindString": "Parameter",
- "flags": {
- "isExported": true,
- "isOptional": true
- },
- "type": {
- "type": "union",
- "types": [
- {
- "type": "intrinsic",
- "name": "undefined"
- },
- {
- "type": "intrinsic",
- "name": "string"
- }
- ]
- }
- }
- ],
- "type": {
- "type": "union",
- "types": [
- {
- "type": "reference",
- "typeArguments": [
- {
- "type": "union",
- "types": [
- {
- "type": "reference",
- "name": "ComponentInfo"
- },
- {
- "type": "intrinsic",
- "name": "undefined"
- }
- ]
- }
- ],
- "name": "Promise"
- },
- {
- "type": "reference",
- "name": "ComponentInfo"
- },
- {
- "type": "intrinsic",
- "name": "undefined"
- }
- ]
- }
- }
- ],
"sources": [
{
- "fileName": "propsinfo.ts",
- "line": 13,
- "character": 40
+ "fileName": "test.ts",
+ "line": 2,
+ "character": 6
}
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "groups": [
+ {
+ "title": "Properties",
+ "kind": 1024,
+ "children": [
+ 3
]
}
- }
+ ],
+ "sources": [
+ {
+ "fileName": "test.ts",
+ "line": 1,
+ "character": 36
+ }
+ ]
}
],
"groups": [
{
- "title": "Type aliases",
- "kind": 4194304,
+ "title": "Interfaces",
+ "kind": 256,
"children": [
2
]
@@ -190,7 +74,7 @@
],
"sources": [
{
- "fileName": "propsinfo.ts",
+ "fileName": "test.ts",
"line": 1,
"character": 0
}
diff --git a/props-info/react-docgen-typescript/README.md b/props-info/react-docgen-typescript/README.md
index 9be759698..05f80cfba 100644
--- a/props-info/react-docgen-typescript/README.md
+++ b/props-info/react-docgen-typescript/README.md
@@ -3,12 +3,21 @@
- [Overview](#overview)
- [Installation](#installation)
- [API](#api)
- - [Parser](#parser)
+ - [run](#run)
+ - [RectDocgenTypescriptOptions](#rectdocgentypescriptoptions)
+ - [ComponentDoc](#componentdoc)
+ - [ParserOptions](#parseroptions)
+ - [Method](#method)
+ - [Props](#props)
- [ComponentNameResolver](#componentnameresolver)
+ - [StaticPropFilter](#staticpropfilter)
- [PropFilter](#propfilter)
- - [defaultParserOpts](#defaultparseropts)
- - [ComponentNameResolver](#componentnameresolver-1)
- - [PropFilter](#propfilter-1)
+ - [MethodParameter](#methodparameter)
+ - [PropItem](#propitem)
+ - [Component](#component)
+ - [MethodParameterType](#methodparametertype)
+ - [ParentType](#parenttype)
+ - [PropItemType](#propitemtype)
# Overview
@@ -26,91 +35,60 @@ $ npm install @component-controls/react-docgen-typescript-info --save-dev
# API
-
+
-## Parser
+## run
-**Component**
+run API to generate react-docgen-typescript props information tables.
-### properties
+_defined in [@component-controls/react-docgen-typescript-info/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/props-info/react-docgen-typescript/src/index.ts#L14)_
-| Name | Type | Description |
-| ------- | ------ | ----------- |
-| `name*` | string | |
+**run**(`options`: [RectDocgenTypescriptOptions](#rectdocgentypescriptoptions)): [PropsInfoExtractorFunction](#propsinfoextractorfunction);
-**ComponentDoc**
+### parameters
-### properties
+| Name | Type | Description |
+| --------- | ----------------------------------------------------------- | --------------------- |
+| `options` | [RectDocgenTypescriptOptions](#rectdocgentypescriptoptions) | configuration options |
-| Name | Type | Description |
-| -------------- | -------------------- | ----------- |
-| `description*` | string | |
-| `displayName*` | string | |
-| `methods*` | [Method](#method)\[] | |
-| `props*` | [Props](#props) | |
+## RectDocgenTypescriptOptions
-**FileParser**
+a callback to transfor them props table and the options to be passd to react-docgen-typescript.
-### properties
+_defined in [@component-controls/react-docgen-typescript-info/src/types.ts](https://github.com/ccontrols/component-controls/tree/master/props-info/react-docgen-typescript/src/types.ts#L6)_
-| Name | Type | Description |
-| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| `parse*` | **parse**(`filePathOrPaths`\*: string \| string\[]): [ComponentDoc](#componentdoc)\[];### parameters| Name | Type | Description | | ------------------ | ------------------- | ----------- | | `filePathOrPaths*` | string \| string\[] | | | |
-| `parseWithProgramProvider*` | **parseWithProgramProvider**(`filePathOrPaths`\*: string \| string\[], `programProvider`: undefined \| (): [Program](#program);): [ComponentDoc](#componentdoc)\[];### parameters| Name | Type | Description | | ------------------ | ------------------------------------- | ----------- | | `filePathOrPaths*` | string \| string\[] | | | `programProvider` | undefined \| (): [Program](#program); | | | |
+**properties:**
-**JSDoc**
+callback to transform the props table
-### properties
+**transformProps**: undefined | (`props`\*: [ComponentDoc](#componentdoc)\[]): [ComponentDoc](#componentdoc);
-| Name | Type | Description |
-| -------------- | ------------------------------ | ----------- |
-| `description*` | string | |
-| `fullComment*` | string | |
-| `tags*` | StringIndexedObject<string> | |
+[ParserOptions](#parseroptions)
-**Method**
+--
-### properties
+## ComponentDoc
-| Name | Type | Description |
-| -------------- | -------------------------------------------------------------------- | ----------- |
-| `description*` | string | |
-| `docblock*` | string | |
-| `modifiers*` | string\[] | |
-| `name*` | string | |
-| `params*` | [MethodParameter](#methodparameter)\[] | |
-| `returns` | **description**: string \| null**type**: undefined \| string \| null | |
-
-**MethodParameter**
-
-### properties
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
-| Name | Type | Description |
-| ------------- | ------------------------------------------- | ----------- |
-| `description` | string \| null | |
-| `name*` | string | |
-| `type*` | [MethodParameterType](#methodparametertype) | |
-**MethodParameterType**
### properties
-| Name | Type | Description |
-| ------- | ------ | ----------- |
-| `name*` | string | |
+| Name | Type | Description |
+| -------------- | -------------------- | ----------- |
+| `description*` | string | |
+| `displayName*` | string | |
+| `methods*` | [Method](#method)\[] | |
+| `props*` | [Props](#props) | |
-**ParentType**
+## ParserOptions
-### properties
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
-| Name | Type | Description |
-| ----------- | ------ | ----------- |
-| `fileName*` | string | |
-| `name*` | string | |
-**ParserOptions**
### properties
@@ -121,44 +99,33 @@ $ npm install @component-controls/react-docgen-typescript-info --save-dev
| `savePropValueAsString` | undefined \| false \| true | |
| `shouldExtractLiteralValuesFromEnum` | undefined \| false \| true | |
-**PropItem**
+## Method
-### properties
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
-| Name | Type | Description |
-| --------------- | ----------------------------- | ----------- |
-| `defaultValue*` | any | |
-| `description*` | string | |
-| `name*` | string | |
-| `parent` | [ParentType](#parenttype) | |
-| `required*` | boolean | |
-| `type*` | [PropItemType](#propitemtype) | |
-**PropItemType**
### properties
-| Name | Type | Description |
-| ------- | ------------------- | ----------- |
-| `name*` | string | |
-| `raw` | undefined \| string | |
-| `value` | any | |
-
-**Props extends StringIndexedObject<[PropItem](#propitem)>**`key`\*: string: [PropItem](#propitem)
-
-**StaticPropFilter**
+| Name | Type | Description |
+| -------------- | -------------------------------------------------------------------- | ----------- |
+| `description*` | string | |
+| `docblock*` | string | |
+| `modifiers*` | string\[] | |
+| `name*` | string | |
+| `params*` | [MethodParameter](#methodparameter)\[] | |
+| `returns` | **description**: string \| null**type**: undefined \| string \| null | |
-### properties
+## Props
-| Name | Type | Description |
-| --------------------- | -------------------------- | ----------- |
-| `skipPropsWithName` | string\[] \| string | |
-| `skipPropsWithoutDoc` | undefined \| false \| true | |
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
-**StringIndexedObject**`key`\*: string:
+** extends StringIndexedObject<[PropItem](#propitem)>**`key`\*: string: [PropItem](#propitem)
## ComponentNameResolver
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
+
(`exp`\*: [Symbol](#symbol), `source`\*: [SourceFile](#sourcefile)): string | undefined | null | false;
### parameters
@@ -168,8 +135,23 @@ $ npm install @component-controls/react-docgen-typescript-info --save-dev
| `exp*` | [Symbol](#symbol) | |
| `source*` | [SourceFile](#sourcefile) | |
+## StaticPropFilter
+
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
+
+
+
+### properties
+
+| Name | Type | Description |
+| --------------------- | -------------------------- | ----------- |
+| `skipPropsWithName` | string\[] \| string | |
+| `skipPropsWithoutDoc` | undefined \| false \| true | |
+
## PropFilter
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
+
(`props`\*: [PropItem](#propitem), `component`\*: [Component](#component)): boolean;
### parameters
@@ -179,87 +161,66 @@ $ npm install @component-controls/react-docgen-typescript-info --save-dev
| `props*` | [PropItem](#propitem) | |
| `component*` | [Component](#component) | |
-## defaultParserOpts
+## MethodParameter
-[ParserOptions](#parseroptions)
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
-**getDefaultExportForFile**(`source`\*: [SourceFile](#sourcefile)): string;
-### parameters
-| Name | Type | Description |
-| --------- | ------------------------- | ----------- |
-| `source*` | [SourceFile](#sourcefile) | |
-
-**parse**(`filePathOrPaths`\*: string | string\[], `parserOpts`: [ParserOptions](#parseroptions)): [ComponentDoc](#componentdoc)\[];
-
-### parameters
+### properties
-| Name | Type | Description |
-| ------------------ | ------------------------------- | ----------- |
-| `filePathOrPaths*` | string \| string\[] | |
-| `parserOpts` | [ParserOptions](#parseroptions) | |
+| Name | Type | Description |
+| ------------- | ------------------------------------------- | ----------- |
+| `description` | string \| null | |
+| `name*` | string | |
+| `type*` | [MethodParameterType](#methodparametertype) | |
-**withCompilerOptions**(`compilerOptions`\*: [CompilerOptions](#compileroptions), `parserOpts`: [ParserOptions](#parseroptions)): [FileParser](#fileparser);
+## PropItem
-### parameters
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
-| Name | Type | Description |
-| ------------------ | ----------------------------------- | ----------- |
-| `compilerOptions*` | [CompilerOptions](#compileroptions) | |
-| `parserOpts` | [ParserOptions](#parseroptions) | |
-**withCustomConfig**(`tsconfigPath`\*: string, `parserOpts`\*: [ParserOptions](#parseroptions)): [FileParser](#fileparser);
-### parameters
+### properties
-| Name | Type | Description |
-| --------------- | ------------------------------- | ----------- |
-| `tsconfigPath*` | string | |
-| `parserOpts*` | [ParserOptions](#parseroptions) | |
+| Name | Type | Description |
+| --------------- | ----------------------------- | ----------- |
+| `defaultValue*` | any | |
+| `description*` | string | |
+| `name*` | string | |
+| `parent` | [ParentType](#parenttype) | |
+| `required*` | boolean | |
+| `type*` | [PropItemType](#propitemtype) | |
-**withDefaultConfig**(`parserOpts`: [ParserOptions](#parseroptions)): [FileParser](#fileparser);
+## Component
-### parameters
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
-| Name | Type | Description |
-| ------------ | ------------------------------- | ----------- |
-| `parserOpts` | [ParserOptions](#parseroptions) | |
-**ComponentDoc**
### properties
-| Name | Type | Description |
-| -------------- | -------------------- | ----------- |
-| `description*` | string | |
-| `displayName*` | string | |
-| `methods*` | [Method](#method)\[] | |
-| `props*` | [Props](#props) | |
+| Name | Type | Description |
+| ------- | ------ | ----------- |
+| `name*` | string | |
-## ComponentNameResolver
+## MethodParameterType
-(`exp`\*: [Symbol](#symbol), `source`\*: [SourceFile](#sourcefile)): string | undefined | null | false;
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
-### parameters
-| Name | Type | Description |
-| --------- | ------------------------- | ----------- |
-| `exp*` | [Symbol](#symbol) | |
-| `source*` | [SourceFile](#sourcefile) | |
-## PropFilter
+### properties
-(`props`\*: [PropItem](#propitem), `component`\*: [Component](#component)): boolean;
+| Name | Type | Description |
+| ------- | ------ | ----------- |
+| `name*` | string | |
-### parameters
+## ParentType
+
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
-| Name | Type | Description |
-| ------------ | ----------------------- | ----------- |
-| `props*` | [PropItem](#propitem) | |
-| `component*` | [Component](#component) | |
-**ParentType**
### properties
@@ -268,39 +229,11 @@ $ npm install @component-controls/react-docgen-typescript-info --save-dev
| `fileName*` | string | |
| `name*` | string | |
-**Component**
-
-### properties
-
-| Name | Type | Description |
-| ------- | ------ | ----------- |
-| `name*` | string | |
-
-**FileParser**
-
-### properties
-
-| Name | Type | Description |
-| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| `parse*` | **parse**(`filePathOrPaths`\*: string \| string\[]): [ComponentDoc](#componentdoc)\[];### parameters| Name | Type | Description | | ------------------ | ------------------- | ----------- | | `filePathOrPaths*` | string \| string\[] | | | |
-| `parseWithProgramProvider*` | **parseWithProgramProvider**(`filePathOrPaths`\*: string \| string\[], `programProvider`: undefined \| (): [Program](#program);): [ComponentDoc](#componentdoc)\[];### parameters| Name | Type | Description | | ------------------ | ------------------------------------- | ----------- | | `filePathOrPaths*` | string \| string\[] | | | `programProvider` | undefined \| (): [Program](#program); | | | |
-
-**Props extends StringIndexedObject<[PropItem](#propitem)>**`key`\*: string: [PropItem](#propitem)
+## PropItemType
-**PropItem**
+_defined in [react-docgen-typescript/lib/parser.d.ts](https://github.com/styleguidist/react-docgen-typescript)_
-### properties
-
-| Name | Type | Description |
-| --------------- | ----------------------------- | ----------- |
-| `defaultValue*` | any | |
-| `description*` | string | |
-| `name*` | string | |
-| `parent` | [ParentType](#parenttype) | |
-| `required*` | boolean | |
-| `type*` | [PropItemType](#propitemtype) | |
-**PropItemType**
### properties
diff --git a/props-info/react-docgen-typescript/tmp-out-typedoc.json b/props-info/react-docgen-typescript/tmp-out-typedoc.json
index fa93aa828..f32f54fee 100644
--- a/props-info/react-docgen-typescript/tmp-out-typedoc.json
+++ b/props-info/react-docgen-typescript/tmp-out-typedoc.json
@@ -7,7 +7,7 @@
"children": [
{
"id": 1,
- "name": "\"parser.d\"",
+ "name": "\"node_modules/react-docgen-typescript/lib/parser.d\"",
"kind": 1,
"kindString": "Module",
"flags": {
@@ -25,7 +25,7 @@
},
"children": [
{
- "id": 73,
+ "id": 69,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
@@ -34,7 +34,7 @@
},
"signatures": [
{
- "id": 74,
+ "id": 70,
"name": "new Parser",
"kind": 16384,
"kindString": "Constructor signature",
@@ -43,7 +43,7 @@
},
"parameters": [
{
- "id": 75,
+ "id": 71,
"name": "program",
"kind": 32768,
"kindString": "Parameter",
@@ -56,7 +56,7 @@
}
},
{
- "id": 76,
+ "id": 72,
"name": "opts",
"kind": 32768,
"kindString": "Parameter",
@@ -79,98 +79,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 95,
"character": 34
}
]
},
{
- "id": 69,
- "name": "checker",
- "kind": 1024,
- "kindString": "Property",
- "flags": {
- "isPrivate": true,
- "isExported": true
- },
- "sources": [
- {
- "fileName": "parser.d.ts",
- "line": 92,
- "character": 19
- }
- ],
- "type": {
- "type": "intrinsic",
- "name": "any"
- }
- },
- {
- "id": 70,
- "name": "propFilter",
- "kind": 1024,
- "kindString": "Property",
- "flags": {
- "isPrivate": true,
- "isExported": true
- },
- "sources": [
- {
- "fileName": "parser.d.ts",
- "line": 93,
- "character": 22
- }
- ],
- "type": {
- "type": "intrinsic",
- "name": "any"
- }
- },
- {
- "id": 72,
- "name": "savePropValueAsString",
- "kind": 1024,
- "kindString": "Property",
- "flags": {
- "isPrivate": true,
- "isExported": true
- },
- "sources": [
- {
- "fileName": "parser.d.ts",
- "line": 95,
- "character": 33
- }
- ],
- "type": {
- "type": "intrinsic",
- "name": "any"
- }
- },
- {
- "id": 71,
- "name": "shouldExtractLiteralValuesFromEnum",
- "kind": 1024,
- "kindString": "Property",
- "flags": {
- "isPrivate": true,
- "isExported": true
- },
- "sources": [
- {
- "fileName": "parser.d.ts",
- "line": 94,
- "character": 46
- }
- ],
- "type": {
- "type": "intrinsic",
- "name": "any"
- }
- },
- {
- "id": 125,
+ "id": 121,
"name": "extractDefaultPropsFromComponent",
"kind": 2048,
"kindString": "Method",
@@ -179,7 +95,7 @@
},
"signatures": [
{
- "id": 126,
+ "id": 122,
"name": "extractDefaultPropsFromComponent",
"kind": 4096,
"kindString": "Call signature",
@@ -188,7 +104,7 @@
},
"parameters": [
{
- "id": 127,
+ "id": 123,
"name": "symbol",
"kind": 32768,
"kindString": "Parameter",
@@ -201,7 +117,7 @@
}
},
{
- "id": 128,
+ "id": 124,
"name": "source",
"kind": 32768,
"kindString": "Parameter",
@@ -217,7 +133,7 @@
"type": {
"type": "reflection",
"declaration": {
- "id": 129,
+ "id": 125,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
@@ -226,7 +142,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 117,
"character": 79
}
@@ -237,14 +153,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 117,
"character": 36
}
]
},
{
- "id": 88,
+ "id": 84,
"name": "extractMembersFromType",
"kind": 2048,
"kindString": "Method",
@@ -253,7 +169,7 @@
},
"signatures": [
{
- "id": 89,
+ "id": 85,
"name": "extractMembersFromType",
"kind": 4096,
"kindString": "Call signature",
@@ -262,7 +178,7 @@
},
"parameters": [
{
- "id": 90,
+ "id": 86,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
@@ -286,14 +202,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 100,
"character": 26
}
]
},
{
- "id": 85,
+ "id": 81,
"name": "extractPropsFromTypeIfStatefulComponent",
"kind": 2048,
"kindString": "Method",
@@ -302,7 +218,7 @@
},
"signatures": [
{
- "id": 86,
+ "id": 82,
"name": "extractPropsFromTypeIfStatefulComponent",
"kind": 4096,
"kindString": "Call signature",
@@ -311,7 +227,7 @@
},
"parameters": [
{
- "id": 87,
+ "id": 83,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
@@ -341,14 +257,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 99,
"character": 43
}
]
},
{
- "id": 82,
+ "id": 78,
"name": "extractPropsFromTypeIfStatelessComponent",
"kind": 2048,
"kindString": "Method",
@@ -357,7 +273,7 @@
},
"signatures": [
{
- "id": 83,
+ "id": 79,
"name": "extractPropsFromTypeIfStatelessComponent",
"kind": 4096,
"kindString": "Call signature",
@@ -366,7 +282,7 @@
},
"parameters": [
{
- "id": 84,
+ "id": 80,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
@@ -396,14 +312,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 98,
"character": 44
}
]
},
{
- "id": 116,
+ "id": 112,
"name": "findDocComment",
"kind": 2048,
"kindString": "Method",
@@ -412,7 +328,7 @@
},
"signatures": [
{
- "id": 117,
+ "id": 113,
"name": "findDocComment",
"kind": 4096,
"kindString": "Call signature",
@@ -421,7 +337,7 @@
},
"parameters": [
{
- "id": 118,
+ "id": 114,
"name": "symbol",
"kind": 32768,
"kindString": "Parameter",
@@ -443,14 +359,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 109,
"character": 18
}
]
},
{
- "id": 100,
+ "id": 96,
"name": "getCallSignature",
"kind": 2048,
"kindString": "Method",
@@ -459,7 +375,7 @@
},
"signatures": [
{
- "id": 101,
+ "id": 97,
"name": "getCallSignature",
"kind": 4096,
"kindString": "Call signature",
@@ -468,7 +384,7 @@
},
"parameters": [
{
- "id": 102,
+ "id": 98,
"name": "symbol",
"kind": 32768,
"kindString": "Parameter",
@@ -489,14 +405,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 104,
"character": 20
}
]
},
{
- "id": 77,
+ "id": 73,
"name": "getComponentInfo",
"kind": 2048,
"kindString": "Method",
@@ -505,7 +421,7 @@
},
"signatures": [
{
- "id": 78,
+ "id": 74,
"name": "getComponentInfo",
"kind": 4096,
"kindString": "Call signature",
@@ -514,7 +430,7 @@
},
"parameters": [
{
- "id": 79,
+ "id": 75,
"name": "exp",
"kind": 32768,
"kindString": "Parameter",
@@ -527,7 +443,7 @@
}
},
{
- "id": 80,
+ "id": 76,
"name": "source",
"kind": 32768,
"kindString": "Parameter",
@@ -540,7 +456,7 @@
}
},
{
- "id": 81,
+ "id": 77,
"name": "componentNameResolver",
"kind": 32768,
"kindString": "Parameter",
@@ -550,7 +466,7 @@
},
"type": {
"type": "reference",
- "id": 141,
+ "id": 137,
"name": "ComponentNameResolver"
}
}
@@ -573,14 +489,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 97,
"character": 20
}
]
},
{
- "id": 109,
+ "id": 105,
"name": "getDocgenType",
"kind": 2048,
"kindString": "Method",
@@ -589,7 +505,7 @@
},
"signatures": [
{
- "id": 110,
+ "id": 106,
"name": "getDocgenType",
"kind": 4096,
"kindString": "Call signature",
@@ -598,7 +514,7 @@
},
"parameters": [
{
- "id": 111,
+ "id": 107,
"name": "propType",
"kind": 32768,
"kindString": "Parameter",
@@ -620,14 +536,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 107,
"character": 17
}
]
},
{
- "id": 119,
+ "id": 115,
"name": "getFullJsDocComment",
"kind": 2048,
"kindString": "Method",
@@ -636,7 +552,7 @@
},
"signatures": [
{
- "id": 120,
+ "id": 116,
"name": "getFullJsDocComment",
"kind": 4096,
"kindString": "Call signature",
@@ -648,7 +564,7 @@
},
"parameters": [
{
- "id": 121,
+ "id": 117,
"name": "symbol",
"kind": 32768,
"kindString": "Parameter",
@@ -670,14 +586,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 115,
"character": 23
}
]
},
{
- "id": 122,
+ "id": 118,
"name": "getFunctionStatement",
"kind": 2048,
"kindString": "Method",
@@ -686,7 +602,7 @@
},
"signatures": [
{
- "id": 123,
+ "id": 119,
"name": "getFunctionStatement",
"kind": 4096,
"kindString": "Call signature",
@@ -695,7 +611,7 @@
},
"parameters": [
{
- "id": 124,
+ "id": 120,
"name": "statement",
"kind": 32768,
"kindString": "Parameter",
@@ -733,14 +649,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 116,
"character": 24
}
]
},
{
- "id": 130,
+ "id": 126,
"name": "getLiteralValueFromPropertyAssignment",
"kind": 2048,
"kindString": "Method",
@@ -749,7 +665,7 @@
},
"signatures": [
{
- "id": 131,
+ "id": 127,
"name": "getLiteralValueFromPropertyAssignment",
"kind": 4096,
"kindString": "Call signature",
@@ -758,7 +674,7 @@
},
"parameters": [
{
- "id": 132,
+ "id": 128,
"name": "property",
"kind": 32768,
"kindString": "Parameter",
@@ -809,14 +725,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 118,
"character": 41
}
]
},
{
- "id": 91,
+ "id": 87,
"name": "getMethodsInfo",
"kind": 2048,
"kindString": "Method",
@@ -825,7 +741,7 @@
},
"signatures": [
{
- "id": 92,
+ "id": 88,
"name": "getMethodsInfo",
"kind": 4096,
"kindString": "Call signature",
@@ -834,7 +750,7 @@
},
"parameters": [
{
- "id": 93,
+ "id": 89,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
@@ -859,14 +775,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 101,
"character": 18
}
]
},
{
- "id": 94,
+ "id": 90,
"name": "getModifiers",
"kind": 2048,
"kindString": "Method",
@@ -875,7 +791,7 @@
},
"signatures": [
{
- "id": 95,
+ "id": 91,
"name": "getModifiers",
"kind": 4096,
"kindString": "Call signature",
@@ -884,7 +800,7 @@
},
"parameters": [
{
- "id": 96,
+ "id": 92,
"name": "member",
"kind": 32768,
"kindString": "Parameter",
@@ -908,14 +824,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 102,
"character": 16
}
]
},
{
- "id": 97,
+ "id": 93,
"name": "getParameterInfo",
"kind": 2048,
"kindString": "Method",
@@ -924,7 +840,7 @@
},
"signatures": [
{
- "id": 98,
+ "id": 94,
"name": "getParameterInfo",
"kind": 4096,
"kindString": "Call signature",
@@ -933,7 +849,7 @@
},
"parameters": [
{
- "id": 99,
+ "id": 95,
"name": "callSignature",
"kind": 32768,
"kindString": "Parameter",
@@ -958,14 +874,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 103,
"character": 20
}
]
},
{
- "id": 133,
+ "id": 129,
"name": "getPropMap",
"kind": 2048,
"kindString": "Method",
@@ -974,7 +890,7 @@
},
"signatures": [
{
- "id": 134,
+ "id": 130,
"name": "getPropMap",
"kind": 4096,
"kindString": "Call signature",
@@ -983,7 +899,7 @@
},
"parameters": [
{
- "id": 135,
+ "id": 131,
"name": "properties",
"kind": 32768,
"kindString": "Parameter",
@@ -1043,14 +959,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 119,
"character": 14
}
]
},
{
- "id": 112,
+ "id": 108,
"name": "getPropsInfo",
"kind": 2048,
"kindString": "Method",
@@ -1059,7 +975,7 @@
},
"signatures": [
{
- "id": 113,
+ "id": 109,
"name": "getPropsInfo",
"kind": 4096,
"kindString": "Call signature",
@@ -1068,7 +984,7 @@
},
"parameters": [
{
- "id": 114,
+ "id": 110,
"name": "propsObj",
"kind": 32768,
"kindString": "Parameter",
@@ -1081,7 +997,7 @@
}
},
{
- "id": 115,
+ "id": 111,
"name": "defaultProps",
"kind": 32768,
"kindString": "Parameter",
@@ -1111,14 +1027,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 108,
"character": 16
}
]
},
{
- "id": 106,
+ "id": 102,
"name": "getReturnDescription",
"kind": 2048,
"kindString": "Method",
@@ -1127,7 +1043,7 @@
},
"signatures": [
{
- "id": 107,
+ "id": 103,
"name": "getReturnDescription",
"kind": 4096,
"kindString": "Call signature",
@@ -1136,7 +1052,7 @@
},
"parameters": [
{
- "id": 108,
+ "id": 104,
"name": "symbol",
"kind": 32768,
"kindString": "Parameter",
@@ -1166,14 +1082,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 106,
"character": 24
}
]
},
{
- "id": 103,
+ "id": 99,
"name": "isTaggedPublic",
"kind": 2048,
"kindString": "Method",
@@ -1182,7 +1098,7 @@
},
"signatures": [
{
- "id": 104,
+ "id": 100,
"name": "isTaggedPublic",
"kind": 4096,
"kindString": "Call signature",
@@ -1191,7 +1107,7 @@
},
"parameters": [
{
- "id": 105,
+ "id": 101,
"name": "symbol",
"kind": 32768,
"kindString": "Parameter",
@@ -1212,7 +1128,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 105,
"character": 18
}
@@ -1224,47 +1140,37 @@
"title": "Constructors",
"kind": 512,
"children": [
- 73
- ]
- },
- {
- "title": "Properties",
- "kind": 1024,
- "children": [
- 69,
- 70,
- 72,
- 71
+ 69
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
- 125,
- 88,
- 85,
- 82,
- 116,
- 100,
- 77,
- 109,
- 119,
- 122,
- 130,
- 91,
- 94,
- 97,
- 133,
+ 121,
+ 84,
+ 81,
+ 78,
112,
- 106,
- 103
+ 96,
+ 73,
+ 105,
+ 115,
+ 118,
+ 126,
+ 87,
+ 90,
+ 93,
+ 129,
+ 108,
+ 102,
+ 99
]
}
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 91,
"character": 27
}
@@ -1289,7 +1195,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 41,
"character": 8
}
@@ -1311,7 +1217,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 40,
"character": 26
}
@@ -1336,7 +1242,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 7,
"character": 15
}
@@ -1356,7 +1262,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 6,
"character": 15
}
@@ -1376,7 +1282,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 9,
"character": 11
}
@@ -1400,7 +1306,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 8,
"character": 9
}
@@ -1426,7 +1332,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 5,
"character": 29
}
@@ -1497,7 +1403,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 66,
"character": 9
}
@@ -1605,7 +1511,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 67,
"character": 28
}
@@ -1624,7 +1530,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 65,
"character": 27
}
@@ -1645,7 +1551,7 @@
"flags": {},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 87,
"character": 15
}
@@ -1663,7 +1569,7 @@
"flags": {},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 88,
"character": 15
}
@@ -1681,7 +1587,7 @@
"flags": {},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 89,
"character": 8
}
@@ -1712,7 +1618,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 86,
"character": 15
}
@@ -1737,7 +1643,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 30,
"character": 15
}
@@ -1757,7 +1663,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 23,
"character": 12
}
@@ -1777,7 +1683,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 24,
"character": 13
}
@@ -1800,7 +1706,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 22,
"character": 8
}
@@ -1820,7 +1726,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 25,
"character": 10
}
@@ -1845,7 +1751,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 26,
"character": 11
}
@@ -1875,7 +1781,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 27,
"character": 19
}
@@ -1905,7 +1811,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 28,
"character": 12
}
@@ -1937,7 +1843,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 26,
"character": 13
}
@@ -1968,7 +1874,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 21,
"character": 23
}
@@ -1994,7 +1900,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 34,
"character": 15
}
@@ -2023,7 +1929,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 33,
"character": 8
}
@@ -2043,7 +1949,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 35,
"character": 8
}
@@ -2068,7 +1974,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 32,
"character": 32
}
@@ -2093,7 +1999,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 38,
"character": 8
}
@@ -2115,7 +2021,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 37,
"character": 36
}
@@ -2140,7 +2046,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 50,
"character": 12
}
@@ -2160,7 +2066,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 49,
"character": 8
}
@@ -2183,7 +2089,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 48,
"character": 27
}
@@ -2209,14 +2115,14 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 56,
"character": 25
}
],
"type": {
"type": "reference",
- "id": 141,
+ "id": 137,
"name": "ComponentNameResolver"
}
},
@@ -2231,7 +2137,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 55,
"character": 14
}
@@ -2246,7 +2152,7 @@
},
{
"type": "reference",
- "id": 136,
+ "id": 132,
"name": "PropFilter"
}
]
@@ -2263,7 +2169,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 58,
"character": 25
}
@@ -2297,7 +2203,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 57,
"character": 38
}
@@ -2335,7 +2241,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 54,
"character": 30
}
@@ -2360,7 +2266,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 18,
"character": 16
}
@@ -2380,7 +2286,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 17,
"character": 15
}
@@ -2400,7 +2306,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 14,
"character": 8
}
@@ -2421,7 +2327,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 19,
"character": 10
}
@@ -2442,7 +2348,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 15,
"character": 12
}
@@ -2462,7 +2368,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 16,
"character": 8
}
@@ -2490,7 +2396,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 13,
"character": 25
}
@@ -2515,7 +2421,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 44,
"character": 8
}
@@ -2536,7 +2442,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 46,
"character": 7
}
@@ -2566,7 +2472,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 45,
"character": 9
}
@@ -2590,7 +2496,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 43,
"character": 29
}
@@ -2637,7 +2543,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 11,
"character": 22
}
@@ -2677,7 +2583,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 61,
"character": 21
}
@@ -2710,7 +2616,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 62,
"character": 23
}
@@ -2746,7 +2652,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 60,
"character": 33
}
@@ -2803,7 +2709,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 2,
"character": 36
}
@@ -2817,7 +2723,7 @@
]
},
{
- "id": 141,
+ "id": 137,
"name": "ComponentNameResolver",
"kind": 4194304,
"kindString": "Type alias",
@@ -2826,7 +2732,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 53,
"character": 41
}
@@ -2834,7 +2740,7 @@
"type": {
"type": "reflection",
"declaration": {
- "id": 142,
+ "id": 138,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
@@ -2843,7 +2749,7 @@
},
"signatures": [
{
- "id": 143,
+ "id": 139,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
@@ -2852,7 +2758,7 @@
},
"parameters": [
{
- "id": 144,
+ "id": 140,
"name": "exp",
"kind": 32768,
"kindString": "Parameter",
@@ -2865,7 +2771,7 @@
}
},
{
- "id": 145,
+ "id": 141,
"name": "source",
"kind": 32768,
"kindString": "Parameter",
@@ -2903,7 +2809,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 53,
"character": 43
}
@@ -2912,7 +2818,7 @@
}
},
{
- "id": 136,
+ "id": 132,
"name": "PropFilter",
"kind": 4194304,
"kindString": "Type alias",
@@ -2921,7 +2827,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 52,
"character": 30
}
@@ -2929,7 +2835,7 @@
"type": {
"type": "reflection",
"declaration": {
- "id": 137,
+ "id": 133,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
@@ -2938,7 +2844,7 @@
},
"signatures": [
{
- "id": 138,
+ "id": 134,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
@@ -2947,7 +2853,7 @@
},
"parameters": [
{
- "id": 139,
+ "id": 135,
"name": "props",
"kind": 32768,
"kindString": "Parameter",
@@ -2961,7 +2867,7 @@
}
},
{
- "id": 140,
+ "id": 136,
"name": "component",
"kind": 32768,
"kindString": "Parameter",
@@ -2983,7 +2889,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 52,
"character": 32
}
@@ -2992,7 +2898,7 @@
}
},
{
- "id": 146,
+ "id": 142,
"name": "defaultParserOpts",
"kind": 32,
"kindString": "Variable",
@@ -3002,7 +2908,7 @@
},
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 64,
"character": 38
}
@@ -3014,7 +2920,7 @@
}
},
{
- "id": 162,
+ "id": 158,
"name": "getDefaultExportForFile",
"kind": 64,
"kindString": "Function",
@@ -3023,7 +2929,7 @@
},
"signatures": [
{
- "id": 163,
+ "id": 159,
"name": "getDefaultExportForFile",
"kind": 4096,
"kindString": "Call signature",
@@ -3032,7 +2938,7 @@
},
"parameters": [
{
- "id": 164,
+ "id": 160,
"name": "source",
"kind": 32768,
"kindString": "Parameter",
@@ -3053,14 +2959,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 121,
"character": 47
}
]
},
{
- "id": 147,
+ "id": 143,
"name": "parse",
"kind": 64,
"kindString": "Function",
@@ -3069,7 +2975,7 @@
},
"signatures": [
{
- "id": 148,
+ "id": 144,
"name": "parse",
"kind": 4096,
"kindString": "Call signature",
@@ -3081,7 +2987,7 @@
},
"parameters": [
{
- "id": 149,
+ "id": 145,
"name": "filePathOrPaths",
"kind": 32768,
"kindString": "Parameter",
@@ -3106,7 +3012,7 @@
}
},
{
- "id": 150,
+ "id": 146,
"name": "parserOpts",
"kind": 32768,
"kindString": "Parameter",
@@ -3133,14 +3039,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 73,
"character": 29
}
]
},
{
- "id": 158,
+ "id": 154,
"name": "withCompilerOptions",
"kind": 64,
"kindString": "Function",
@@ -3149,7 +3055,7 @@
},
"signatures": [
{
- "id": 159,
+ "id": 155,
"name": "withCompilerOptions",
"kind": 4096,
"kindString": "Call signature",
@@ -3161,7 +3067,7 @@
},
"parameters": [
{
- "id": 160,
+ "id": 156,
"name": "compilerOptions",
"kind": 32768,
"kindString": "Parameter",
@@ -3174,7 +3080,7 @@
}
},
{
- "id": 161,
+ "id": 157,
"name": "parserOpts",
"kind": 32768,
"kindString": "Parameter",
@@ -3198,14 +3104,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 85,
"character": 43
}
]
},
{
- "id": 154,
+ "id": 150,
"name": "withCustomConfig",
"kind": 64,
"kindString": "Function",
@@ -3214,7 +3120,7 @@
},
"signatures": [
{
- "id": 155,
+ "id": 151,
"name": "withCustomConfig",
"kind": 4096,
"kindString": "Call signature",
@@ -3226,7 +3132,7 @@
},
"parameters": [
{
- "id": 156,
+ "id": 152,
"name": "tsconfigPath",
"kind": 32768,
"kindString": "Parameter",
@@ -3239,7 +3145,7 @@
}
},
{
- "id": 157,
+ "id": 153,
"name": "parserOpts",
"kind": 32768,
"kindString": "Parameter",
@@ -3262,14 +3168,14 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 81,
"character": 40
}
]
},
{
- "id": 151,
+ "id": 147,
"name": "withDefaultConfig",
"kind": 64,
"kindString": "Function",
@@ -3278,7 +3184,7 @@
},
"signatures": [
{
- "id": 152,
+ "id": 148,
"name": "withDefaultConfig",
"kind": 4096,
"kindString": "Call signature",
@@ -3290,7 +3196,7 @@
},
"parameters": [
{
- "id": 153,
+ "id": 149,
"name": "parserOpts",
"kind": 32768,
"kindString": "Parameter",
@@ -3314,7 +3220,7 @@
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
"line": 77,
"character": 41
}
@@ -3353,32 +3259,283 @@
"title": "Type aliases",
"kind": 4194304,
"children": [
- 141,
- 136
+ 137,
+ 132
]
},
{
"title": "Variables",
"kind": 32,
"children": [
- 146
+ 142
]
},
{
"title": "Functions",
"kind": 64,
"children": [
- 162,
- 147,
158,
+ 143,
154,
- 151
+ 150,
+ 147
+ ]
+ }
+ ],
+ "sources": [
+ {
+ "fileName": "node_modules/react-docgen-typescript/lib/parser.d.ts",
+ "line": 1,
+ "character": 0
+ }
+ ]
+ },
+ {
+ "id": 168,
+ "name": "\"props-info/react-docgen-typescript/src/index\"",
+ "kind": 1,
+ "kindString": "Module",
+ "flags": {
+ "isExported": true
+ },
+ "originalName": "/Users/atanasster/component-controls/props-info/react-docgen-typescript/src/index.ts",
+ "children": [
+ {
+ "id": 169,
+ "name": "run",
+ "kind": 64,
+ "kindString": "Function",
+ "flags": {
+ "isExported": true,
+ "isConst": true
+ },
+ "comment": {
+ "shortText": "run API to generate react-docgen-typescript props information tables.",
+ "returns": "a callable function of type PropsInfoExtractorFunction\n"
+ },
+ "signatures": [
+ {
+ "id": 170,
+ "name": "run",
+ "kind": 4096,
+ "kindString": "Call signature",
+ "flags": {
+ "isExported": true
+ },
+ "comment": {
+ "shortText": "run API to generate react-docgen-typescript props information tables.",
+ "returns": "a callable function of type PropsInfoExtractorFunction\n"
+ },
+ "parameters": [
+ {
+ "id": 171,
+ "name": "options",
+ "kind": 32768,
+ "kindString": "Parameter",
+ "flags": {
+ "isExported": true,
+ "isOptional": true
+ },
+ "comment": {
+ "shortText": "configuration options"
+ },
+ "type": {
+ "type": "reference",
+ "id": 162,
+ "name": "RectDocgenTypescriptOptions"
+ }
+ }
+ ],
+ "type": {
+ "type": "reference",
+ "name": "PropsInfoExtractorFunction"
+ }
+ }
+ ],
+ "sources": [
+ {
+ "fileName": "props-info/react-docgen-typescript/src/index.ts",
+ "line": 14,
+ "character": 16
+ }
+ ]
+ }
+ ],
+ "groups": [
+ {
+ "title": "Functions",
+ "kind": 64,
+ "children": [
+ 169
+ ]
+ }
+ ],
+ "sources": [
+ {
+ "fileName": "props-info/react-docgen-typescript/src/index.ts",
+ "line": 1,
+ "character": 0
+ }
+ ]
+ },
+ {
+ "id": 161,
+ "name": "\"props-info/react-docgen-typescript/src/types\"",
+ "kind": 1,
+ "kindString": "Module",
+ "flags": {
+ "isExported": true
+ },
+ "originalName": "/Users/atanasster/component-controls/props-info/react-docgen-typescript/src/types.ts",
+ "children": [
+ {
+ "id": 162,
+ "name": "RectDocgenTypescriptOptions",
+ "kind": 4194304,
+ "kindString": "Type alias",
+ "flags": {
+ "isExported": true
+ },
+ "comment": {
+ "shortText": "a callback to transfor them props table and the options to be passd to react-docgen-typescript."
+ },
+ "sources": [
+ {
+ "fileName": "props-info/react-docgen-typescript/src/types.ts",
+ "line": 6,
+ "character": 39
+ }
+ ],
+ "type": {
+ "type": "intersection",
+ "types": [
+ {
+ "type": "reflection",
+ "declaration": {
+ "id": 163,
+ "name": "__type",
+ "kind": 65536,
+ "kindString": "Type literal",
+ "flags": {
+ "isExported": true
+ },
+ "children": [
+ {
+ "id": 164,
+ "name": "transformProps",
+ "kind": 32,
+ "kindString": "Variable",
+ "flags": {
+ "isExported": true,
+ "isOptional": true
+ },
+ "comment": {
+ "shortText": "callback to transform the props table"
+ },
+ "sources": [
+ {
+ "fileName": "props-info/react-docgen-typescript/src/types.ts",
+ "line": 10,
+ "character": 16
+ }
+ ],
+ "type": {
+ "type": "union",
+ "types": [
+ {
+ "type": "intrinsic",
+ "name": "undefined"
+ },
+ {
+ "type": "reflection",
+ "declaration": {
+ "id": 165,
+ "name": "__type",
+ "kind": 65536,
+ "kindString": "Type literal",
+ "flags": {
+ "isExported": true
+ },
+ "signatures": [
+ {
+ "id": 166,
+ "name": "__call",
+ "kind": 4096,
+ "kindString": "Call signature",
+ "flags": {
+ "isExported": true
+ },
+ "parameters": [
+ {
+ "id": 167,
+ "name": "props",
+ "kind": 32768,
+ "kindString": "Parameter",
+ "flags": {
+ "isExported": true
+ },
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "reference",
+ "id": 6,
+ "name": "ComponentDoc"
+ }
+ }
+ }
+ ],
+ "type": {
+ "type": "reference",
+ "id": 6,
+ "name": "ComponentDoc"
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ ],
+ "groups": [
+ {
+ "title": "Variables",
+ "kind": 32,
+ "children": [
+ 164
+ ]
+ }
+ ],
+ "sources": [
+ {
+ "fileName": "props-info/react-docgen-typescript/src/types.ts",
+ "line": 6,
+ "character": 41
+ }
+ ]
+ }
+ },
+ {
+ "type": "reference",
+ "id": 46,
+ "name": "ParserOptions"
+ }
+ ]
+ }
+ }
+ ],
+ "groups": [
+ {
+ "title": "Type aliases",
+ "kind": 4194304,
+ "children": [
+ 162
]
}
],
"sources": [
{
- "fileName": "parser.d.ts",
+ "fileName": "props-info/react-docgen-typescript/src/types.ts",
"line": 1,
"character": 0
}
@@ -3390,7 +3547,9 @@
"title": "Modules",
"kind": 1,
"children": [
- 1
+ 1,
+ 168,
+ 161
]
}
]
diff --git a/scripts/package-info.ts b/scripts/package-info.ts
new file mode 100644
index 000000000..3da591b82
--- /dev/null
+++ b/scripts/package-info.ts
@@ -0,0 +1,36 @@
+import fs from 'fs';
+import path from 'path';
+
+
+export const traverseFolder = (
+ filePath: string,
+ levels: number = 10,
+ fileName: string = 'package.json',
+): string | null => {
+ var files = fs.readdirSync(filePath);
+ if (levels === 0) {
+ return null;
+ }
+ const pckg = files.find(file => file === fileName);
+ if (pckg) {
+ return path.resolve(filePath, pckg);
+ }
+ return traverseFolder(
+ path.resolve(filePath, '..'),
+ levels - 1,
+ fileName,
+ );
+};
+
+export const getRepoPath = (initialPath = './'): { repo?: string, filePath?: string } => {
+ const packageFileName = traverseFolder(initialPath);
+ if (packageFileName) {
+ const packageJSON = JSON.parse(fs.readFileSync(packageFileName, 'utf8'));
+ const { repository: { url, directory }} = packageJSON;
+ if (url) {
+ const baseName = url.split('.').slice(0, -1).join('.')
+ return { repo: `${baseName}${directory ? `/tree/master/${directory}` : ''}`, filePath: packageFileName};
+ }
+ }
+ return {};
+}
\ No newline at end of file
diff --git a/scripts/tsdoc/extract-tsdoc.ts b/scripts/tsdoc/extract-tsdoc.ts
index 04bc13af1..1d0397281 100644
--- a/scripts/tsdoc/extract-tsdoc.ts
+++ b/scripts/tsdoc/extract-tsdoc.ts
@@ -1,6 +1,8 @@
+import path from 'path';
import fs from 'fs';
import { Application, TSConfigReader } from 'typedoc';
import { ModuleKind, ScriptTarget} from 'typescript';
+import { getRepoPath } from '../package-info';
import { Node, NodeChildren } from '../types';
@@ -14,11 +16,12 @@ app.bootstrap({
experimentalDecorators: true,
includeDeclarations: true,
excludeExternals: true,
+ excludePrivate: true,
});
export const extractTSDoc = (files: string[], entries: string[]): Node[] | undefined => {
const unresolvedTypeNames: string[] = [];
-
+ const repoNames: { [key: string]: { repo?: string, filePath?: string, packageName?: string, relativePath?: string} } = {};
const pushPropTable = (nodes: Node[], title: string) => {
const result: Node[] = [];
if (nodes) {
@@ -53,7 +56,7 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
]}
tableRow.children.push({
type: 'tableCell',
- children: child.type ? extractPropType(child.type) : extractFunction(child),
+ children: child.type ? extractPropType(child.type) : extractFunction(child, false),
});
tableRow.children.push({
type: 'tableCell',
@@ -64,7 +67,7 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
}
return result;
}
- const extractFunction = (node: any): Node[] => {
+ const extractFunction = (node: any, extractTable: boolean = true): Node[] => {
const result: Node[] = [];
const declaration: NodeChildren = {
type: 'paragraph',
@@ -73,7 +76,7 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
result.push(declaration);
if (node.kindString !== 'Type literal') {
if (unresolvedTypeNames.indexOf(node.name) > -1) {
- unresolvedTypeNames.splice(unresolvedTypeNames.indexOf(node.name), 1);
+ // unresolvedTypeNames.splice(unresolvedTypeNames.indexOf(node.name), 1);
}
declaration.children.push({
@@ -133,7 +136,9 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
type: 'text',
value: ';'
})
- result.push.apply(result, pushPropTable(signature.parameters, 'parameters'));
+ if (extractTable) {
+ result.push.apply(result, pushPropTable(signature.parameters, 'parameters'));
+ }
}
return result;
}
@@ -147,28 +152,24 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
}
result.push(declaration);
if (unresolvedTypeNames.indexOf(node.name) > -1) {
- unresolvedTypeNames.splice(unresolvedTypeNames.indexOf(node.name), 1);
+ // unresolvedTypeNames.splice(unresolvedTypeNames.indexOf(node.name), 1);
}
- const interfaceNode: NodeChildren = {
- type: 'strong',
- children: [{
- type: 'text',
- value: node.name,
- }]
- };
- declaration.children.push(interfaceNode);
+
if (node.extendedTypes && node.extendedTypes.length) {
- interfaceNode.children.push({
- type: 'text',
- value: ' extends ',
+
+ declaration.children.push({
+ type: 'strong',
+ children: [{
+ type: 'text',
+ value: ' extends ',
+ },
+ ...node.extendedTypes.reduce((acc: any,t: any) => ([...acc, ...extractPropType(t)]), [])
+ ]
});
- node.extendedTypes.forEach((t: any) => {
- interfaceNode.children.push.apply(interfaceNode.children, extractPropType(t));
- })
}
-
- if (node.indexSignature) {
- node.indexSignature.forEach((signature: any) => {
+ const children = node.indexSignature;
+ if (children) {
+ children.forEach((signature: any) => {
for (let i = 0; i < signature.parameters.length; i +=1) {
const p: any = signature.parameters[i];
if (i > 0) {
@@ -204,11 +205,11 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
}
});
}
- result.push.apply(result, pushPropTable(node.children, 'properties'));
+ result.push.apply(result, pushPropTable(node.children || node.type, 'properties'));
return result;
}
- const extractPropType = (p: any): Node[] => {
+ const extractPropType = (p: any, extractTable: boolean = false): Node[] => {
switch (p.type) {
case 'reference': {
if (p.typeArguments) {
@@ -236,6 +237,7 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
value: '>'
}]
}
+
if (unresolvedTypeNames.indexOf(p.name) === -1) {
unresolvedTypeNames.push(p.name);
}
@@ -257,7 +259,15 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
}
case 'reflection': {
if (p.declaration.signatures) {
- return extractFunction(p.declaration);
+ if (p.declaration.signatures.type) {
+ return extractPropType(p.declaration.signatures.type);
+ } else {
+ return extractFunction(p.declaration, extractTable);
+
+ }
+ }
+ if (!p.declaration.children) {
+ return [];
}
return p.declaration.children.map((t: any) => ({ t, value: extractPropType(t.type)})).reduce((acc: any, { t, value}: { t: any, value: Node[] }) => {
const children: Node[] = [];
@@ -347,41 +357,79 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
}
- const extractTSType = (node: any): Node[] => {
+ const extractTSType = (node: any, fileName: string): Node[] => {
const result: Node[] = [];
- switch (node.kindString) {
- case 'Type alias':
- case 'Type literal':
- default: {
- result.push({
- type: 'heading',
- depth: 2,
+ result.push({
+ type: 'heading',
+ depth: 2,
+ children: [
+ { type: 'text',
+ value: node.name,
+ }
+ ]
+ });
+
+ if (node.comment && node.comment.shortText) {
+ result.push({
+ type: 'paragraph',
+ children: [{
+ type: 'text',
+ value: node.comment.shortText,
+ }]
+ });
+ };
+ if (!repoNames[fileName]) {
+ repoNames[fileName] = getRepoPath(path.dirname(path.resolve(fileName)));
+ if (repoNames[fileName].filePath) {
+ repoNames[fileName].packageName = JSON.parse(fs.readFileSync(repoNames[fileName].filePath || '', 'utf8')).name;
+ repoNames[fileName].relativePath = path.relative(path.dirname(repoNames[fileName].filePath || './'), fileName);
+ }
+ }
+
+ if (repoNames[fileName]) {
+ const { repo, relativePath, packageName } = repoNames[fileName];
+ const source = node.sources && node.sources.length && node.sources[0];
+ const { line }: { fileName?: string, line?: number, character?: number } = source || {};
+ let sourceLocation = fileName.includes('node_modules') ? repo : `${repo}/${relativePath}#L${line}`;
+ result.push({
+ type: 'paragraph',
+ children: [{
+ type: 'emphasis',
children: [
- { type: 'text',
- value: node.name,
+ {
+ type: 'text',
+ value: 'defined in '
+ },
+ {
+ type: 'link',
+ url: sourceLocation,
+ children: [
+ {
+ type: 'text',
+ value: `${packageName}/${relativePath}`
+ }
+ ]
}
]
- });
- if (node.comment && node.comment.shortText) {
- result.push({
- type: 'paragraph',
- children: [{
- type: 'text',
- value: node.comment.shortText,
- }]
- });
- };
-
+ }]
+ });
+ }
+
+ switch (node.kindString) {
+ case 'Type alias':
+ case 'Type literal': {
if (node.type) {
- result.push.apply(result, extractPropType(node.type));
+ result.push.apply(result, extractPropType(node.type, true));
} else {
node.children.forEach((child: any) => {
- result.push.apply(result, extractPropType(child));
+ result.push.apply(result, extractPropType(child, true));
})
}
break;
}
- case 'Interface': {
+ case 'Class':
+ case 'Interface':
+ default: {
result.push.apply(result, extractInterface(node));
break;
}
@@ -402,10 +450,11 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
const content = JSON.parse(fs.readFileSync(fName, 'utf8'))
const result: Node[]= [];
for (const entry of entries) {
+
const main = content.children.find((child: any) => child.originalName === entry);
if (main) {
main.children.forEach((child: any) => {
- const nodes = extractTSType(child);
+ const nodes = extractTSType(child, main.originalName);
result.push.apply(result, nodes);
})
}
@@ -413,17 +462,21 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
while (unresolvedTypeNames.length > 0) {
const propName = unresolvedTypeNames[0];
let propNode;
+ let fileName;
for (const child of content.children) {
if (child.children) {
propNode = child.children.find((c: any) => c.name === propName);
if (propNode) {
+ fileName = child.originalName;
break;
}
}
};
if (propNode) {
- const nodes = extractTSType(propNode);
+ const nodes = extractTSType(propNode, fileName);
result.push.apply(result, nodes);
+ } else {
+ console.log('could not find external reference: ', propName);
}
unresolvedTypeNames.splice(0, 1);
}
@@ -432,6 +485,8 @@ export const extractTSDoc = (files: string[], entries: string[]): Node[] | undef
} finally {
// fs.unlinkSync(fName)
}
+ } else {
+ console.error('could not compile project')
}
return undefined;
}
\ No newline at end of file
diff --git a/scripts/tsdoc/insert-tsdoc.ts b/scripts/tsdoc/insert-tsdoc.ts
index 93090c529..3937cf450 100644
--- a/scripts/tsdoc/insert-tsdoc.ts
+++ b/scripts/tsdoc/insert-tsdoc.ts
@@ -13,7 +13,7 @@ export const insertTSDoc = (settings: Settings = { path: './src' }) => {
return (node: Node) => {
const sections = extractCustomTag(node, 'tsdoc-typescript');
if (sections) {
- sections.forEach(({ attrs, attributes}) => {
+ sections.forEach(({ attrs, attributes }) => {
if (attributes) {
const newNodes: Node[] = [];
@@ -21,6 +21,7 @@ export const insertTSDoc = (settings: Settings = { path: './src' }) => {
const entry = attributes.find(attribute => attribute[0] === 'entry');
if (entry) {
+
const fileNames = files ? files[1].split(',').filter(s => s) : [];
const entryNames = entry ? entry[1].split(',').filter(s => s) : [];
fileNames.push.apply(fileNames, entryNames);
diff --git a/scripts/utils.ts b/scripts/utils.ts
index 8d65f2c17..0530f3af5 100644
--- a/scripts/utils.ts
+++ b/scripts/utils.ts
@@ -1,9 +1,11 @@
import fs from 'fs';
import path from 'path';
import { Node, AttrsArg, SectionArg, TraverseCallback } from './types';
+import { getRepoPath } from './package-info';
const cleanQuotes = (txt: string): string => (txt ? txt.replace(/['"]+/g, '') : txt);
+
export const extractCustomTag = (node: Node, tagName: string): SectionArg[] | undefined => {
const nodes = node.children && node.children.filter((child: Node) => child.type ==='html' && child.value && child.value.startsWith(`<${tagName}`));
return nodes ? nodes.map((section: Node) => ({ section, match: section.value ? section.value.match(/(\w+)\s*=\s*((["'])(.*?)\3|([^>\s]*)(?=\s|\/>))(?=[^<]*>)/g): undefined }) )
@@ -64,11 +66,9 @@ export const traverseDirs = (attributes: string[][] | undefined, callback: Trav
if (attributes) {
const file = attributes.find(attribute => attribute[0] === 'path');
const sourcePath = file ? file[1] : './src';
- const packageJSON = JSON.parse(fs.readFileSync(path.resolve('./package.json'), 'utf8'));
- const { repository: { directory }} = packageJSON;
- const rootRepoDir = `https://github.com/ccontrols/component-controls/blob/master/${directory}`;
+ const { repo = ''} = getRepoPath(sourcePath) || './src';
const excludeFiles = attributes.find(attribute => attribute[0] === 'exclude');
const newNodes: Node[] = [];
- getDirectories(path.resolve(sourcePath), excludeFiles ? excludeFiles[1].split(','): ['index.ts'], path.join(rootRepoDir, sourcePath), newNodes);
+ getDirectories(path.resolve(sourcePath), excludeFiles ? excludeFiles[1].split(','): ['index.ts'], path.join(repo, sourcePath), newNodes);
}
}
\ No newline at end of file
diff --git a/ui/blocks/README.md b/ui/blocks/README.md
index 01ffadb67..17b91ea6b 100644
--- a/ui/blocks/README.md
+++ b/ui/blocks/README.md
@@ -38,7 +38,7 @@ Some of the guiding design goals for this library:
Displays import statement for a component as well as the component file source code
Optionally also displays some repository information from the component's package.json
-_BlockComponentSource [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/ComponentSource/block/BlockComponentSource.tsx)_
+_BlockComponentSource [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ComponentSource/block/BlockComponentSource.tsx)_
**Properties:**
@@ -79,7 +79,7 @@ _BlockComponentSource [source code](https:/github.com/ccontrols/component-contro
Displays import statement for a component as well as the component file source code
Optionally also displays some repository information from the component's package.json
-_ComponentSource [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/ComponentSource/plain/ComponentSource.tsx)_
+_ComponentSource [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ComponentSource/plain/ComponentSource.tsx)_
**Properties:**
@@ -116,7 +116,7 @@ _ComponentSource [source code](https:/github.com/ccontrols/component-controls/bl
Table block component to display a story's controls and their editors
-_BlockControlsTable [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/ControlsTable/block/BlockControlsTable.tsx)_
+_BlockControlsTable [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ControlsTable/block/BlockControlsTable.tsx)_
**Properties:**
@@ -136,7 +136,7 @@ _BlockControlsTable [source code](https:/github.com/ccontrols/component-controls
Table component to display a story's controls and their editors.
Can adapt to multiple groups of controls, displaying them in their own tabs.
-_ControlsTable [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/ControlsTable/plain/ControlsTable.tsx)_
+_ControlsTable [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ControlsTable/plain/ControlsTable.tsx)_
**Properties:**
@@ -153,7 +153,7 @@ _ControlsTable [source code](https:/github.com/ccontrols/component-controls/blob
Single table of controls, without specific handliong of groups.
The controls and storyId are already set in priops;
-_SingleControlsTable [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/ControlsTable/plain/SingleControlsTable.tsx)_
+_SingleControlsTable [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ControlsTable/plain/SingleControlsTable.tsx)_
**Properties:**
@@ -175,7 +175,7 @@ _SingleControlsTable [source code](https:/github.com/ccontrols/component-control
Description component with markdown.
The 'of' property can specify which component's description to display.
-_Description [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/Description/Description.tsx)_
+_Description [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Description/Description.tsx)_
**Properties:**
@@ -190,7 +190,7 @@ _Description [source code](https:/github.com/ccontrols/component-controls/blob/m
## BlockPropsTable
-_BlockPropsTable [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/PropsTable/block/BlockPropsTable.tsx)_
+_BlockPropsTable [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/PropsTable/block/BlockPropsTable.tsx)_
**Properties:**
@@ -229,7 +229,7 @@ _BlockPropsTable [source code](https:/github.com/ccontrols/component-controls/bl
## PropsTable
-_PropsTable [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/PropsTable/plain/PropsTable.tsx)_
+_PropsTable [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/PropsTable/plain/PropsTable.tsx)_
**Properties:**
@@ -265,7 +265,7 @@ _PropsTable [source code](https:/github.com/ccontrols/component-controls/blob/ma
## BlockStorySource
-_BlockStorySource [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/StorySource/block/BlockStorySource.tsx)_
+_BlockStorySource [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/StorySource/block/BlockStorySource.tsx)_
**Properties:**
@@ -309,7 +309,7 @@ Display source code of a story.
If controls are used, all story arguments will be highlighted.
Additional commands are made available if the repository data of the story is available.
-_StorySource [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/StorySource/plain/StorySource.tsx)_
+_StorySource [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/StorySource/plain/StorySource.tsx)_
## Subtitle
@@ -317,7 +317,7 @@ displays a subtitle as assigned to the story parameters:
story.parameters.componentSubtitle
or story.subtitle
-_Subtitle [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/Subtitle/Subtitle.tsx)_
+_Subtitle [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Subtitle/Subtitle.tsx)_
**Properties:**
@@ -337,7 +337,7 @@ _Subtitle [source code](https:/github.com/ccontrols/component-controls/blob/mast
displays a title as assigned to the story document
-_Title [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/Title/Title.tsx)_
+_Title [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Title/Title.tsx)_
**Properties:**
@@ -357,6 +357,6 @@ _Title [source code](https:/github.com/ccontrols/component-controls/blob/master/
error message when the control type is not found.
-_InvalidType [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/blocks/src/notifications/InvalidType.tsx)_
+_InvalidType [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/blocks/src/notifications/InvalidType.tsx)_
diff --git a/ui/components/README.md b/ui/components/README.md
index ee4432e77..64e2076a3 100644
--- a/ui/components/README.md
+++ b/ui/components/README.md
@@ -53,7 +53,7 @@ a strip of actions to be attached to a container
the action items contain the labels and click event handler
actions can accept an order prop, and can also be superimposed
-_ActionBar [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/ActionBar/ActionBar.tsx)_
+_ActionBar [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/ActionBar/ActionBar.tsx)_
**Properties:**
@@ -63,7 +63,7 @@ _ActionBar [source code](https:/github.com/ccontrols/component-controls/blob/mas
a boxed container with actions.
-_ActionContainer [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/ActionContainer/ActionContainer.tsx)_
+_ActionContainer [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/ActionContainer/ActionContainer.tsx)_
**Properties:**
@@ -78,7 +78,7 @@ _ActionContainer [source code](https:/github.com/ccontrols/component-controls/bl
a collapsible block with a title. The title creates also an attribute id and an octicon for github style navigation.
-_BlockContainer [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/BlockContainer/BlockContainer.tsx)_
+_BlockContainer [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/BlockContainer/BlockContainer.tsx)_
**Properties:**
@@ -90,7 +90,7 @@ _BlockContainer [source code](https:/github.com/ccontrols/component-controls/blo
Animated expand/collapse container component
-_Collapsible [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Collapsible/Collapsible.tsx)_
+_Collapsible [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Collapsible/Collapsible.tsx)_
**Properties:**
@@ -113,7 +113,7 @@ _Collapsible [source code](https:/github.com/ccontrols/component-controls/blob/m
Anchor link to an external url,
adds the default `target="_blank" rel="noopener noreferrer"` props
-_ExternalLink [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/ExternalLink/ExternalLink.tsx)_
+_ExternalLink [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/ExternalLink/ExternalLink.tsx)_
**Properties:**
@@ -141,7 +141,7 @@ _ExternalLink [source code](https:/github.com/ccontrols/component-controls/blob/
## FlexContainer
-_FlexContainer [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/FlexContainer/FlexContainer.tsx)_
+_FlexContainer [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/FlexContainer/FlexContainer.tsx)_
**Properties:**
@@ -152,7 +152,7 @@ _FlexContainer [source code](https:/github.com/ccontrols/component-controls/blob
Markdown display component to compile and display markdown at run-time.
Uses `markdown-to-jsx` to compile the markdown.
-_Markdown [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Markdown/Markdown.tsx)_
+_Markdown [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Markdown/Markdown.tsx)_
**Properties:**
@@ -168,13 +168,13 @@ _Markdown [source code](https:/github.com/ccontrols/component-controls/blob/mast
A Popover container that is triggered by a click/hover event.
Used to display enhanced information that could not fit into the main scren.
-_Popover [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Popover/Popover.tsx)_
+_Popover [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Popover/Popover.tsx)_
## Source
Syntax highliting source code component. Uses [prism](https://prismjs.com) for the actual source display.
-_Source [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Source/Source.tsx)_
+_Source [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Source/Source.tsx)_
**Properties:**
@@ -209,7 +209,7 @@ _Source [source code](https:/github.com/ccontrols/component-controls/blob/master
`h3` level heading with faded text and font-weight 400.
-_Subtitle [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Subtitle/Subtitle.tsx)_
+_Subtitle [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Subtitle/Subtitle.tsx)_
**Properties:**
@@ -222,7 +222,7 @@ _Subtitle [source code](https:/github.com/ccontrols/component-controls/blob/mast
Syntax highlighter component. Uses [prism](https://prismjs.com) for the actual source display.
-_SyntaxHighlighter [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/SyntaxHighlighter/SyntaxHighlighter.tsx)_
+_SyntaxHighlighter [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/SyntaxHighlighter/SyntaxHighlighter.tsx)_
**Properties:**
@@ -255,7 +255,7 @@ _SyntaxHighlighter [source code](https:/github.com/ccontrols/component-controls/
Table component. Uses [react-table](https://github.com/tannerlinsley/react-table) to display the data.
Can be grouped, filtered, sorted. Themed with theme-ui for consistency.
-_Table [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Table/Table.tsx)_
+_Table [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Table/Table.tsx)_
**Properties:**
@@ -291,29 +291,29 @@ _Table [source code](https:/github.com/ccontrols/component-controls/blob/master/
Tab heading - you should specify the title/label string as the children property. To be created inside the `` component through the children prop.
-_Tab [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Tabs/Tabs.tsx)_
+_Tab [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Tabs/Tabs.tsx)_
## TabList
Container for `` headings, to be created inside the `` component. The list of `` components should be passed as the children prop.
-_TabList [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Tabs/Tabs.tsx)_
+_TabList [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Tabs/Tabs.tsx)_
## TabPanel
Panel body container, to be created inside the `` component through the children prop.
-_TabPanel [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Tabs/Tabs.tsx)_
+_TabPanel [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Tabs/Tabs.tsx)_
## Tabs
Create tabs and multi-page ui layouts. Uses [react-tabs](https://reactcommunity.org/react-tabs/) component.
-_Tabs [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Tabs/Tabs.tsx)_
+_Tabs [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Tabs/Tabs.tsx)_
## Title
-_Title [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Title/Title.tsx)_
+_Title [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Title/Title.tsx)_
**Properties:**
@@ -326,7 +326,7 @@ _Title [source code](https:/github.com/ccontrols/component-controls/blob/master/
Toggle components can be used to edit boolean values. Uses [react-switch](https://github.com/markusenglund/react-switch) component.
-_Toggle [source code](https:/github.com/ccontrols/component-controls/blob/master/ui/components/src/Toggle/Toggle.tsx)_
+_Toggle [source code](https:/github.com/ccontrols/component-controls/tree/master/ui/components/src/Toggle/Toggle.tsx)_
**Properties:**
diff --git a/ui/editors/README.md b/ui/editors/README.md
index 4863eec2e..15afb8b7c 100644
--- a/ui/editors/README.md
+++ b/ui/editors/README.md
@@ -34,20 +34,20 @@ Property editors factory. Given a propey type, will return a editor compnent cla
@param type : specify the type ie 'text'
@returns a Property Editor class.
-_getPropertyEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/prop-factory.ts)_
+_getPropertyEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/prop-factory.ts)_
## addPropertyEditor
@param type : specify the type ie 'text'
@param editor : a Property Editor class.
-_addPropertyEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/prop-factory.ts)_
+_addPropertyEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/prop-factory.ts)_
## ArrayEditor
Array control editor.
-_ArrayEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/ArrayEditor/ArrayEditor.tsx)_
+_ArrayEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/ArrayEditor/ArrayEditor.tsx)_
**Properties:**
@@ -68,7 +68,7 @@ _ArrayEditor [source code](https:/github.com/ccontrols/component-controls/blob/m
Boolean control editor. Uses the Toggle component.
-_BooleanEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/BooleanEditor/BooleanEditor.tsx)_
+_BooleanEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/BooleanEditor/BooleanEditor.tsx)_
**Properties:**
@@ -89,7 +89,7 @@ _BooleanEditor [source code](https:/github.com/ccontrols/component-controls/blob
Button control editor.
-_ButtonEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/ButtonEditor/ButtonEditor.tsx)_
+_ButtonEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/ButtonEditor/ButtonEditor.tsx)_
**Properties:**
@@ -110,7 +110,7 @@ _ButtonEditor [source code](https:/github.com/ccontrols/component-controls/blob/
Color control editor.
-_ColorEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/ColorEditor/ColorEditor.tsx)_
+_ColorEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/ColorEditor/ColorEditor.tsx)_
**Properties:**
@@ -131,7 +131,7 @@ _ColorEditor [source code](https:/github.com/ccontrols/component-controls/blob/m
Date control editor.
-_DateEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/DateEditor/DateEditor.tsx)_
+_DateEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/DateEditor/DateEditor.tsx)_
**Properties:**
@@ -152,7 +152,7 @@ _DateEditor [source code](https:/github.com/ccontrols/component-controls/blob/ma
Files control editor.
-_FilesEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/FilesEditor/FilesEditor.tsx)_
+_FilesEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/FilesEditor/FilesEditor.tsx)_
**Properties:**
@@ -173,7 +173,7 @@ _FilesEditor [source code](https:/github.com/ccontrols/component-controls/blob/m
Number control editor.
-_NumberEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/NumberEditor/NumberEditor.tsx)_
+_NumberEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/NumberEditor/NumberEditor.tsx)_
**Properties:**
@@ -194,7 +194,7 @@ _NumberEditor [source code](https:/github.com/ccontrols/component-controls/blob/
Object control editor.
-_ObjectEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/ObjectEditor/ObjectEditor.tsx)_
+_ObjectEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/ObjectEditor/ObjectEditor.tsx)_
**Properties:**
@@ -215,7 +215,7 @@ _ObjectEditor [source code](https:/github.com/ccontrols/component-controls/blob/
Options control editor.
-_OptionsEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/OptionsEditor/OptionsEditor.tsx)_
+_OptionsEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/OptionsEditor/OptionsEditor.tsx)_
**Properties:**
@@ -236,7 +236,7 @@ _OptionsEditor [source code](https:/github.com/ccontrols/component-controls/blob
Text control editor.
-_TextEditor [source code](https:/github.com/ccontrols/component-controls/blob/master/core/specification/src/TextEditor/TextEditor.tsx)_
+_TextEditor [source code](https:/github.com/ccontrols/component-controls/tree/master/core/specification/src/TextEditor/TextEditor.tsx)_
**Properties:**