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

Replace textual guidelines with ESLint rules where possible #6

Closed
fregante opened this issue Mar 16, 2019 · 3 comments
Closed

Replace textual guidelines with ESLint rules where possible #6

fregante opened this issue Mar 16, 2019 · 3 comments
Labels
help wanted Extra attention is needed

Comments

@fregante
Copy link

fregante commented Mar 16, 2019

Instead of a 590-words styleguide it could be shorter and the rest can be enforced by eslint, where automation is possible, like:

@sindresorhus sindresorhus changed the title Replace textual guidelines with eslint rules where possible Replace textual guidelines with ESLint rules where possible Mar 18, 2019
@sindresorhus
Copy link
Owner

sindresorhus commented Mar 18, 2019

This has always been the goal. I just needed something immediate as automation will take time.

This is mostly blocked by xojs/xo#373. The intention is for XO to lint ambient files (index.d.ts) by default.

I'm also holding out for typescript-eslint to be more mature. I don't want to have to disable rules in hundreds of modules because of typescript-eslint bugs. It's also missing a lot of needed rules.

@sindresorhus
Copy link
Owner

If anyone wants to help out. Find things in the style guide that can be automated, check if typescript-eslint has a rule for it, if yes, comment it here, if not, open a rule request on typescript-eslint and comment the issue link here.

@sindresorhus sindresorhus added the help wanted Extra attention is needed label Mar 18, 2019
@fregante
Copy link
Author

I noticed Airbnb actually still has the verbal styleguide in addition to the shareable config. Not something I'd personally read, but perhaps some people do.

@fregante fregante closed this as not planned Won't fix, can't repro, duplicate, stale Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants