@1024pix/eslint-plugin 1.1.3 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [1.2.0](https://github.com/1024pix/eslint-plugin/compare/v1.1.3...v1.2.0) (2024-05-23)
+
+### :rocket: Amélioration
+
+- [#22](https://github.com/1024pix/eslint-plugin/pull/22) Supporter la Flat config ESLint
+
 ## [1.1.3](https://github.com/1024pix/eslint-plugin/compare/v1.1.2...v1.1.3) (2024-05-14)
 
 ### :arrow_up: Montée de version

package/config.js

@@ -0,0 +1,108 @@
+const { resolve } = require('node:path');
+
+const js = require('@eslint/js');
+const { fixupPluginRules } = require('@eslint/compat');
+const comments = require('@eslint-community/eslint-plugin-eslint-comments/configs');
+const eslintPluginYml = require('eslint-plugin-yml');
+const simpleImportSort = require('eslint-plugin-simple-import-sort');
+const i18nJson = require('eslint-plugin-i18n-json');
+const pixPlugin = require('./index.js');
+
+module.exports = [
+  js.configs.recommended,
+  ...eslintPluginYml.configs['flat/standard'],
+  comments.recommended,
+  {
+    plugins: {
+      'i18n-json': fixupPluginRules(i18nJson),
+      '@1024pix': pixPlugin,
+      'simple-import-sort': simpleImportSort,
+    },
+    rules: {
+      'arrow-parens': ['error', 'always'],
+      'comma-dangle': ['error', 'always-multiline'],
+      'computed-property-spacing': ['error', 'never'],
+      'eol-last': ['error'],
+      '@eslint-community/eslint-comments/no-unused-disable': ['error'],
+      indent: [
+        'error',
+        2,
+        {
+          SwitchCase: 1,
+        },
+      ],
+      'keyword-spacing': ['error'],
+      'linebreak-style': ['error', 'unix'],
+      'no-multiple-empty-lines': [
+        'error',
+        {
+          max: 1,
+          maxEOF: 1,
+        },
+      ],
+      'no-restricted-syntax': [
+        'error',
+        {
+          selector:
+            'NewExpression[callee.name=Date][arguments.length=1][arguments.0.type=Literal]:not([arguments.0.value=/^[12][0-9]{3}-(0[0-9]|1[0-2])-([0-2][0-9]|3[01])(T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]Z)?$/])',
+          message: "Use only ISO8601 UTC syntax ('2019-03-12T01:02:03Z') in Date constructor",
+        },
+        {
+          selector:
+            "CallExpression[callee.object.object.name='faker'][callee.object.property.name='internet'][callee.property.name='email']",
+          message: 'Use only faker.internet.exampleEmail()',
+        },
+      ],
+      'no-restricted-globals': [
+        'error',
+        {
+          name: 'fetch',
+          message: "Use import fetch from 'fetch'",
+        },
+      ],
+      'no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '_',
+        },
+      ],
+      'no-var': ['error'],
+      'object-curly-spacing': ['error', 'always'],
+      'prefer-const': ['error'],
+      quotes: ['error', 'single'],
+      semi: ['error', 'always'],
+      'simple-import-sort/imports': 'error',
+      'simple-import-sort/exports': 'error',
+      'space-before-blocks': ['error'],
+      'space-before-function-paren': [
+        'error',
+        {
+          anonymous: 'never',
+          named: 'never',
+          asyncArrow: 'ignore',
+        },
+      ],
+      'space-in-parens': ['error'],
+      'space-infix-ops': ['error'],
+      'func-call-spacing': ['error'],
+      'key-spacing': ['error'],
+      'comma-spacing': ['error'],
+      'no-trailing-spaces': ['error'],
+      'no-multi-spaces': ['error'],
+      'yml/quotes': [
+        'error',
+        {
+          prefer: 'single',
+          avoidEscape: true,
+        },
+      ],
+      'i18n-json/sorted-keys': [
+        'error',
+        {
+          sortFunctionPath: resolve(__dirname, './json/sort-translations.js'),
+        },
+      ],
+      '@1024pix/no-sinon-stub-with-args-oneliner': 'error',
+    },
+  },
+];

package/json/sort-translations.js

@@ -0,0 +1,16 @@
+module.exports = (translations) => {
+  return Object.keys(translations).sort((keyA, keyB) => {
+    if (keyB == 'current-lang' || keyB == 'title') {
+      return 1;
+    } else if (keyA == 'current-lang' || keyA == 'title') {
+      return -1;
+    }
+    if (keyA == keyB) {
+      return 0;
+    } else if (keyA < keyB) {
+      return -1;
+    } else {
+      return 1;
+    }
+  });
+};

