Skip to content

chore(website): make filters properly handle rules with recommended=object #8849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 9, 2024
Merged

chore(website): make filters properly handle rules with recommended=object #8849

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4566bfb
handle recommended=object
abrahamguo Apr 4, 2024
3462e78
lint
abrahamguo Apr 4, 2024
ff38c47
Merge branch 'main' of github.com:abrahamguo/typescript-eslint into w…
abrahamguo Apr 4, 2024
b567a9f
Merge branch 'main' of github.com:abrahamguo/typescript-eslint into w…
abrahamguo Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions packages/website/src/components/RulesTable/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import Link from '@docusaurus/Link';
import { useHistory } from '@docusaurus/router';
import type { RulesMeta } from '@site/rulesMeta';
import { useRulesMeta } from '@site/src/hooks/useRulesMeta';
import type { RuleRecommendation } from '@typescript-eslint/utils/ts-eslint';
import clsx from 'clsx';
import React, { useMemo } from 'react';

Expand Down Expand Up @@ -31,6 +32,13 @@ function interpolateCode(
return fragments.map((v, i) => (i % 2 === 0 ? v : <code key={i}>{v}</code>));
}

function getActualRecommended({
docs,
}: RulesMeta[number]): RuleRecommendation | undefined {
const recommended = docs?.recommended;
return typeof recommended === 'object' ? 'recommended' : recommended;
}

function RuleRow({
rule,
}: {
Expand All @@ -40,9 +48,8 @@ function RuleRow({
return null;
}
const { fixable, hasSuggestions, type, deprecated } = rule;
const { recommended, requiresTypeChecking, extendsBaseRule } = rule.docs;
const actualRecommended =
typeof recommended === 'object' ? 'recommended' : recommended;
const { requiresTypeChecking, extendsBaseRule } = rule.docs;
const actualRecommended = getActualRecommended(rule);
const formatting = type === 'layout';
return (
<tr>
Expand Down Expand Up @@ -171,14 +178,15 @@ export default function RulesTable(): React.JSX.Element {
const relevantRules = useMemo(
() =>
rules.filter(r => {
const actualRecommended = getActualRecommended(r);
const opinions = [
match(filters.recommended, r.docs?.recommended === 'recommended'),
match(filters.recommended, actualRecommended === 'recommended'),
match(
filters.strict,
r.docs?.recommended === 'recommended' ||
r.docs?.recommended === 'strict',
actualRecommended === 'recommended' ||
actualRecommended === 'strict',
),
match(filters.stylistic, r.docs?.recommended === 'stylistic'),
match(filters.stylistic, actualRecommended === 'stylistic'),
match(filters.fixable, !!r.fixable),
match(filters.suggestions, !!r.hasSuggestions),
match(filters.typeInformation, !!r.docs?.requiresTypeChecking),
Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy