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

remove lint-readme #60

Merged
merged 1 commit into from
Dec 13, 2023
Merged

remove lint-readme #60

merged 1 commit into from
Dec 13, 2023

Conversation

davidchambers
Copy link
Member

Linting readmes involves significant complexity.

First, it requires four dependencies:

  • eslint-plugin-markdown
  • remark-cli
  • remark-lint-no-undefined-references
  • remark-lint-no-unused-definitions

Secondly, lint-readme itself is complex, especially the rewrite function that relies on heuristics to append semicolons.

Finally, each project that depends on sanctuary-scripts needs to configure ESLint appropriately, which can be messy.

The juice is not worth the squeeze.

@davidchambers davidchambers merged commit afbc6a2 into main Dec 13, 2023
3 checks passed
@davidchambers davidchambers deleted the davidchambers/no-lint-readme branch December 13, 2023 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants