Update eslint configuration to use new flat config instead of rushstack #12198 #13440
Conversation
Build Artifacts
|
|
Why has the file been renamed to an mjs file? This is causing issues for non-ESM compliant code in the codebase, so if there's not a compelling reason to do this rename, it might be easier to keep it as a .js file. |
eslint.config.js
Outdated
| import { modernModuleResolution } from '@rushstack/eslint-patch/modern-module-resolution'; | ||
| import kolibriConfig from 'kolibri-format/eslint.config.mjs'; | ||
|
|
||
| modernModuleResolution(); |
There was a problem hiding this comment.
Is this still necessary? We had originally introduced rushstack so as not to update to the flat config just yet, so I was hoping that switching would remove this dependency.
There was a problem hiding this comment.
Yeah this is not needed.
| @@ -1,5 +1,6 @@ | |||
| { | |||
There was a problem hiding this comment.
I can't comment on the file directly, as it is too large, but you should not commit the package-lock.json.
There was a problem hiding this comment.
Yeah maybe due to some bug or error it got commited
eslint.config.js
Outdated
| @@ -0,0 +1,8 @@ | |||
| import { modernModuleResolution } from '@rushstack/eslint-patch/modern-module-resolution'; | |||
| import kolibriConfig from 'kolibri-format/eslint.config.mjs'; | |||
There was a problem hiding this comment.
I don't see a file called eslint.config.mjs in the kolibri-format package any more, so I suspect this may not be working?
There was a problem hiding this comment.
Yeah i changed it.
| @@ -1,5 +1,6 @@ | |||
| { | |||
| "name": "kolibri-root", | |||
| "type": "module", | |||
There was a problem hiding this comment.
Is this update still needed if we have no .mjs files in the package?
There was a problem hiding this comment.
We need to keep "type": "module" because we're using ESM syntax (e.g., import/export) in .js files. Since we're renaming the config to eslint.config.js and it's written using ESM, this setting is required for Node to interpret it correctly.
| @@ -0,0 +1,368 @@ | |||
| import js from '@eslint/js'; | |||
There was a problem hiding this comment.
I assume the rename is a convention change for the flat config?
| try { | ||
| esLintConfig = require(`${hostProjectDir}/.eslintrc`); |
There was a problem hiding this comment.
Did using a dynamic import() statement in place of the require not work here?
Summary
I have upgraded the old ESLint configuration to the new Flat Config format. The configuration file has been renamed to eslint.config.mjs, and the loading logic in index.js has been updated accordingly. I removed the extends property and replaced overrides with individual entries in the config array, as required by the Flat Config format. The setup has been tested using npx eslint . --debug to ensure it works correctly.
References
Issue #12198