Skip to content

Commit 05617d2

Browse files
authored
docs: return-await doc page should say the rule is in the strict-type-checked ruleset, not recommended (typescript-eslint#10428)
fix: condition for determining 'recommended'
1 parent b5af06e commit 05617d2

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

packages/website/src/theme/MDXComponents/RuleAttributes.tsx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
import type { ESLintPluginDocs } from '@typescript-eslint/eslint-plugin/use-at-your-own-risk/rules';
2+
import type {
3+
RuleRecommendation,
4+
RuleRecommendationAcrossConfigs,
5+
} from '@typescript-eslint/utils/ts-eslint';
26

37
import Link from '@docusaurus/Link';
48
import { useRulesMeta } from '@site/src/hooks/useRulesMeta';
@@ -34,11 +38,19 @@ const isRecommendedDocs = (
3438
docs: ESLintPluginDocs,
3539
): docs is RecommendedRuleMetaDataDocs => !!docs.recommended;
3640

41+
const resolveRecommendation = (
42+
recommended: RuleRecommendationAcrossConfigs<unknown[]>,
43+
): RuleRecommendation => {
44+
return recommended.recommended === true ? 'recommended' : 'strict';
45+
};
46+
3747
const getRecommendation = (docs: RecommendedRuleMetaDataDocs): string[] => {
3848
const recommended = docs.recommended;
3949
const recommendation =
4050
recommendations[
41-
typeof recommended === 'object' ? 'recommended' : recommended
51+
typeof recommended === 'object'
52+
? resolveRecommendation(recommended)
53+
: recommended
4254
];
4355

4456
return docs.requiresTypeChecking

0 commit comments

Comments
 (0)