fix(eslint): flat config support #51

AMorgaut · 2024-08-21T13:09:20Z

Fix issue #50 (ESLint flat config support)

see: https://eslint.org/docs/latest/extend/plugin-migration-flat-config

AMorgaut · 2024-08-21T15:32:11Z

eslint-plugin/lib/standalone.js

-    recommended === false ? "off" : recommended;
-  return map;
-}, {});
+for (let { ruleName, ruleModule } of rulesList) {


Previous implementation did 2 loops

The updated code does it only once

AMorgaut · 2024-08-21T15:33:13Z

eslint-plugin/lib/standalone.js

 };
+
+plugin.configs = {
+  recommended: {


legacy configuration is maintained as-is

no expected regressions

AMorgaut · 2024-08-21T15:34:07Z

eslint-plugin/lib/standalone.js

+    plugins: ["@ecocode"],
+    rules: recommendedRules,
+  },
+  ["flat/recommended"]: {


the new flat configuration follows the plugin naming convention

utarwyn · 2024-10-14T18:36:52Z

eslint-plugin/README.md

+| :------------------------------------------------------------------------------------- | :--------------------------------------------------------- | :---------------------------- |
+| [avoid-brightness-override](docs/rules/avoid-brightness-override.md)                   | Should avoid to override brightness                        | ✅ ![badge-flat/recommended][] |
+| [avoid-css-animations](docs/rules/avoid-css-animations.md)                             | Avoid usage of CSS animations                              | ✅ ![badge-flat/recommended][] |
+| [avoid-high-accuracy-geolocation](docs/rules/avoid-high-accuracy-geolocation.md)       | Avoid using high accuracy geolocation in web applications. | ✅ ![badge-flat/recommended][] |
+| [limit-db-query-results](docs/rules/limit-db-query-results.md)                         | Should limit the number of returns for a SQL query         | ✅ ![badge-flat/recommended][] |
+| [no-empty-image-src-attribute](docs/rules/no-empty-image-src-attribute.md)             | Disallow usage of image with empty source attribute        | ✅ ![badge-flat/recommended][] |
+| [no-import-all-from-library](docs/rules/no-import-all-from-library.md)                 | Should not import all from library                         | ✅ ![badge-flat/recommended][] |
+| [no-multiple-access-dom-element](docs/rules/no-multiple-access-dom-element.md)         | Disallow multiple access of same DOM element.              | ✅ ![badge-flat/recommended][] |
+| [no-multiple-style-changes](docs/rules/no-multiple-style-changes.md)                   | Disallow multiple style changes at once.                   | ✅ ![badge-flat/recommended][] |
+| [no-torch](docs/rules/no-torch.md)                                                     | Should not programmatically enable torch mode              | ✅ ![badge-flat/recommended][] |
+| [prefer-collections-with-pagination](docs/rules/prefer-collections-with-pagination.md) | Prefer API collections with pagination.                    | ✅ ![badge-flat/recommended][] |
+| [prefer-shorthand-css-notations](docs/rules/prefer-shorthand-css-notations.md)         | Encourage usage of shorthand CSS notations                 | ✅ ![badge-flat/recommended][] |
+| [provide-print-css](docs/rules/provide-print-css.md)                                   | Enforce providing a print stylesheet                       | ✅ ![badge-flat/recommended][] |


I don't understand the addition of ![badge-flat/recommended][]?

I didn't edited it myself
These changes were done by calling the yarn run update:eslint-docs command
as mentioned in the CONTRIBUTING documentation
https://github.com/green-code-initiative/ecoCode-javascript/blob/main/CONTRIBUTING.md#generate-rule-documentation

Maybe we need to edit the configuration, because the current result is pretty strange 😞

manually fixed for now

eslint-plugin/README.md

utarwyn · 2024-10-14T18:38:03Z

eslint-plugin/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@ecocode/eslint-plugin",
-  "version": "1.5.0",
+  "version": "1.6.0",


You don't need to edit this yourself 😉

sure I can revert it
I guess it is done by the package release workflow

utarwyn · 2024-10-14T18:39:49Z

eslint-plugin/lib/standalone.js

+const plugin = {
+  meta: {
+    name: "@ecocode/eslint-plugin",
+    version: "1.6.0",


I'm not a big fan of version being hard-coded here.
This makes it necessary to modify the version bump workflow to change this value dynamically.

Agree not fan neither

The ESLint configuration says:

you should add a meta key that contains at least a name key, and ideally, a version key

So version is not mandatory and looking a other plugins, it looks like they don't include it, so we could drop it.

I'll just do some check because it also says:

Without this meta information, your plugin will not be usable with the --cache and --print-config command line options.

Even if the version is not mandatory, I would like to make sure about its impact regarding the cache feature

eslint-plugin/lib/standalone.js

utarwyn · 2024-10-14T18:44:02Z

eslint-plugin/README.md

+]
+```
+
+#### With the legacy `.eslintrc` 


Same wording as ESLint documentation here

Suggested change

#### With the legacy `.eslintrc`

#### With the deprecated eslintrc format

utarwyn · 2024-10-14T18:44:58Z

eslint-plugin/README.md

-### Enable only some rules
+### Enable specific rules
+
+#### With modern `eslint.config.js`


ESLint documentation talks about "flat configurations", so I think we can keep this term to remain consistent.

Suggested change

#### With modern `eslint.config.js`

#### With modern flat configuration

I'm unsure on that one

I think you might be right for new projects from scratch, but for existing projects and projects generated by framework generators (Nx, Angular, preact, Vue, ...) that still generate project with previous eslint configurations (which is what happened to ecocode-dashboard), it it really not obvious, and actually, it took me some time to figure out about the new eslint "flat config". What you first see when you want to add a plugin to your project is the name of your eslint configuration file

I based this part of the documentation on what I saw on another eslint plugin and which looked cristal clear to apply.

Not sure from which plugin I originally took it but the playwright one use both "flat config" and the file name to describe how to add it. It looks to be a good compromise

Flat config (eslint.config.js)
...

Legacy config (.eslintrc)
...

https://github.com/playwright-community/eslint-plugin-playwright/blob/main/README.md

Thank you for the feedback! I think this is a great idea, we can go for it 💯

Co-authored-by: Maxime Malgorn <[email protected]>

AMorgaut added 5 commits August 21, 2024 13:07

fix(eslint): flat config support

dc4b8e0

fix: fix wrong plugin reference

56a9dab

fix: postpone plugin config initialisation to fix reference

97b58c1

chore: prettier fix

b24c6c1

doc: update rules and eslint documentations

d17d6b5

AMorgaut commented Aug 21, 2024

View reviewed changes

AMorgaut mentioned this pull request Aug 23, 2024

Make the ESLint plugin compatible with the last ESLint versions with flat configurations #50

Open

utarwyn requested changes Oct 14, 2024

View reviewed changes

utarwyn assigned AMorgaut Oct 14, 2024

utarwyn added 🚀 enhancement New feature or request 🏗️ refactoring Refactoring for best practices labels Oct 14, 2024

utarwyn linked an issue Oct 14, 2024 that may be closed by this pull request

Make the ESLint plugin compatible with the last ESLint versions with flat configurations #50

Open

AMorgaut and others added 5 commits October 16, 2024 16:42

Update eslint-plugin/README.md

d667571

Co-authored-by: Maxime Malgorn <[email protected]>

Update eslint-plugin/lib/standalone.js

154179c

Co-authored-by: Maxime Malgorn <[email protected]>

fix: revert package version change

230c6e5

Merge branch 'main' into eslint-flat-config

0e1fa6e

doc: update config titles

aa8c858

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint): flat config support #51

fix(eslint): flat config support #51

AMorgaut commented Aug 21, 2024

AMorgaut Aug 21, 2024 •

edited

Loading

AMorgaut Aug 21, 2024 •

edited

Loading

AMorgaut Aug 21, 2024

utarwyn Oct 14, 2024

AMorgaut Oct 16, 2024

utarwyn Oct 17, 2024 •

edited

Loading

AMorgaut Oct 18, 2024

utarwyn Oct 14, 2024

AMorgaut Oct 18, 2024

utarwyn Oct 14, 2024

AMorgaut Oct 18, 2024

utarwyn Oct 14, 2024

utarwyn Oct 14, 2024

AMorgaut Oct 18, 2024

AMorgaut Oct 18, 2024

utarwyn Oct 18, 2024

	#### With the legacy `.eslintrc`
	#### With the deprecated eslintrc format

	#### With modern `eslint.config.js`
	#### With modern flat configuration

fix(eslint): flat config support #51

Are you sure you want to change the base?

fix(eslint): flat config support #51

Conversation

AMorgaut commented Aug 21, 2024

AMorgaut Aug 21, 2024 • edited Loading

Choose a reason for hiding this comment

AMorgaut Aug 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

utarwyn Oct 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AMorgaut Aug 21, 2024 •

edited

Loading

AMorgaut Aug 21, 2024 •

edited

Loading

utarwyn Oct 17, 2024 •

edited

Loading