Skip to content

Commit 098fc34

Browse files
Enable test for "## Examples" in rule docs (#2760)
Co-authored-by: Sindre Sorhus <[email protected]>
1 parent a546444 commit 098fc34

File tree

1 file changed

+3
-17
lines changed

1 file changed

+3
-17
lines changed

test/package.js

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,6 @@ const deprecatedRules = Object.entries(eslintPluginUnicorn.rules)
2626
const RULES_WITHOUT_EXAMPLES_SECTION = new Set([
2727
// Doesn't show code samples since it's just focused on filenames.
2828
'filename-case',
29-
30-
// Intended to not use `Examples` section in this rule.
31-
'prefer-modern-math-apis',
32-
'prefer-math-min-max',
33-
'consistent-existence-index-check',
34-
'prefer-class-fields',
35-
'prefer-global-this',
36-
'no-instanceof-builtins',
37-
'no-named-default',
38-
'consistent-assert',
39-
'no-accessor-recursion',
40-
'consistent-date-clone',
4129
]);
4230

4331
test('Every rule is defined in index file in alphabetical order', t => {
@@ -139,13 +127,11 @@ test('Every rule has a doc with the appropriate content', t => {
139127
continue;
140128
}
141129

142-
/// const documentPath = path.join('docs/rules', `${ruleName}.md`);
143-
/// const documentContents = fs.readFileSync(documentPath, 'utf8');
130+
const documentPath = path.join('docs/rules', `${ruleName}.md`);
131+
const documentContents = fs.readFileSync(documentPath, 'utf8');
144132

145-
// TODO: Disabled until https://github.com/sindresorhus/eslint-plugin-unicorn/issues/2530 is done.
146133
// Check for examples.
147-
// t.true(documentContents.includes('## Examples'), `${ruleName} includes '## Examples' examples section`);
148-
t.pass();
134+
t.true(documentContents.includes('## Examples'), `${ruleName} includes '## Examples' examples section`);
149135
}
150136
});
151137

0 commit comments

Comments
 (0)