package/json/sort-translations.test.js

@@ -0,0 +1,73 @@
+const { describe, it } = require('node:test');
+const { deepStrictEqual } = require('node:assert');
+const sortTranslations = require('./sort-translations.js');
+
+describe('#sortTranslation', () => {
+  it('should sort keys alphabetically', () => {
+    // Given
+    const translations = {
+      d: 'Daniel',
+      a: 'Alpha',
+      c: 'Charly',
+      b: 'Beta',
+    };
+    const expectedResult = ['a', 'b', 'c', 'd'];
+
+    // When
+    const result = sortTranslations(translations);
+
+    // Then
+    deepStrictEqual(result, expectedResult);
+  });
+
+  it('should put the `title` key on top', () => {
+    // Given
+    const translations = {
+      d: 'Daniel',
+      a: 'Alpha',
+      title: 'should be first',
+      c: 'Charly',
+      b: 'Beta',
+    };
+    const expectedResult = ['title', 'a', 'b', 'c', 'd'];
+
+    // When
+    const result = sortTranslations(translations);
+
+    // Then
+    deepStrictEqual(result, expectedResult);
+  });
+
+  it('should put the `current-lang` key on top', () => {
+    // Given
+    const translations = {
+      d: 'Daniel',
+      a: 'Alpha',
+      'current-lang': 'should be first',
+      c: 'Charly',
+      b: 'Beta',
+    };
+    const expectedResult = ['current-lang', 'a', 'b', 'c', 'd'];
+
+    // When
+    const result = sortTranslations(translations);
+
+    // Then
+    deepStrictEqual(result, expectedResult);
+  });
+
+  it('should put the `title` key before the `current-lang` key', () => {
+    // Given
+    const translations = {
+      title: 'should be second',
+      'current-lang': 'should be first',
+    };
+    const expectedResult = ['title', 'current-lang'];
+
+    // When
+    const result = sortTranslations(translations);
+
+    // Then
+    deepStrictEqual(result, expectedResult);
+  });
+});

package/package.json

@@ -1,12 +1,32 @@
 {
   "name": "@1024pix/eslint-plugin",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Des règles de lint pour les projets 1024pix",
-  "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./config": "./config.js"
+  },
   "scripts": {
-    "test": "node rules/*.test.js"
+    "test:plugin": "node rules/*.test.js",
+    "test:config": "node json/*.test.js",
+    "test": "npm run test:plugin && npm run test:config"
+  },
+  "dependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
+    "@eslint/compat": "^1.0.1",
+    "eslint-plugin-i18n-json": "^4.0.0",
+    "eslint-plugin-simple-import-sort": "^12.1.0",
+    "eslint-plugin-yml": "^1.14.0"
   },
   "devDependencies": {
-    "eslint": "^8.50.0"
-  }
+    "eslint": "^8.57.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.56.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/1024pix/eslint-plugin.git"
+  },
+  "homepage": "https://github.com/1024pix/eslint-plugin#readme"
 }

package/readme.md

@@ -6,4 +6,77 @@
 
 ### Install
 
-Use [@1024pix/eslint-config](https://github.com/1024pix/eslint-config/).
+```bash
+npm install --save-dev eslint@^8 @1024pix/eslint-plugin
+```
+
+### Config `eslint.config.cjs`
+
+```cjs
+const pixEslintConfig = require('@1024pix/eslint-plugin/config');
+
+module.exports = pixEslintConfig;
+```
+
+Note that this ESLint config is not ready to use with ESM.
+
+### Add script for package.json
+
+For example:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+### Config VS Code auto fix
+
+Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and create `.vscode/settings.json`
+
+```json
+{
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true,
+    "source.organizeImports": false
+  }
+}
+```
+
+## FAQ
+
+### I prefer XXX...
+
+Sure, you can override the rules in your `eslint.config.js` file.
+
+```cjs
+const pixEslintConfig = require('@1024pix/eslint-plugin/config');
+
+module.exports = [
+  ...eslintConfig,
+  {
+    rules: {
+      // your rules...
+    },
+  },
+];
+```
+
+Or you can always fork this repo and make your own.
+
+## Migration guide
+
+### v1.2.0
+
+Before v1.2.0, Pix Config was provided by the [@1024pix/eslint-config](https://github.com/1024pix/eslint-config) project.
+
+After upgrading, you should migrate from the old `.eslintrc` files to the new `eslint.config.cjs` file format.
+
+Take a look at the [official ESLint migration guide](https://eslint.org/docs/latest/use/configure/migration-guide). You can also take inspiration from [this Pix context example](https://github.com/1024pix/pix/pull/8995).
+
+Once finished, `@1024pix/eslint-config` can safely be removed.