Skip to content

[Draft] | Support flat eslint configuration format for nimble packages #2718

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

Closed
gokulprasanth-ni wants to merge 8 commits into from
Closed

[Draft] | Support flat eslint configuration format for nimble packages #2718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d2b0684
update to flat eslint config
gokulprasanth-ni Oct 3, 2025
67e1c8b
update lock file
gokulprasanth-ni Oct 3, 2025
e7d26ba
update lock
gokulprasanth-ni Oct 3, 2025
ad4ebf1
Change files
gokulprasanth-ni Oct 3, 2025
562276a
update config file
gokulprasanth-ni Oct 3, 2025
d9dabab
Merge branch 'main' into users/gokulprasanthRavi/feat/convert-to-esli…
gokulprasanth-ni Oct 4, 2025
7d28363
update code
gokulprasanth-ni Oct 4, 2025
40ba025
revert changes
gokulprasanth-ni Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@ni-jasmine-parameterized-65c24422-e02e-4fad-b5c8-02fd9392e918.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
Copy link
Copy Markdown
Member

@rajsite rajsite Oct 3, 2025

Choose a reason for hiding this comment

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

Moved the PR to draft because like described in this comment lets do the nimble transition after AzDo. We should iterate in AzDo first and we don't have the time to review the change in nimble right now.

Copy link
Copy Markdown
Contributor Author

@gokulprasanth-ni gokulprasanth-ni Oct 3, 2025

Choose a reason for hiding this comment

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

Milan, I want to ensure I understood correctly. Are you suggesting that we update the SLE apps first, followed by the Nimble update? Additionally, in your other comment, you mentioned updating the Azdo pipeline—could you please clarify what specific updates are required there?

Copy link
Copy Markdown
Member

@rajsite rajsite Oct 3, 2025

Choose a reason for hiding this comment

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

Are you suggesting that we update the SLE apps first

yep!

mentioned updating the Azdo pipeline—could you please clarify what specific updates are required there?

sorry wasn't being clear, the SLE apps is what I meant. Not aware of any azdo pipeline changes.

Copy link
Copy Markdown
Member

@rajsite rajsite Oct 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

fyi @gokulprasanth-ni as part of regular dependency updates we pulled in the the stylistic eslint changes (from pre v9) into nimble. We also made some intentional rule tweaks which are now merged in main. Just an fyi when the eslint v9 upgrade is revisited.

Hopefully now there will be far fewer changes in the PRs as the stylistic update was merged separately

Copy link
Copy Markdown
Member

@rajsite rajsite Oct 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The goal of splitting the prettier update to a separate PR was to reduce the number of formatting changes in this PR. The assumption was that prettier is what caused so many changes but there are still over 100 files changed in this PR many with just formatting changes. Does splitting the prettier update into a separate PR actually make a difference?

Copy link
Copy Markdown
Contributor Author

@gokulprasanth-ni gokulprasanth-ni Nov 14, 2025

Choose a reason for hiding this comment

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

@rajsite @jattasNI I tried updating the prettier-eslint and prettier-eslint-cli packages version in the Nimble monorepo to make them compatible with ESLint v9. Following this upgrade, we tried enabling ESLint and Prettier for linting across several packages in the workspace.

Problem:

During this update, they were conflicts between ESLint and Prettier that create a circular fixing problem:

  • ESLint runs first and reports certain formatting/style violations
  • Prettier runs subsequently and reports different or conflicting style issues
  • When we fix the ESLint errors, those changes are flagged as violations by Prettier
  • Conversely, when we fix Prettier issues, ESLint reports new violations
  • This creates an endless loop where fixing one tool's issues breaks the other tool's rules

Proposed Solutions:

We're considering the following approaches to resolve this conflict:

  • Disable ESLint style rules: Turn off all style/formatting-related rules in ESLint (such as indent, quotes, semi, comma-dangle, etc.) and rely exclusively on Prettier for code formatting. This would allow ESLint to focus on code quality and potential bugs while Prettier handles all stylistic concerns.

  • Use eslint-plugin-prettier: Integrate Prettier directly into ESLint by using eslint-plugin-prettier along with eslint-config-prettier. This approach:

    • Runs Prettier as an ESLint rule
    • Automatically disables conflicting ESLint formatting rules via eslint-config-prettier
    • Reports Prettier formatting issues as ESLint errors
    • Provides a single, unified linting experience with no conflicts

But we are still not sure whether these approaches works fine or not. We would like to get your thoughts on this and also any alternate solutions available to fix this issue.

Copy link
Copy Markdown
Member

@rajsite rajsite Nov 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Looking at it again I'm not sure why we call both prettier-eslint and eslint via the cli. I think we can just prettier-eslint which is aware of the eslint configuration already.

Copy link
Copy Markdown
Contributor Author

@gokulprasanth-ni gokulprasanth-ni Nov 28, 2025

Choose a reason for hiding this comment

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

Closing this PR as it will be handled in the below PR

#2768

"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/jasmine-parameterized",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-nimble-angular-18d1b127-e543-4e25-8529-bc5fa3c931ac.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/nimble-angular",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-nimble-components-6a132db3-8604-461f-8c5b-11090d2d2eef.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/nimble-components",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-nimble-react-b2693da0-1f45-41bc-96a4-79d0bebbecdc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/nimble-react",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-nimble-tokens-7ac41db2-b6a8-4938-b810-4ec452cbbf61.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/nimble-tokens",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-ok-angular-2f4b15c3-08ca-4a4f-a752-603d5f2fe6b2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/ok-angular",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-ok-components-07217f13-2df7-4d36-a3b8-ca3442e06671.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/ok-components",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-ok-react-5a17a0f5-60d0-4281-a4db-f359fc6ad458.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/ok-react",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-spright-angular-b576ee05-bfcb-4e70-aebf-90f164024a93.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/spright-angular",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-spright-components-b204ef72-a6e0-4e88-b775-0875d142fa2f.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/spright-components",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-spright-react-a6f41eb1-ba04-4cc4-b540-5881d77a2d33.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/spright-react",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
7 changes: 7 additions & 0 deletions change/@ni-xliff-to-json-converter-ea81ceee-5bd8-4f67-8901-24889622cadf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Upgrade to ESLint v9 and update the configuration to use the flat configuration format",
"packageName": "@ni/xliff-to-json-converter",
"email": "131153319+gokulprasanth-ni@users.noreply.github.com",
"dependentChangeType": "patch"
}
Loading
Loading