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.

Sign up for GitHub

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

Jump to bottom

docs(linter): add recipe for flat config converter #18614

Merged
merged 4 commits into from
Aug 22, 2023
Merged

docs(linter): add recipe for flat config converter #18614

merged 4 commits into from
Aug 22, 2023

Conversation

meeroslav
Copy link
Contributor

@meeroslav meeroslav commented Aug 14, 2023 •
edited
Loading

Do not merge this before #18534

Current Behavior

Expected Behavior

Related Issue(s)

Fixes #

@meeroslav meeroslav self-assigned this Aug 14, 2023
@meeroslav meeroslav requested review from a team as code owners August 14, 2023 13:29
@nx-cloud
Copy link

nx-cloud bot commented Aug 14, 2023 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 5bd026c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 8 targets

Sent with 💌 from NxCloud.

@vercel
Copy link

vercel bot commented Aug 14, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2023 8:40pm

@meeroslav meeroslav added scope: docs Issues related to generic docs scope: linter Issues related to Eslint support in Nx labels Aug 16, 2023
JamesHenry
JamesHenry reviewed Aug 21, 2023
View reviewed changes
docs/map.json Outdated Show resolved Hide resolved
JamesHenry
JamesHenry requested changes Aug 21, 2023
View reviewed changes
Copy link
Collaborator

@JamesHenry JamesHenry left a comment

Choose a reason for hiding this comment

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

Left some suggestions

isaacplmann
isaacplmann requested changes Aug 21, 2023
View reviewed changes
Copy link
Collaborator

@isaacplmann isaacplmann left a comment

Choose a reason for hiding this comment

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

Reading through this recipe I don't know what the new flat config file is going to look like or how to use it. I don't think you need to fully explain the file (that's what the ESLint documentation is for), but I do think showing a small example file would be helpful.

docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
@meeroslav meeroslav force-pushed the add-flat-config-recipe branch from 2b4c192 to 109c2eb Compare August 21, 2023 18:37
isaacplmann
isaacplmann requested changes Aug 21, 2023
View reviewed changes
Copy link
Collaborator

@isaacplmann isaacplmann left a comment

Choose a reason for hiding this comment

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

I like having the code examples side by side. It makes it a lot clearer what is happening.

Made a few suggestions

docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md Outdated Show resolved Hide resolved
@meeroslav meeroslav requested a review from isaacplmann August 21, 2023 20:36
@meeroslav meeroslav merged commit 8f6f71e into nrwl:master Aug 22, 2023
@meeroslav meeroslav deleted the add-flat-config-recipe branch August 22, 2023 23:37
@github-actions
Copy link

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@JamesHenry JamesHenry JamesHenry approved these changes

@isaacplmann isaacplmann isaacplmann approved these changes

@FrozenPandaz FrozenPandaz Awaiting requested review from FrozenPandaz FrozenPandaz was automatically assigned from nrwl/nx-linter-reviewers

@bcabanes bcabanes Awaiting requested review from bcabanes bcabanes is a code owner automatically assigned from nrwl/nx-docs-reviewers

@jaysoo jaysoo Awaiting requested review from jaysoo jaysoo is a code owner

@AgentEnder AgentEnder Awaiting requested review from AgentEnder AgentEnder is a code owner

Assignees

@meeroslav meeroslav

Labels
scope: docs Issues related to generic docs scope: linter Issues related to Eslint support in Nx
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@meeroslav @isaacplmann @JamesHenry