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 Style Guide Canonical #75

Closed
KristjanESPERANTO opened this issue Oct 17, 2023 · 8 comments · Fixed by #82 or #70
Closed

Add Style Guide Canonical #75

KristjanESPERANTO opened this issue Oct 17, 2023 · 8 comments · Fixed by #82 or #70

Comments

@KristjanESPERANTO
Copy link

I recommend including Canonical as a style guide and considering removing Google as it is no longer being developed. Here's a good comparison of the style guides: https://github.com/gajus/eslint-config-canonical/blob/main/COMPARISON_TABLE.md#table-of-comparison

Style Guide Last publish Rules
Canonical 3 days ago 1020
Airbnb 2 years ago 446
Standard 5 month ago 160
Google 4 years ago (GitHub repository has been archived) 65
XO a year ago 204
@nzakas
Copy link
Member

nzakas commented Oct 27, 2023

I think in general we'll be removing all style guides as ESLint is getting out of the formatting business.

@eslint/eslint-team thoughts?

@fasttime
Copy link
Member

fasttime commented Nov 20, 2023

All style guides contain both formatting and non-formatting rules, I'm only not sure if we want to keep maintaining a list of external configs.

@KristjanESPERANTO
Copy link
Author

As a user, I find it very convenient to be able to simply select a style guide at this point. That's why I would find it a loss if this was no longer possible.

@nzakas
Copy link
Member

nzakas commented Nov 20, 2023

@mdjermanovic thoughts on this?

@mdjermanovic
Copy link
Member

I think it's generally fine that we keep style guides because style is not just formatting (there are many non-formatting stylistic rules in the core and plugins). We might just want to revisit the wording and flow of prompts, but that seems like a separate issue.

As for this particular request:

  • I agree with removing Google as it's unmaintained.
  • The option is "Use a popular style guide", so Canonical with 8K weekly downloads doesn't seem to qualify for inclusion in the list at this point. You can install any shareable config using the --config option (npm init @eslint/config -- --config canonical).

Copy link
Contributor

Oops! It looks like we lost track of this issue. What do we want to do here? This issue will auto-close in 7 days without an update.

@github-actions github-actions bot added the Stale label Jan 22, 2024
@KristjanESPERANTO
Copy link
Author

So maybe instead of Canonical ESLint Stylistic?

@nzakas
Copy link
Member

nzakas commented Jan 23, 2024

ESLint Stylistic isn't a style guide, it's a plugin, so it doesn't make sense to add here.

nzakas added a commit that referenced this issue Jan 23, 2024
aladdin-add pushed a commit that referenced this issue Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants