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.

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

Add basic tests of rule docs #1573

Merged
merged 5 commits into from
Nov 4, 2021
Merged

Conversation

bmish
Copy link
Contributor

@bmish bmish commented Nov 2, 2021

  1. Ensure rule doc title matches rule description (prevents these titles from becoming out-of-date).
  2. Ensure rules with options have an ## Options section and rules without options don't.
  3. Ensure rules with options have their named options mentioned in their rule doc.

test/package.mjs Outdated
}

return newString;
}
Copy link
Collaborator

@fisker fisker Nov 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you apply the same logic to this?

Maybe we can add another property here.

if (data.fixableType === 'No') {
data.fixableType = false;
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated.

@bmish
Copy link
Contributor Author

bmish commented Nov 4, 2021

I'll be submitting another improvement after this is merged :)

@sindresorhus sindresorhus merged commit 5625dab into sindresorhus:main Nov 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants