eslint-config-radiofrance - npm Package Compare versions

Comparing version 4.0.0 to 5.0.0

index.js

@@ -1,21 +0,82 @@
-'use strict';
+const eslintConfigXoTypescript = require('eslint-config-xo-typescript');
 
+const ruleBanTypeOverride = eslintConfigXoTypescript.rules['@typescript-eslint/ban-types'];
+delete ruleBanTypeOverride[1].types.null;
+
+const ruleNamingConventionOverride = eslintConfigXoTypescript.rules['@typescript-eslint/naming-convention'];
+ruleNamingConventionOverride[1].format = [
+  'strictCamelCase',
+  'snake_case',
+];
+
 module.exports = {
-  plugins: ['promise'],
-  extends: ['xo', 'plugin:promise/recommended'],
-  rules: {
-    indent: [2, 2, {SwitchCase: 1}],
-    'capitalized-comments': 'off',
-    camelcase: 'warn',
-    'no-console': 'error',
-    'no-unused-vars': [
-      'error',
-      {
-        argsIgnorePattern: 'next'
-      }
-    ],
-    'prefer-promise-reject-errors': 'warn',
-
-    'promise/no-return-wrap': 'off'
-  }
+  overrides: [
+    {
+      files: ['package.json'],
+      plugins: ['package-json'],
+      extends: ['plugin:package-json/recommended'],
+      parser: 'jsonc-eslint-parser',
+    },
+    {
+      files: ['*.{js,ts}'],
+      plugins: ['import'],
+      rules: {
+        // Console should not be used in project. Instead use our internal logger.
+        'no-console': 'error',
+        // For each require/import, we should a explicit file extension.
+        'import/extensions': [
+          'error',
+          'ignorePackages',
+        ],
+        // No duplicate in import
+        'import/no-duplicates': 'error',
+        // Order import by alphabet and groups ('builtin', 'external', 'internal', etc)
+        'import/order': [
+          'error',
+          {
+            alphabetize: {
+              order: 'asc',
+            },
+          },
+        ],
+      },
+    },
+    {
+      files: ['*.js'],
+      plugins: ['promise'],
+      extends: ['xo', 'plugin:promise/recommended'],
+      rules: {
+        // Use space indent instead of tab.
+        indent: [2, 2, {SwitchCase: 1}],
+        // Avoid error on legacy but keep warning.
+        camelcase: 'warn',
+        'prefer-promise-reject-errors': 'warn',
+        'promise/no-return-wrap': 'warn',
+        // Disable because sometimes we need to comment some code.
+        'capitalized-comments': 'off',
+        // Expressjs have a unused params "next" in middleware.
+        'no-unused-vars': [
+          'error',
+          {
+            argsIgnorePattern: 'next',
+          },
+        ],
+      },
+    },
+    {
+      files: ['*.ts'],
+      plugins: ['promise'],
+      extends: ['xo', 'xo-typescript/space', 'plugin:promise/recommended'],
+      rules: {
+        // Disable because sometimes we need to comment some code.
+        'capitalized-comments': 'off',
+        // Override naming convention rule to allow `snake_case`.
+        '@typescript-eslint/naming-convention': ruleNamingConventionOverride,
+        // Override this rule to allow usage of null and undefined.
+        '@typescript-eslint/ban-types': ruleBanTypeOverride,
+        // Disable this rule because we need interface and type.
+        '@typescript-eslint/consistent-type-definitions': 'off',
+      },
+    },
+  ],
 };

package.json

 {
   "name": "eslint-config-radiofrance",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "ESLint shareable config for Radio France",
@@ -10,6 +10,6 @@ "license": "CECILL-B",
     "email": "[e-mail]",
-    "url": "www.radiofrance.fr"
+    "url": "https://www.radiofrance.fr"
   },
   "engines": {
-    "node": ">=8"
+    "node": ">=18"
   },
@@ -51,35 +51,27 @@ "scripts": {
   "dependencies": {
-    "eslint-config-xo": "^0.43.1",
-    "eslint-plugin-promise": "^6.0.0"
+    "@typescript-eslint/parser": "^7.0.2",
+    "eslint-config-xo": "^0.44.0",
+    "eslint-config-xo-typescript": "^3.0.0",
+    "jsonc-eslint-parser": "^2.4.0"
   },
   "devDependencies": {
-    "ava": "^3.7.1",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "ava": "^6.1.2",
     "eslint": "^8.52.0",
-    "is-plain-obj": "^3.0.0"
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-package-json": "^0.10.4",
+    "eslint-plugin-promise": "^6.1.1",
+    "typescript": "^5.3.3"
   },
   "peerDependencies": {
-    "eslint": ">=8.0.0"
+    "@typescript-eslint/eslint-plugin": ">=7.0.2",
+    "eslint": ">=8.0.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-package-json": "^0.10.4",
+    "eslint-plugin-promise": "^6.1.1",
+    "typescript": ">=5.0.0"
   },
   "eslintConfig": {
-    "extends": "xo/esnext",
-    "rules": {
-      "indent": [
-        2,
-        2,
-        {
-          "SwitchCase": 1
-        }
-      ],
-      "capitalized-comments": "off",
-      "camelcase": "warn",
-      "no-console": "error",
-      "no-unused-vars": [
-        "error",
-        {
-          "argsIgnorePattern": "next"
-        }
-      ],
-      "prefer-promise-reject-errors": "warn"
-    }
+    "extends": "./index.js"
   }
 }

README.md

@@ -1,4 +0,4 @@
-# eslint-config-radiofrance [![Build Status](https://travis-ci.org/radiofrance/eslint-config-radiofrance.svg?branch=master)](https://travis-ci.org/radiofrance/eslint-config-radiofrance)
+# eslint-config-radiofrance
 
-> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) extend from [eslint-config-xo](https://github.com/sindresorhus/eslint-config-xo)
+> ESLint [shareable config](https://eslint.org/docs/latest/extend/shareable-configs.html) extend from [eslint-config-xo](https://github.com/xojs/eslint-config-xo) and [eslint-config-xo-typescript](https://github.com/xojs/eslint-config-xo-typescript)
 
@@ -26,3 +26,4 @@ ## Install
 
-- [eslint-config-xo](https://github.com/sindresorhus/eslint-config-xo) - ESLint shareable config for XO
+- [eslint-config-xo](https://github.com/xojs/eslint-config-xo) - ESLint shareable config for XO
+- [eslint-config-xo-typescript](https://github.com/xojs/eslint-config-xo-typescript) - ESLint shareable config for TypeScript to be used with eslint-config-xo
 
@@ -29,0 +30,0 @@ ## License

No alert changes

Improved metrics

Total package byte prevSize

26497

increased by9.97%

Lines of code

79

increased by315.79%

Number of lines in readme file

32

increased by3.23%

Worsened metrics

Dependency count

10

increased by233.33%

Dev dependency count

7

increased by133.33%

Dependency changes

• + Added@typescript-eslint/parser@^7.0.2

• + Addedeslint-config-xo-typescript@^3.0.0

• + Addedjsonc-eslint-parser@^2.4.0

• + Added@eslint/eslintrc@2.1.4(transitive)

• + Added@eslint/js@8.57.0(transitive)

• + Added@humanwhocodes/config-array@0.11.14(transitive)

• + Added@humanwhocodes/object-schema@2.0.3(transitive)

• + Added@types/glob@7.2.0(transitive)

• + Added@types/json5@0.0.29(transitive)

• + Added@types/minimatch@5.1.2(transitive)

• + Added@types/node@20.14.2(transitive)

• + Added@typescript-eslint/eslint-plugin@7.13.0(transitive)

• + Added@typescript-eslint/parser@7.13.0(transitive)

• + Added@typescript-eslint/scope-manager@7.13.0(transitive)

• + Added@typescript-eslint/type-utils@7.13.0(transitive)

• + Added@typescript-eslint/types@7.13.0(transitive)

• + Added@typescript-eslint/typescript-estree@7.13.0(transitive)

• + Added@typescript-eslint/utils@7.13.0(transitive)

• + Added@typescript-eslint/visitor-keys@7.13.0(transitive)

• + Added@ungap/structured-clone@1.2.0(transitive)

• + Addedarray-buffer-byte-length@1.0.1(transitive)

• + Addedarray-includes@3.1.8(transitive)

• + Addedarray-union@2.1.0(transitive)

• + Addedarray.prototype.findlastindex@1.2.5(transitive)

• + Addedarray.prototype.flat@1.3.2(transitive)

• + Addedarray.prototype.flatmap@1.3.2(transitive)

• + Addedarraybuffer.prototype.slice@1.0.3(transitive)

• + Addedavailable-typed-arrays@1.0.7(transitive)

• + Addedbrace-expansion@2.0.1(transitive)

• + Addedbraces@3.0.3(transitive)

• + Addedcall-bind@1.0.7(transitive)

• + Addeddata-view-buffer@1.0.1(transitive)

• + Addeddata-view-byte-length@1.0.1(transitive)

• + Addeddata-view-byte-offset@1.0.0(transitive)

• + Addeddebug@3.2.7(transitive)

• + Addeddefine-data-property@1.1.4(transitive)

• + Addeddefine-properties@1.2.1(transitive)

• + Addeddetect-indent@6.1.0(transitive)

• + Addeddetect-newline@3.1.0(transitive)

• + Addeddir-glob@3.0.1(transitive)

• + Addeddoctrine@2.1.03.0.0(transitive)

• + Addedes-abstract@1.23.3(transitive)

• + Addedes-define-property@1.0.0(transitive)

• + Addedes-errors@1.3.0(transitive)

• + Addedes-object-atoms@1.0.0(transitive)

• + Addedes-set-tostringtag@2.0.3(transitive)

• + Addedes-shim-unscopables@1.0.2(transitive)

• + Addedes-to-primitive@1.2.1(transitive)

• + Addedeslint@8.57.0(transitive)

• + Addedeslint-config-xo@0.44.0(transitive)

• + Addedeslint-config-xo-typescript@3.0.0(transitive)

• + Addedeslint-import-resolver-node@0.3.9(transitive)

• + Addedeslint-module-utils@2.8.1(transitive)

• + Addedeslint-plugin-import@2.29.1(transitive)

• + Addedeslint-plugin-package-json@0.10.4(transitive)

• + Addedeslint-scope@7.2.2(transitive)

• + Addedespree@9.6.1(transitive)

• + Addedfast-glob@3.3.2(transitive)

• + Addedfile-entry-cache@6.0.1(transitive)

• + Addedfill-range@7.1.1(transitive)

• + Addedflat-cache@3.2.0(transitive)

• + Addedfor-each@0.3.3(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedfunction.prototype.name@1.1.6(transitive)

• + Addedfunctions-have-names@1.2.3(transitive)

• + Addedget-intrinsic@1.2.4(transitive)

• + Addedget-symbol-description@1.0.2(transitive)

• + Addedgit-hooks-list@1.0.3(transitive)

• + Addedglob@7.2.3(transitive)

• + Addedglob-parent@5.1.2(transitive)

• + Addedglobals@13.24.0(transitive)

• + Addedglobalthis@1.0.4(transitive)

• + Addedglobby@10.0.011.1.0(transitive)

• + Addedgopd@1.0.1(transitive)

• + Addedgraphemer@1.4.0(transitive)

• + Addedhas-bigints@1.0.2(transitive)

• + Addedhas-property-descriptors@1.0.2(transitive)

• + Addedhas-proto@1.0.3(transitive)

• + Addedhas-symbols@1.0.3(transitive)

• + Addedhas-tostringtag@1.0.2(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedinternal-slot@1.0.7(transitive)

• + Addedis-array-buffer@3.0.4(transitive)

• + Addedis-bigint@1.0.4(transitive)

• + Addedis-boolean-object@1.1.2(transitive)

• + Addedis-callable@1.2.7(transitive)

• + Addedis-core-module@2.13.1(transitive)

• + Addedis-data-view@1.0.1(transitive)

• + Addedis-date-object@1.0.5(transitive)

• + Addedis-negative-zero@2.0.3(transitive)

• + Addedis-number@7.0.0(transitive)

• + Addedis-number-object@1.0.7(transitive)

• + Addedis-plain-obj@2.1.0(transitive)

• + Addedis-regex@1.1.4(transitive)

• + Addedis-shared-array-buffer@1.0.3(transitive)

• + Addedis-string@1.0.7(transitive)

• + Addedis-symbol@1.0.4(transitive)

• + Addedis-typed-array@1.1.13(transitive)

• + Addedis-weakref@1.0.2(transitive)

• + Addedisarray@2.0.5(transitive)

• + Addedjson5@1.0.2(transitive)

• + Addedjsonc-eslint-parser@2.4.0(transitive)

• + Addedmerge2@1.4.1(transitive)

• + Addedmicromatch@4.0.7(transitive)

• + Addedminimatch@9.0.4(transitive)

• + Addedminimist@0.0.101.2.8(transitive)

• + Addedobject-inspect@1.13.1(transitive)

• + Addedobject-keys@1.1.1(transitive)

• + Addedobject.assign@4.1.5(transitive)

• + Addedobject.fromentries@2.0.8(transitive)

• + Addedobject.groupby@1.0.3(transitive)

• + Addedobject.values@1.2.0(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedoptimist@0.6.1(transitive)

• + Addedpackage-json-validator@0.6.4(transitive)

• + Addedpath-is-absolute@1.0.1(transitive)

• + Addedpath-parse@1.0.7(transitive)

• + Addedpath-type@4.0.0(transitive)

• + Addedpicomatch@2.3.1(transitive)

• + Addedpossible-typed-array-names@1.0.0(transitive)

• + Addedregexp.prototype.flags@1.5.2(transitive)

• + Addedresolve@1.22.8(transitive)

• + Addedrimraf@3.0.2(transitive)

• + Addedsafe-array-concat@1.1.2(transitive)

• + Addedsafe-regex-test@1.0.3(transitive)

• + Addedsemver@6.3.17.6.2(transitive)

• + Addedset-function-length@1.2.2(transitive)

• + Addedset-function-name@2.0.2(transitive)

• + Addedside-channel@1.0.6(transitive)

• + Addedslash@3.0.0(transitive)

• + Addedsort-object-keys@1.1.3(transitive)

• + Addedsort-package-json@1.57.0(transitive)

• + Addedstring.prototype.trim@1.2.9(transitive)

• + Addedstring.prototype.trimend@1.0.8(transitive)

• + Addedstring.prototype.trimstart@1.0.8(transitive)

• + Addedstrip-bom@3.0.0(transitive)

• + Addedsupports-preserve-symlinks-flag@1.0.0(transitive)

• + Addedto-regex-range@5.0.1(transitive)

• + Addedts-api-utils@1.3.0(transitive)

• + Addedtsconfig-paths@3.15.0(transitive)

• + Addedtype-fest@0.20.2(transitive)

• + Addedtyped-array-buffer@1.0.2(transitive)

• + Addedtyped-array-byte-length@1.0.1(transitive)

• + Addedtyped-array-byte-offset@1.0.2(transitive)

• + Addedtyped-array-length@1.0.6(transitive)

• + Addedtypescript@5.4.5(transitive)

• + Addedunbox-primitive@1.0.2(transitive)

• + Addedundici-types@5.26.5(transitive)

• + Addedvalidate-npm-package-name@5.0.1(transitive)

• + Addedwhich-boxed-primitive@1.0.2(transitive)

• + Addedwhich-typed-array@1.1.15(transitive)

• + Addedwordwrap@0.0.3(transitive)

• + Addedwrappy@1.0.2(transitive)

• - Removedeslint-plugin-promise@^6.0.0

• - Removedeslint-config-xo@0.43.1(transitive)

• Updatedeslint-config-xo@^0.44.0