Skip to content

Commit 287720c

Browse files
Rel1cxRel1cx
authored
Improve typedoc formatting (#1322)
1 parent 161a0b8 commit 287720c

File tree

232 files changed

+3310
-5541
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

232 files changed

+3310
-5541
lines changed

‎.pkgs/configs/typedoc.base.json‎

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,38 @@
22
"$schema": "https://typedoc.org/schema.json",
33
"cleanOutputDir": true,
44
"disableSources": true,
5-
"hideGenerator": true,
5+
"entryPoints": [
6+
"src/index.ts"
7+
],
68
"excludeInternal": true,
9+
"expandObjects": true,
10+
"expandParameters": true,
11+
"hideGenerator": true,
12+
"hidePageHeader": true,
13+
"hidePageTitle": false,
14+
"indexFormat": "table",
15+
"parametersFormat": "table",
16+
"interfacePropertiesFormat": "table",
17+
"classPropertiesFormat": "table",
18+
"typeAliasPropertiesFormat": "table",
19+
"enumMembersFormat": "table",
20+
"propertyMembersFormat": "table",
21+
"typeDeclarationFormat": "table",
722
"jsDocCompatibility": true,
823
"logLevel": "Warn",
24+
"name": "Public APIs",
25+
"out": "docs",
26+
"plugin": [
27+
"typedoc-plugin-markdown",
28+
"typedoc-plugin-mdn-links"
29+
],
930
"readme": "none",
1031
"sort": [
1132
"kind",
1233
"instance-first",
1334
"alphabetical"
1435
],
15-
"plugin": [
16-
"typedoc-plugin-markdown",
17-
"typedoc-plugin-mdn-links"
18-
],
1936
"theme": "default",
37+
"useCodeBlocks": true,
2038
"useTsLinkResolution": true
2139
}

‎packages/core/docs/@eslint-react/namespaces/isReactAPI/README.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
[**@eslint-react/core**](../../../README.md)
2-
3-
***
4-
51
[@eslint-react/core](../../../README.md) / isReactAPI
62

73
# isReactAPI
84

95
## Type Aliases
106

11-
- [ReturnType](type-aliases/ReturnType.md)
7+
| Type Alias | Description |
8+
| ------ | ------ |
9+
| [ReturnType](type-aliases/ReturnType.md) | - |

‎packages/core/docs/@eslint-react/namespaces/isReactAPI/type-aliases/ReturnType.md‎

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,54 @@
1-
[**@eslint-react/core**](../../../../README.md)
2-
3-
***
4-
51
[@eslint-react/core](../../../../README.md) / [isReactAPI](../README.md) / ReturnType
62

73
# Type Alias: ReturnType()
84

9-
> **ReturnType** = \{(`context`, `node`): node is Identifier \| MemberExpression; (`context`): (`node`) => node is Identifier \| MemberExpression; \}
5+
```ts
6+
type ReturnType = {
7+
(context: RuleContext, node: Node | null | undefined): node is Identifier | MemberExpression;
8+
(context: RuleContext): (node: Node | null | undefined) => node is Identifier | MemberExpression;
9+
};
10+
```
1011

1112
## Call Signature
1213

13-
> (`context`, `node`): node is Identifier \| MemberExpression
14+
```ts
15+
(context: RuleContext, node: Node | null | undefined): node is Identifier | MemberExpression;
16+
```
1417
1518
### Parameters
1619
17-
#### context
18-
19-
`RuleContext`
20-
21-
#### node
22-
23-
`Node` | `null` | `undefined`
20+
| Parameter | Type |
21+
| ------ | ------ |
22+
| `context` | `RuleContext` |
23+
| `node` | `Node` \| `null` \| `undefined` |
2424
2525
### Returns
2626
2727
node is Identifier \| MemberExpression
2828
2929
## Call Signature
3030
31-
> (`context`): (`node`) => node is Identifier \| MemberExpression
31+
```ts
32+
(context: RuleContext): (node: Node | null | undefined) => node is Identifier | MemberExpression;
33+
```
3234

3335
### Parameters
3436

35-
#### context
36-
37-
`RuleContext`
37+
| Parameter | Type |
38+
| ------ | ------ |
39+
| `context` | `RuleContext` |
3840

3941
### Returns
4042

