Skip to content

test(eslint-plugin): add docs test for Correct and Incorrect blocks #9239

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 2 commits into from
Jun 5, 2024
Merged

test(eslint-plugin): add docs test for Correct and Incorrect blocks #9239

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a67b22d
test(eslint-plugin): add docs test for Correct and Incorrect blocks
JoshuaKGoldberg Jun 3, 2024
9996d9a
the TODO comment
JoshuaKGoldberg Jun 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
85 changes: 76 additions & 9 deletions packages/eslint-plugin/tests/docs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,40 @@ describe('Validating rule docs', () => {

const rulesWithComplexOptions = new Set(['array-type', 'member-ordering']);

// TODO: whittle this list down to as few as possible
const rulesWithComplexOptionHeadings = new Set([
'ban-ts-comment',
'ban-types',
'consistent-type-exports',
'consistent-type-imports',
'explicit-function-return-type',
'explicit-member-accessibility',
'explicit-module-boundary-types',
'no-base-to-string',
'no-confusing-void-expression',
'no-duplicate-type-constituents',
'no-empty-interface',
'no-explicit-any',
'no-floating-promises',
'no-inferrable-types',
'no-invalid-void-type',
'no-meaningless-void-operator',
'no-misused-promises',
'no-type-alias',
'no-unnecessary-condition',
'no-unnecessary-type-assertion',
'parameter-properties',
'prefer-nullish-coalescing',
'prefer-optional-chain',
'prefer-string-starts-ends-with',
'promise-function-async',
'restrict-template-expressions',
'strict-boolean-expressions',
'switch-exhaustiveness-check',
'switch-exhaustiveness-check',
'unbound-method',
]);

it('All rules must have a corresponding rule doc', () => {
const files = fs
.readdirSync(docsRoot)
Expand Down Expand Up @@ -238,22 +272,55 @@ describe('Validating rule docs', () => {
!rule.meta.docs?.extendsBaseRule &&
rule.meta.type !== 'layout'
) {
test('each rule option should be mentioned in a heading', () => {
const headingTextAfterOptions = headings
.slice(headings.findIndex(header => header.text === 'Options'))
.map(header => header.text)
.join('\n');
describe('rule options', () => {
const headingsAfterOptions = headings.slice(
headings.findIndex(header => header.text === 'Options'),
);

for (const schemaItem of schema) {
if (schemaItem.type === 'object') {
for (const property of Object.keys(
schemaItem.properties as object,
)) {
if (!headingTextAfterOptions.includes(`\`${property}\``)) {
throw new Error(
`At least one header should include \`${property}\`.`,
test(property, () => {
const correspondingHeadingIndex =
headingsAfterOptions.findIndex(heading =>
heading.text.includes(`\`${property}\``),
);

if (correspondingHeadingIndex === -1) {
throw new Error(
`At least one header should include \`${property}\`.`,
);
}

if (rulesWithComplexOptionHeadings.has(ruleName)) {
return;
}

const relevantChildren = tokens.slice(
tokens.indexOf(
headingsAfterOptions[correspondingHeadingIndex],
),
tokens.indexOf(
headingsAfterOptions[correspondingHeadingIndex + 1],
),
);
}

for (const rawTab of [
`<TabItem value="✅ Correct">`,
`<TabItem value="❌ Incorrect">`,
]) {
if (
!relevantChildren.some(
child =>
child.type === 'html' && child.raw.includes(rawTab),
)
) {
throw new Error(`Missing option example tab: ${rawTab}`);
}
}
});
}
}
}
Expand Down
Loading