Skip to content
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

Jump to bottom

Add test for rule jsdoc type comment #1612

Merged
merged 3 commits into from Nov 17, 2021
Merged

Add test for rule jsdoc type comment #1612

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2179743
test: add test for rule jsdoc type comment
bmish Nov 16, 2021
69b0960
add return type to rule helper
bmish Nov 17, 2021
564d73f
Revert "add return type to rule helper"
bmish Nov 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions test/package.mjs
View file
Open in desktop
Expand Up @@ -187,6 +187,16 @@ test('Every deprecated rules listed in docs/deprecated-rules.md', async t => {
}
});

test('Every rule file has the appropriate contents', t => {
for (const ruleFile of ruleFiles) {
const ruleName = path.basename(ruleFile, '.js');
const rulePath = path.join('rules', `${ruleName}.js`);
const ruleContents = fs.readFileSync(rulePath, 'utf8');

t.true(ruleContents.includes('/** @type {import(\'eslint\').Rule.RuleModule} */'), `${ruleName} includes jsdoc comment for rule type`);
}
});

test('Every rule has a doc with the appropriate content', t => {
for (const ruleFile of ruleFiles) {
const ruleName = path.basename(ruleFile, '.js');
Expand Down