@w5s/eslint-config 2.0.3 → 2.0.5

package/dist/rules/es/import.js

@@ -19,7 +19,7 @@ const config = dev_1.ESLintConfig.concat(imports_1.default,
             // mjs: 'never',
             },
         ],
-        'import/no-deprecated': 'off',
+        'import/no-deprecated': 'off', // Performance issues
         'import/no-extraneous-dependencies': [
             'error',
             {
@@ -33,9 +33,9 @@ const config = dev_1.ESLintConfig.concat(imports_1.default,
                 ],
             },
         ],
-        'import/no-named-as-default': 'off',
-        'import/no-unused-modules': 'off',
-        'import/prefer-default-export': 'off',
+        'import/no-named-as-default': 'off', // Performance issues
+        'import/no-unused-modules': 'off', // Performance issues
+        'import/prefer-default-export': 'off', // Not aligned, default export does not bring sufficient semantic
         'import/unambiguous': dev_1.ESLintConfig.fixme('off'), // Disable because proposal still in progress
     },
     settings: {

package/dist/rules/es/jsdoc.js

@@ -3,13 +3,13 @@ const config = {
     extends: ['plugin:jsdoc/recommended'],
     plugins: ['jsdoc'],
     rules: {
-        'jsdoc/no-undefined-types': 'off',
+        'jsdoc/no-undefined-types': 'off', // https://github.com/gajus/eslint-plugin-jsdoc/issues/839
         'jsdoc/require-hyphen-before-param-description': ['warn', 'always'],
         'jsdoc/require-jsdoc': 'off',
         'jsdoc/require-param-description': 'off',
         'jsdoc/require-returns': 'off',
         'jsdoc/tag-lines': ['warn', 'any', { startLines: 1 }],
-        'jsdoc/valid-types': 'off',
+        'jsdoc/valid-types': 'off', // FIXME: reports lots of false positive
         strict: ['error', 'safe'],
     },
     settings: {

package/dist/rules/es/promise.js

@@ -4,7 +4,7 @@ const config = dev_1.ESLintConfig.concat({
     extends: ['plugin:promise/recommended'],
     plugins: ['promise'],
     rules: {
-        'promise/prefer-await-to-callbacks': dev_1.ESLintConfig.fixme('error'),
+        'promise/prefer-await-to-callbacks': dev_1.ESLintConfig.fixme('error'), // https://github.com/xjamundx/eslint-plugin-promise/issues/212
         'promise/prefer-await-to-then': 'error',
     },
 });

package/dist/rules/es/unicorn.js

@@ -16,16 +16,16 @@ const config = dev_1.ESLintConfig.concat(recommended_js_1.default, {
         'unicorn/error-message': 'error',
         'unicorn/explicit-length-check': ['error', { 'non-zero': 'greater-than' }],
         'unicorn/filename-case': 'off',
-        'unicorn/import-index': 'off',
-        'unicorn/new-for-builtins': 'off',
+        'unicorn/import-index': 'off', // Not playing well with ES Module
+        'unicorn/new-for-builtins': 'off', // error, @see https://github.com/sindresorhus/eslint-plugin-unicorn/issues/122
         'unicorn/no-abusive-eslint-disable': 'error',
         'unicorn/no-array-instanceof': 'error',
         'unicorn/no-console-spaces': 'off',
-        'unicorn/no-fn-reference-in-iterator': 'off',
+        'unicorn/no-fn-reference-in-iterator': 'off', // error ?
         'unicorn/no-for-loop': 'error',
         'unicorn/no-hex-escape': 'error',
         'unicorn/no-new-buffer': 'error',
-        'unicorn/no-null': 'off',
+        'unicorn/no-null': 'off', // https://github.com/sindresorhus/eslint-plugin-unicorn/issues/612
         'unicorn/no-process-exit': 'off',
         'unicorn/no-unreadable-array-destructuring': 'off',
         'unicorn/no-unsafe-regex': 'error',
@@ -60,11 +60,11 @@ const config = dev_1.ESLintConfig.concat(recommended_js_1.default, {
     ],
     rules: {
         'unicorn/consistent-destructuring': 'off',
-        'unicorn/consistent-function-scoping': 'off',
-        'unicorn/no-array-callback-reference': 'off',
-        'unicorn/no-array-for-each': 'off',
-        'unicorn/no-array-method-this-argument': 'off',
-        'unicorn/no-array-reduce': 'off',
+        'unicorn/consistent-function-scoping': 'off', // Too many false positive
+        'unicorn/no-array-callback-reference': 'off', // Many false positive reported
+        'unicorn/no-array-for-each': 'off', // This rule could change browser compatibility
+        'unicorn/no-array-method-this-argument': 'off', // Many false positive reported
+        'unicorn/no-array-reduce': 'off', // Array#reduce can be used
         'unicorn/no-object-as-default-parameter': 'off',
         'unicorn/prefer-default-parameters': 'off',
         'unicorn/prevent-abbreviations': 'off', // This rule is so dangerous : it potentially break code while fixing in many cases !!

package/dist/rules/ignore.js

@@ -19,6 +19,7 @@ const getGitignore = (prefix = '') => {
 const config = {
     ignorePatterns: [
         '!.*',
+        '.docusaurus',
         '.yarn',
         '.common/',
         '.config/package-lock.json',
@@ -41,7 +42,7 @@ const config = {
         '**/vendors/**',
         '*.min.*',
         '*.toml',
-        '*.timestamp-*.mjs',
+        '*.timestamp-*.mjs', // esbuild/vite temporary files
         ...getGitignore(),
         ...getGitignore('android'),
         ...getGitignore('ios'),

package/dist/rules/jest.js

@@ -11,7 +11,7 @@ const config = dev_1.ESLintConfig.concat({
     plugins: ['jest'],
     rules: {
         'jest/consistent-test-it': 'error',
-        'jest/expect-expect': 'off',
+        'jest/expect-expect': 'off', // Disabled because it does not handle functions that does the expect
         'jest/no-alias-methods': 'error',
         'jest/prefer-spy-on': 'error',
         'jest/prefer-to-contain': 'error',
@@ -44,7 +44,7 @@ const config = dev_1.ESLintConfig.concat({
  */
 {
     rules: {
-        '@typescript-eslint/dot-notation': dev_1.ESLintConfig.fixme(undefined),
+        '@typescript-eslint/dot-notation': dev_1.ESLintConfig.fixme(undefined), // eslint-plugin-jest seems to break this rule
         '@typescript-eslint/naming-convention': 'off',
         '@typescript-eslint/no-non-null-assertion': 'off',
         '@typescript-eslint/no-unsafe-assignment': 'off',

package/dist/rules/jsonc.js

@@ -41,8 +41,8 @@ const config = {
                             'license',
                             'qna',
                             'author',
-                            'maintainers',
-                            'contributors',
+                            'maintainers', // Key order (per item): name, email, url
+                            'contributors', // Key order (per item): name, email, url
                             'publisher',
                             'sideEffects',
                             'type',
@@ -67,16 +67,16 @@ const config = {
                             'assets',
                             'bin',
                             'man',
-                            'directories',
-                            'files',
+                            'directories', // Key order: lib, bin, man, doc, example, test
+                            'files', // Unique items
                             'workspaces',
-                            'binary',
-                            'scripts',
-                            'betterScripts',
+                            'binary', //	Key order: module_name, module_path, remote_path, package_name, host
+                            'scripts', // Script sort
+                            'betterScripts', // Script sort
                             'contributes',
-                            'activationEvents',
-                            'husky',
-                            'simple-git-hooks',
+                            'activationEvents', // Unique items
+                            'husky', //	Sorts the hooks field using git hook sort
+                            'simple-git-hooks', // Key sort using git hook sort
                             'pre-commit',
                             'commitlint',
                             'lint-staged',
@@ -86,10 +86,10 @@ const config = {
                             'babel',
                             'browserslist',
                             'xo',
-                            'prettier',
-                            'eslintConfig',
+                            'prettier', // Prettier sort
+                            'eslintConfig', // ESLint sort
                             'eslintIgnore',
-                            'npmpackagejsonlint',
+                            'npmpackagejsonlint', // Key sort (also recognizes: npmPackageJsonLintConfig, npmpkgjsonlint)
                             'release',
                             'remarkConfig',
                             'stylelint',
@@ -101,9 +101,9 @@ const config = {
                             'resolutions',
                             'dependencies',
                             'devDependencies',
-                            'dependenciesMeta',
+                            'dependenciesMeta', //	Key sort (deep)
                             'peerDependencies',
-                            'peerDependenciesMeta',
+                            'peerDependenciesMeta', //	Key sort (deep)
                             'optionalDependencies',
                             'bundledDependencies',
                             'bundleDependencies',
@@ -113,14 +113,14 @@ const config = {
                             'packageManager',
                             'engines',
                             'engineStrict',
-                            'volta',
+                            'volta', //	Key order: node, npm, yarn
                             'languageName',
                             'os',
                             'cpu',
                             'preferGlobal',
                             'publishConfig',
                             'icon',
-                            'badges',
+                            'badges', //	Key order (per item): description, url, href
                             'galleryBanner',
                             'preview',
                             'markdown',

package/dist/rules/typescript.js

@@ -89,7 +89,7 @@ const config = dev_1.ESLintConfig.concat(
         '@typescript-eslint/no-dupe-class-members': baseRules['no-dupe-class-members'],
         '@typescript-eslint/no-empty-function': baseRules['no-empty-function'],
         '@typescript-eslint/no-empty-interface': ['error', { allowSingleExtends: true }],
-        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-explicit-any': 'off', // if any is explicit then it's wanted
         '@typescript-eslint/no-extra-parens': baseRules['no-extra-parens'],
         '@typescript-eslint/no-extra-semi': baseRules['no-extra-semi'],
         '@typescript-eslint/no-inferrable-types': 'error',
@@ -97,7 +97,7 @@ const config = dev_1.ESLintConfig.concat(
         '@typescript-eslint/no-loss-of-precision': baseRules['no-loss-of-precision'],
         '@typescript-eslint/no-magic-numbers': baseRules['no-magic-numbers'],
         '@typescript-eslint/no-misused-new': 'error',
-        '@typescript-eslint/no-namespace': 'off',
+        '@typescript-eslint/no-namespace': 'off', // We don't agree with community, namespaces are great and not deprecated
         '@typescript-eslint/no-non-null-assertion': 'error',
         '@typescript-eslint/no-redeclare': dev_1.ESLintConfig.fixme(baseRules['no-redeclare']),
         '@typescript-eslint/no-require-imports': 'error',
@@ -192,7 +192,7 @@ const config = dev_1.ESLintConfig.concat(
         'func-call-spacing': 'off',
         'getter-return': 'off',
         'import/default': duplicateTSC,
-        'import/export': dev_1.ESLintConfig.fixme('error'),
+        'import/export': dev_1.ESLintConfig.fixme('error'), // https://github.com/benmosher/eslint-plugin-import/issues/1964
         'import/named': duplicateTSC,
         'import/namespace': duplicateTSC,
         'import/no-named-as-default-member': duplicateTSC,
@@ -211,7 +211,7 @@ const config = dev_1.ESLintConfig.concat(
         'no-func-assign': 'off',
         'no-implied-eval': 'off',
         'no-import-assign': 'off',
-        'no-inner-declarations': dev_1.ESLintConfig.fixme('error'),
+        'no-inner-declarations': dev_1.ESLintConfig.fixme('error'), // https://github.com/typescript-eslint/typescript-eslint/issues/239
         'no-loop-func': 'off',
         'no-loss-of-precision': 'off',
         'no-magic-numbers': 'off',

package/dist/rules/yml.js

@@ -1,6 +1,20 @@
 "use strict";
+const dev_1 = require("@w5s/dev");
+const yamlExtensions = dev_1.Project.queryExtensions(['yaml']);
 const config = {
     extends: ['plugin:yml/standard', 'plugin:yml/prettier'],
+    overrides: [
+        {
+            files: [
+                ...yamlExtensions.map((ext) => `docker-compose*${ext}`),
+                ...yamlExtensions.map((ext) => `compose-*${ext}`),
+                ...yamlExtensions.map((ext) => `compose${ext}`),
+            ],
+            rules: {
+                'yml/no-empty-mapping-value': 'off',
+            },
+        },
+    ],
     parser: 'yaml-eslint-parser',
     plugins: ['yml'],
 };

package/dist/yml.js

@@ -2,12 +2,17 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+const dev_1 = require("@w5s/dev");
 const yml_js_1 = __importDefault(require("./rules/yml.js"));
 const config = {
     overrides: [
         {
             ...yml_js_1.default,
-            files: ['*.yml', '*.yaml'],
+            files: [
+                dev_1.Project.extensionsToGlob(
+                // ts only extensions
+                dev_1.Project.queryExtensions(['yaml'])),
+            ],
         },
     ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w5s/eslint-config",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "description": "ESLint configuration presets",
   "keywords": [
     "eslint",
@@ -35,8 +35,8 @@
     "@rushstack/eslint-patch": "^1.1.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
-    "@w5s/dev": "^2.0.3",
-    "@w5s/prettier-config": "^2.0.1",
+    "@w5s/dev": "^2.0.5",
+    "@w5s/prettier-config": "^2.0.2",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.25.0",
@@ -45,7 +45,7 @@
     "eslint-plugin-jsonc": "^2.4.0",
     "eslint-plugin-prettier": "^5.0.0-alpha.0",
     "eslint-plugin-promise": "^6.0.0",
-    "eslint-plugin-unicorn": "^48.0.0",
+    "eslint-plugin-unicorn": "^49.0.0",
     "eslint-plugin-yml": "^1.1.0",
     "find-up": "^5.0.0",
     "parse-gitignore": "^2.0.0"
@@ -69,5 +69,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "214e0244a63211d31c96ad0d43fd5b9d080beb67"
+  "gitHead": "2bd0a857bdad976886f91a11ab9b2928c59095be"
 }

package/src/rules/ignore.ts

@@ -18,6 +18,7 @@ const getGitignore = (prefix = '') => {
 const config: eslint.Linter.Config = {
   ignorePatterns: [
     '!.*',
+    '.docusaurus',
     '.yarn',
     '.common/',
     '.config/package-lock.json',

package/src/rules/yml.ts

@@ -1,7 +1,21 @@
+import { Project } from '@w5s/dev';
 import type eslint from 'eslint';
 
+const yamlExtensions = Project.queryExtensions(['yaml']);
 const config: eslint.Linter.Config = {
   extends: ['plugin:yml/standard', 'plugin:yml/prettier'],
+  overrides: [
+    {
+      files: [
+        ...yamlExtensions.map((ext) => `docker-compose*${ext}`),
+        ...yamlExtensions.map((ext) => `compose-*${ext}`),
+        ...yamlExtensions.map((ext) => `compose${ext}`),
+      ],
+      rules: {
+        'yml/no-empty-mapping-value': 'off',
+      },
+    },
+  ],
   parser: 'yaml-eslint-parser',
   plugins: ['yml'],
 };

package/src/yml.ts

@@ -1,11 +1,17 @@
 import type eslint from 'eslint';
+import { Project } from '@w5s/dev';
 import ymlConfig from './rules/yml.js';
 
 const config: eslint.Linter.Config = {
   overrides: [
     {
       ...ymlConfig,
-      files: ['*.yml', '*.yaml'],
+      files: [
+        Project.extensionsToGlob(
+          // ts only extensions
+          Project.queryExtensions(['yaml'])
+        ),
+      ],
     },
   ],
 };