Merge pull request #123 from acelaya-forks/feature/fix-definitions

Fix rules definitions coming from plugins or shareable configs

Author: acelaya

CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org).
 
+## [3.2.1] - 2024-10-22
+#### Added
+* *Nothing*
+
+#### Changed
+* *Nothing*
+
+#### Deprecated
+* *Nothing*
+
+#### Removed
+* *Nothing*
+
+#### Fixed
+* Fix rules definitions coming from plugins or shareable configs.
+
+
 ## [3.2.0] - 2024-10-12
 #### Added
 * Add support for `eslint-plugin-react-hooks` 5.x.

README.md

@@ -7,13 +7,20 @@
 
 Coding standard used by Shlink JavaScript projects.
 
-This library includes two ESLint configurations, the base one, and the react-specific one. Default export includes both:
+This library includes two ESLint configurations, the base one (which includes eslint and typescript recommended rules), and the react-specific one (which includes JSX accessibility, react and react hooks recommended rules).
+
+Default export includes both:
 
 ```js
 // eslint.config.js
 import shlink from '@shlinkio/eslint-config-js-coding-standard';
 
-export default shlink;
+export default [
+  ...shlink,
+  {
+    // Other rules...
+  }
+];
 ```
 
 If the project does not use React, you can just use the base config:
@@ -22,5 +29,10 @@ If the project does not use React, you can just use the base config:
 // eslint.config.js
 import { baseConfig } from '@shlinkio/eslint-config-js-coding-standard';
 
-export default baseConfig;
+export default [
+  ...baseConfig,
+  {
+    // Other rules...
+  }
+];
 ```

index.js

@@ -7,11 +7,9 @@ import simpleImportSort from 'eslint-plugin-simple-import-sort';
 import tseslint from 'typescript-eslint';
 
 export const baseConfig = tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
   {
-    extends: [
-      eslint.configs.recommended,
-      ...tseslint.configs.recommended,
-    ],
     plugins: {
       '@stylistic': stylistic,
       'simple-import-sort': simpleImportSort,
@@ -73,11 +71,12 @@ export const baseConfig = tseslint.config(
   },
 );
 
-export const reactConfig = tseslint.config(
+export const reactConfig = [
+  react.configs.flat.recommended,
+  react.configs.flat['jsx-runtime'],
+  pluginJsxA11y.flatConfigs.recommended,
   {
     plugins: {
-      'jsx-a11y': pluginJsxA11y,
-      react,
       'react-hooks': eslintPluginReactHooks,
     },
     languageOptions: {
@@ -93,8 +92,8 @@ export const reactConfig = tseslint.config(
       }
     },
     rules: {
-      ...pluginJsxA11y.configs.recommended.rules,
-      ...eslintPluginReactHooks.configs.recommended.rules,
+      'react-hooks/rules-of-hooks': 'error',
+      'react-hooks/exhaustive-deps': 'error',
 
       // Disabled rules from presets
       'react/display-name': ['off', { 'ignoreTranspilerName': false }],
@@ -107,9 +106,9 @@ export const reactConfig = tseslint.config(
       'react/no-children-prop': 'off',
     },
   },
-);
+];
 
-export default tseslint.config(
+export default [
   ...baseConfig,
   ...reactConfig,
-);
+];

indocker

@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 
-docker compose run shlink_js_coding_standard_node /bin/sh -c "cd /home/shlink && $*"
+docker compose run --rm shlink_js_coding_standard_node /bin/sh -c "cd /home/shlink && $*"