Skip to content

Commit e8dbbee

Browse files
committed
docs: remove experimental additional components and update documentation
1 parent 4e7720d commit e8dbbee

File tree

5 files changed

+2
-139
lines changed

5 files changed

+2
-139
lines changed

apps/website/content/docs/configuration/configure-analyzer.mdx

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -56,38 +56,6 @@ Example with `polymorphicPropName` set to `as`:
5656
// Evaluated as an h3 element
5757
```
5858

59-
### `additionalComponents` (Experimental)
60-
61-
<Callout type="info">
62-
Consider using `polymorphicPropName` instead when possible, as it's simpler
63-
and more efficient.
64-
</Callout>
65-
66-
<Callout type="warn">
67-
Experimental feature that may lack stability and documentation.
68-
</Callout>
69-
70-
Maps components and their attributes for comprehensive analysis. Supports default attribute values.
71-
72-
Example configuration:
73-
74-
```json
75-
[
76-
{
77-
"name": "EmbedContent",
78-
"as": "iframe",
79-
"attributes": [
80-
{
81-
"name": "sandbox",
82-
"defaultValue": ""
83-
}
84-
]
85-
}
86-
]
87-
```
88-
89-
This makes `<EmbedContent src="https://eslint-react.xyz" />{:tsx}` evaluate as `<iframe src="https://eslint-react.xyz" sandbox="" />{:tsx}`.
90-
9159
### `additionalHooks` (Experimental)
9260

9361
<Callout type="warn">
@@ -127,20 +95,6 @@ export default [
12795
useEffect: ["useIsomorphicLayoutEffect"],
12896
useLayoutEffect: ["useIsomorphicLayoutEffect"],
12997
},
130-
131-
// (Experimental) Configure mapping for custom components and their attributes for more comprehensive analysis
132-
additionalComponents: [
133-
{
134-
name: "Link",
135-
as: "a",
136-
attributes: [{ name: "to", as: "href" }],
137-
},
138-
{
139-
name: "EmbedContent",
140-
as: "iframe",
141-
attributes: [{ name: "sandbox", defaultValue: "" }],
142-
},
143-
],
14498
},
14599
},
146100
},

apps/website/content/docs/configuration/configure-analyzer.tsx

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -38,27 +38,6 @@ const properties = {
3838
/>
3939
),
4040
},
41-
additionalComponents: {
42-
type: "CustomComponent[]",
43-
description: <Link href="#additionalcomponents">An array of components and its attributes mapping ⤵</Link>,
44-
default: "[]",
45-
typeDescription: (
46-
<CodeBlock
47-
code={dedent`
48-
type CustomComponent = {
49-
name: string;
50-
as?: string;
51-
attributes?: {
52-
name: string;
53-
as?: string;
54-
defaultValue?: string;
55-
}[]
56-
}
57-
`}
58-
lang="ts"
59-
/>
60-
),
61-
},
6241
polymorphicPropName: {
6342
type: "string",
6443
description: <Link href="#polymorphicpropname">The prop your code uses to create polymorphic components ⤵</Link>,

apps/website/content/docs/configuration/configure-enhanced-additional-components.mdx

Lines changed: 0 additions & 69 deletions
This file was deleted.

apps/website/content/docs/configuration/meta.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
"!configure-language-preference",
66
"configure-project-config",
77
"!---Advanced Configuration---",
8-
"!enhanced-additional-components",
98
"!using-custom-parsers"
109
]
1110
}

packages/plugins/eslint-plugin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@ export default defineConfig([
167167

168168
Contributions are welcome!
169169

170-
Please follow our [contributing guidelines](https://github.com/Rel1cx/eslint-react/tree/refactor/jsx-attribute-resolution/.github/CONTRIBUTING.md).
170+
Please follow our [contributing guidelines](https://github.com/Rel1cx/eslint-react/tree/rework/jsx-attribute-resolution/.github/CONTRIBUTING.md).
171171

172172
## License
173173

174-
This project is licensed under the MIT License - see the [LICENSE](https://github.com/Rel1cx/eslint-react/tree/refactor/jsx-attribute-resolution/LICENSE) file for details.
174+
This project is licensed under the MIT License - see the [LICENSE](https://github.com/Rel1cx/eslint-react/tree/rework/jsx-attribute-resolution/LICENSE) file for details.

0 commit comments

Comments
 (0)