diff --git a/docs/lint/ts/rules/themed-component-classes.md b/docs/lint/ts/rules/themed-component-classes.md index 571e3f170b..1f4ec72801 100644 --- a/docs/lint/ts/rules/themed-component-classes.md +++ b/docs/lint/ts/rules/themed-component-classes.md @@ -3,6 +3,10 @@ _______ Formatting rules for themeable component classes +- All themeable components must be standalone. +- The base component must always be imported in the `ThemedComponent` wrapper. This ensures that it is always sufficient to import just the wrapper whenever we use the component. + + _______ [Source code](../../../../lint/src/rules/ts/themed-component-classes.ts) diff --git a/lint/src/rules/ts/themed-component-classes.ts b/lint/src/rules/ts/themed-component-classes.ts index b5bac962cf..66c37395b4 100644 --- a/lint/src/rules/ts/themed-component-classes.ts +++ b/lint/src/rules/ts/themed-component-classes.ts @@ -37,7 +37,11 @@ export const info = { name: 'themed-component-classes', meta: { docs: { - description: `Formatting rules for themeable component classes`, + description: `Formatting rules for themeable component classes + +- All themeable components must be standalone. +- The base component must always be imported in the \`ThemedComponent\` wrapper. This ensures that it is always sufficient to import just the wrapper whenever we use the component. + `, }, type: 'problem', fixable: 'code',