41-
> (`node`): node is Identifier \| MemberExpression
43+
```ts
44+
(node: Node | null | undefined): node is Identifier | MemberExpression;
45+
```
4246
4347
#### Parameters
4448
45-
##### node
46-
47-
`Node` | `null` | `undefined`
49+
| Parameter | Type |
50+
| ------ | ------ |
51+
| `node` | `Node` \| `null` \| `undefined` |
4852
4953
#### Returns
5054

‎packages/core/docs/@eslint-react/namespaces/isReactAPICall/README.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
[**@eslint-react/core**](../../../README.md)
2-
3-
***
4-
51
[@eslint-react/core](../../../README.md) / isReactAPICall
62

73
# isReactAPICall
84

95
## Type Aliases
106

11-
- [ReturnType](type-aliases/ReturnType.md)
7+
| Type Alias | Description |
8+
| ------ | ------ |
9+
| [ReturnType](type-aliases/ReturnType.md) | - |

‎packages/core/docs/@eslint-react/namespaces/isReactAPICall/type-aliases/ReturnType.md‎

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,54 @@
1-
[**@eslint-react/core**](../../../../README.md)
2-
3-
***
4-
51
[@eslint-react/core](../../../../README.md) / [isReactAPICall](../README.md) / ReturnType
62

73
# Type Alias: ReturnType()
84

9-
> **ReturnType** = \{(`context`, `node`): `node is CallExpression`; (`context`): (`node`) => `node is CallExpression`; \}
5+
```ts
6+
type ReturnType = {
7+
(context: RuleContext, node: Node | null | undefined): node is CallExpression;
8+
(context: RuleContext): (node: Node | null | undefined) => node is CallExpression;
9+
};
10+
```
1011

1112
## Call Signature
1213

13-
> (`context`, `node`): `node is CallExpression`
14+
```ts
15+
(context: RuleContext, node: Node | null | undefined): node is CallExpression;
16+
```
1417
1518
### Parameters
1619
17-
#### context
18-
19-
`RuleContext`
20-
21-
#### node
22-
23-
`Node` | `null` | `undefined`
20+
| Parameter | Type |
21+
| ------ | ------ |
22+
| `context` | `RuleContext` |
23+
| `node` | `Node` \| `null` \| `undefined` |
2424
2525
### Returns
2626
2727
`node is CallExpression`
2828
2929
## Call Signature
3030
31-
> (`context`): (`node`) => `node is CallExpression`
31+
```ts
32+
(context: RuleContext): (node: Node | null | undefined) => node is CallExpression;
33+
```
3234

3335
### Parameters
3436

35-
#### context
36-
37-
`RuleContext`
37+
| Parameter | Type |
38+
| ------ | ------ |
39+
| `context` | `RuleContext` |
3840

3941
### Returns
4042

41-
> (`node`): `node is CallExpression`
43+
```ts
44+
(node: Node | null | undefined): node is CallExpression;
45+
```
4246
4347
#### Parameters
4448
45-
##### node
46-
47-
`Node` | `null` | `undefined`
49+
| Parameter | Type |
50+
| ------ | ------ |
51+
| `node` | `Node` \| `null` \| `undefined` |
4852
4953
#### Returns
5054

‎packages/core/docs/@eslint-react/namespaces/useComponentCollector/README.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
[**@eslint-react/core**](../../../README.md)
2-
3-
***
4-
51
[@eslint-react/core](../../../README.md) / useComponentCollector
62

73
# useComponentCollector
84

95
## Type Aliases
106

11-
- [Options](type-aliases/Options.md)
12-
- [ReturnType](type-aliases/ReturnType.md)
7+
| Type Alias | Description |
8+
| ------ | ------ |
9+
| [Options](type-aliases/Options.md) | - |
10+
| [ReturnType](type-aliases/ReturnType.md) | - |

‎packages/core/docs/@eslint-react/namespaces/useComponentCollector/type-aliases/Options.md‎

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,19 @@
1-
[**@eslint-react/core**](../../../../README.md)
2-
3-
***
4-
51
[@eslint-react/core](../../../../README.md) / [useComponentCollector](../README.md) / Options
62

73
# Type Alias: Options
84

9-
> **Options** = `object`
5+
```ts
6+
type Options = {
7+
collectDisplayName?: boolean;
8+
collectHookCalls?: boolean;
9+
hint?: ComponentDetectionHint;
10+
};
11+
```
1012

1113
## Properties
1214

13-
### collectDisplayName?
14-
15-
> `optional` **collectDisplayName**: `boolean`
16-
17-
***
18-
19-
### collectHookCalls?
20-
21-
> `optional` **collectHookCalls**: `boolean`
22-
23-
***
24-
25-
### hint?
26-
27-
> `optional` **hint**: [`ComponentDetectionHint`](../../../../type-aliases/ComponentDetectionHint.md)
15+
| Property | Type |
16+
| ------ | ------ |
17+
| <a id="collectdisplayname"></a> `collectDisplayName?` | `boolean` |
18+
| <a id="collecthookcalls"></a> `collectHookCalls?` | `boolean` |
19+
| <a id="hint"></a> `hint?` | [`ComponentDetectionHint`](../../../../type-aliases/ComponentDetectionHint.md) |

‎packages/core/docs/@eslint-react/namespaces/useComponentCollector/type-aliases/ReturnType.md‎

Lines changed: 17 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,24 @@
1-
[**@eslint-react/core**](../../../../README.md)
2-
3-
***
4-
51
[@eslint-react/core](../../../../README.md) / [useComponentCollector](../README.md) / ReturnType
62

73
# Type Alias: ReturnType
84

9-
> **ReturnType** = `object`
5+
```ts
6+
type ReturnType = {
7+
ctx: {
8+
getAllComponents: (node: TSESTree.Program) => Map<string, FunctionComponent>;
9+
getCurrentEntries: () => FunctionEntry[];
10+
getCurrentEntry: () => FunctionEntry | unit;
11+
};
12+
listeners: ESLintUtils.RuleListener;
13+
};
14+
```
1015

1116
## Properties
1217

13-
### ctx
14-
15-
> **ctx**: `object`
16-
17-
#### getAllComponents()
18-
19-
> **getAllComponents**: (`node`) => [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)\<`string`, [`FunctionComponent`](../../../../interfaces/FunctionComponent.md)\>
20-
21-
##### Parameters
22-
23-
###### node
24-
25-
`TSESTree.Program`
26-
27-
##### Returns
28-
29-
[`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)\<`string`, [`FunctionComponent`](../../../../interfaces/FunctionComponent.md)\>
30-
31-
#### getCurrentEntries()
32-
33-
> **getCurrentEntries**: () => `FunctionEntry`[]
34-
35-
##### Returns
36-
37-
`FunctionEntry`[]
38-
39-
#### getCurrentEntry()
40-
41-
> **getCurrentEntry**: () => `FunctionEntry` \| `unit`
42-
43-
##### Returns
44-
45-
`FunctionEntry` \| `unit`
46-
47-
***
48-
49-
### listeners
50-
51-
> **listeners**: `ESLintUtils.RuleListener`
18+
| Property | Type |
19+
| ------ | ------ |
20+
| <a id="ctx"></a> `ctx` | \{ `getAllComponents`: (`node`: `TSESTree.Program`) => [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)\<`string`, [`FunctionComponent`](../../../../interfaces/FunctionComponent.md)\>; `getCurrentEntries`: () => `FunctionEntry`[]; `getCurrentEntry`: () => `FunctionEntry` \| `unit`; \} |
21+
| `ctx.getAllComponents` | (`node`: `TSESTree.Program`) => [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)\<`string`, [`FunctionComponent`](../../../../interfaces/FunctionComponent.md)\> |
22+
| `ctx.getCurrentEntries` | () => `FunctionEntry`[] |
23+
| `ctx.getCurrentEntry` | () => `FunctionEntry` \| `unit` |
24+
| <a id="listeners"></a> `listeners` | `ESLintUtils.RuleListener` |

‎packages/core/docs/@eslint-react/namespaces/useComponentCollectorLegacy/README.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
[**@eslint-react/core**](../../../README.md)
2-
3-
***
4-
51
[@eslint-react/core](../../../README.md) / useComponentCollectorLegacy
62

73
# useComponentCollectorLegacy
84

95
## Type Aliases
106

11-
- [ReturnType](type-aliases/ReturnType.md)
7+
| Type Alias | Description |
8+
| ------ | ------ |
9+
| [ReturnType](type-aliases/ReturnType.md) | - |

0 commit comments

Comments
 (0)