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

docs: update get-started to the new @eslint/create-config #18217

Merged
merged 3 commits into from Apr 5, 2024

Conversation

aladdin-add
Copy link
Member

@aladdin-add aladdin-add commented Mar 20, 2024

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Update the get-started of the documentation with the upcoming @eslint/create-config.

Is there anything you'd like reviewers to focus on?

it can be merged after eslint/create-config#81 merged and released.

@aladdin-add aladdin-add added documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion labels Mar 20, 2024
@github-actions github-actions bot removed the documentation Relates to ESLint's documentation label Mar 20, 2024
Copy link

netlify bot commented Mar 20, 2024

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 230c0bb
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/660fb4e4a6bb17000857e73a
😎 Deploy Preview https://deploy-preview-18217--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

README.md Outdated
{
"rules": {
"semi": ["error", "always"],
"quotes": ["error", "double"]
Copy link
Member Author

Choose a reason for hiding this comment

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

wondering if we can (at some time) revisit the docs to replace formatting rules with some others. (formatting rules have been deprecated).

Copy link
Member

Choose a reason for hiding this comment

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

@eslint/config will no longer have an option to configure semi, quotes, and other formatting rules?

Perhaps a config like this would be a more representative example:

import pluginJs from "@eslint/js";

export default [
  pluginJs.configs.recommended,
];

Copy link

Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update.

@fasttime
Copy link
Member

Not stale, this change depends on eslint/create-config#81 which isn't merged yet.


# or (`eslint-config` prefix is optional)
npm init @eslint/config -- --config eslint-config-semistandard
npm init @eslint/config -- --config eslint-config-standard

# ⚠️ npm 6.x no extra double-dash:
Copy link
Member

Choose a reason for hiding this comment

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

Similar to eslint/create-config#81, can we also remove npm 6.x specifics from this document?

@nzakas
Copy link
Member

nzakas commented Apr 4, 2024

eslint/create-config#81 has been merged. What do we need to update?

@mdjermanovic
Copy link
Member

friendly ping @aladdin-add, today is the final v9.0.0 release :)

@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Apr 5, 2024
@aladdin-add aladdin-add marked this pull request as ready for review April 5, 2024 08:23
@aladdin-add aladdin-add requested a review from a team as a code owner April 5, 2024 08:23
@github-actions github-actions bot removed the documentation Relates to ESLint's documentation label Apr 5, 2024
@aladdin-add
Copy link
Member Author

It's ready for review now. @mdjermanovic

Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@mdjermanovic mdjermanovic merged commit e151050 into eslint:main Apr 5, 2024
17 checks passed
@aladdin-add aladdin-add deleted the docs/get-started branch April 5, 2024 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

None yet

4 participants