eslint-config-simplesense 3.2.0 → 4.0.1

package/README.md

@@ -1,4 +1,4 @@
-# SimpleSense ESLint Config
+# Simplesense ESLint Config
 
 [![GitHub Pages](https://img.shields.io/static/v1?label=GitHub&message=Pages&color=informational&style=flat-square&logo=github)](https://simplesenseio.github.io/eslint-config-simplesense/)
 [![Build](https://github.com/simplesenseio/eslint-config-simplesense/actions/workflows/build.yaml/badge.svg?branch=main&style=flat-square)](https://github.com/simplesenseio/eslint-config-simplesense/actions/workflows/build.yaml)
@@ -21,8 +21,8 @@ Adding plugins is fairly straightforward.
 
 **Step 1**
 
-- To simply use a recommended configuration, add the plugin as a dependency and add the recommendation to the `extends` array in [`index.js`](./index.js).
-- To configure custom rules for a plugin, add a new file, [`plugins/<plugin-name>.js`](./plugins/), and export the rules object. Then add a `require` statement to [`index.js`](./index.js) in the `plugins` object. You can also add a recommended config to the `extends` array.
+- To simply use a recommended configuration, add the plugin as a dependency and add config to the [config](./config/) directory that imports the recommended rules and the plugin itself. Then add the config to the exported array in [`index.js`](./index.js).
+- To configure custom rules for a plugin, add a new file, [`rules/<plugin-name>.js`](./rules/), and export the rules object. Then add the config by following the details in the previous step, however, use the custom rules by themselves or with the exported recommended rules of the plugin.
 - If the new plugin lints a new file type, add a `index.<filetype>` file to the [`filetypes`](./filetypes/) directory and update the `lint:eslint` script in [`package.json`](./package.json) to include the new extension.
 
 **Step 2**

package/config/array-func.js

@@ -0,0 +1,11 @@
+(() => {
+  'use strict';
+
+  module.exports = {
+    name: 'simplesense/array-func',
+    plugins: {
+      'array-func': require('eslint-plugin-array-func'),
+    },
+    rules: require('../rules/array-func'),
+  };
+})();

package/config/eslint-comments.js

@@ -0,0 +1,13 @@
+(() => {
+  'use strict';
+
+  const plugin = require('@eslint-community/eslint-plugin-eslint-comments');
+
+  module.exports = {
+    name: 'simplesense/eslint-comments',
+    plugins: {
+      '@eslint-community/eslint-comments': plugin,
+    },
+    rules: plugin.configs.recommended.rules,
+  };
+})();

package/config/eslint.js

@@ -0,0 +1,15 @@
+(() => {
+  'use strict';
+
+  const {
+    configs,
+  } = require('@eslint/js');
+
+  module.exports = {
+    name: 'simplesense/eslint',
+    rules: {
+      ...configs.recommended.rules,
+      ...require('../rules/eslint-recommended'),
+    },
+  };
+})();

package/config/import.js

@@ -0,0 +1,11 @@
+(() => {
+  'use strict';
+
+  module.exports = {
+    name: 'simplesense/import',
+    plugins: {
+      import: require('eslint-plugin-import'),
+    },
+    rules: require('../rules/import'),
+  };
+})();

package/config/no-use-extend-native.js

@@ -0,0 +1,13 @@
+(() => {
+  'use strict';
+
+  const plugin = require('eslint-plugin-no-use-extend-native');
+
+  module.exports = {
+    name: 'simplesense/no-use-extend-native',
+    plugins: {
+      'no-use-extend-native': plugin,
+    },
+    rules: plugin.configs.recommended.rules,
+  };
+})();

package/config/node.js

@@ -0,0 +1,11 @@
+(() => {
+  'use strict';
+
+  module.exports = {
+    name: 'simplesense/node',
+    plugins: {
+      n: require('eslint-plugin-n'),
+    },
+    rules: require('../rules/node'),
+  };
+})();

package/config/optimize-regex.js

@@ -0,0 +1,13 @@
+(() => {
+  'use strict';
+
+  const plugin = require('eslint-plugin-optimize-regex');
+
+  module.exports = {
+    name: 'simplesense/optimize-regex',
+    plugins: {
+      'optimize-regex': plugin,
+    },
+    rules: plugin.configs.recommended.rules,
+  };
+})();

package/config/regexp.js

@@ -0,0 +1,13 @@
+(() => {
+  'use strict';
+
+  const {
+    configs,
+  } = require('eslint-plugin-regexp');
+
+  const config = {
+    ...configs['flat/recommended'],
+  };
+
+  module.exports = config;
+})();

package/config/security.js

@@ -0,0 +1,11 @@
+(() => {
+  'use strict';
+
+  module.exports = {
+    name: 'simplesense/security',
+    plugins: {
+      security: require('eslint-plugin-security'),
+    },
+    rules: require('../rules/security'),
+  };
+})();

package/config/sonarjs.js

@@ -0,0 +1,16 @@
+(() => {
+  'use strict';
+
+  const plugin = require('eslint-plugin-sonarjs');
+
+  module.exports = {
+    name: 'simplesense/sonarjs',
+    plugins: {
+      sonarjs: plugin,
+    },
+    rules: {
+      ...plugin.configs.recommended.rules,
+      ...require('../rules/sonarjs'),
+    },
+  };
+})();

package/config/unicorn.js

@@ -0,0 +1,11 @@
+(() => {
+  'use strict';
+
+  module.exports = {
+    name: 'simplesense/unicorn',
+    plugins: {
+      unicorn: require('eslint-plugin-unicorn'),
+    },
+    rules: require('../rules/unicorn'),
+  };
+})();

package/config/vue.js

@@ -0,0 +1,17 @@
+(() => {
+  'use strict';
+
+  const plugin = require('eslint-plugin-vue');
+
+  module.exports = [
+    ...plugin.configs['flat/vue2-strongly-recommended'],
+    {
+      name: 'simplesense/vue',
+      files: [ '*.vue', '**/*.vue' ],
+      plugins: {
+        vue: plugin,
+      },
+      rules: require('../rules/vue'),
+    },
+  ];
+})();

package/config/yaml.js

@@ -0,0 +1,17 @@
+(() => {
+  'use strict';
+
+  const plugin = require('eslint-plugin-yml');
+
+  module.exports = [
+    ...plugin.configs['flat/standard'],
+    {
+      name: 'simplesense/yaml',
+      files: [ '*.yaml', '**/*.yaml', '*.yml', '**/*.yml' ],
+      plugins: {
+        yaml: plugin,
+      },
+      rules: require('../rules/yaml'),
+    },
+  ];
+})();

package/index.js

@@ -1,111 +1,56 @@
 (() => {
   'use strict';
 
-  const EXTENDS = {
-    'eslint:recommended': require('./plugins/eslint-recommended'),
-  };
+  const globals = require('globals');
 
-  const PLUGINS = {
-    'array-func': require('./plugins/array-func'),
-    import: require('./plugins/import'),
-    node: require('./plugins/node'),
-    security: require('./plugins/security'),
-    sonarjs: require('./plugins/sonarjs'),
-    unicorn: require('./plugins/unicorn'),
-  };
+  // remove this and the core-js dependency
+  // when we drop support for node 16
+  if (!('structuredClone' in globalThis)) {
+    // eslint-disable-next-line import/no-unassigned-import
+    require('core-js/actual');
+  }
 
-  module.exports = {
-    extends: [
-      ...Object.keys(EXTENDS),
-      'plugin:eslint-comments/recommended',
-      'plugin:no-use-extend-native/recommended',
-      'plugin:optimize-regex/recommended',
-      'plugin:regexp/recommended',
-      'plugin:sonarjs/recommended',
-    ],
-    plugins: [
-      ...Object.keys(PLUGINS),
-      'optimize-regex',
-      'eslint-comments',
-      'no-use-extend-native',
-      'regexp',
-    ],
-    env: {
-      browser: true,
-      es2021: true,
-      es6: true,
-      jest: true,
-      node: true,
-    },
-    parserOptions: {
-      ecmaVersion: 2022,
-    },
-    ignorePatterns: [
-      '!.*',
-      '.cache/',
-      '.git/',
-      '.github/actions/',
-      '.npm/',
-      '.nyc_output/',
-      'coverage/',
-      'lib-cov/',
-      'node_modules/',
-      '**/*.min.*',
-    ],
-    rules: [
-      ...Object.values(EXTENDS),
-      ...Object.values(PLUGINS),
-    ].reduce((object, value) => Object.assign(object, value), {}),
-    overrides: [
-      {
-        files: ['*.vue'],
-        extends: [
-          'plugin:vue/recommended',
-          'plugin:vue/strongly-recommended',
-          'plugin:vue/essential',
-        ],
-        plugins: ['vue'],
-        rules: {
-          'unicorn/filename-case': [
-            'error', {
-              case: 'pascalCase',
-            },
-          ],
-          'vue/component-name-in-template-casing': [ 'error', 'kebab-case' ],
-          'vue/component-definition-name-casing': [ 'error', 'kebab-case' ],
-          'vue/singleline-html-element-content-newline': 'off',
-        },
-      }, {
-        files: [ '*.yml', '*.yaml' ],
-        extends: ['plugin:yml/standard'],
-        plugins: ['yml'],
-        rules: {
-          'yml/block-sequence': [ 'error', 'always' ],
-          'yml/file-extension': [
-            'error',
-            {
-              extension: 'yaml',
-              caseSensitive: true,
-            },
-          ],
-          'yml/indent': [
-            'error',
-            2,
-            {
-              indentBlockSequences: true,
-            },
-          ],
-          'yml/no-empty-document': ['off'],
-          'yml/quotes': [
-            'error', {
-              prefer: 'single',
-            },
-          ],
+  module.exports = [
+    require('./config/eslint'),
+    require('./config/array-func'),
+    require('./config/eslint-comments'),
+    require('./config/import'),
+    require('./config/no-use-extend-native'),
+    require('./config/node'),
+    require('./config/optimize-regex'),
+    require('./config/regexp'),
+    require('./config/security'),
+    require('./config/sonarjs'),
+    require('./config/unicorn'),
+    ...require('./config/vue'), // exports an array
+    ...require('./config/yaml'), // exports an array
+    {
+      languageOptions: {
+        sourceType: 'commonjs',
+        globals: {
+          ...globals.browser,
+          ...globals.es2021,
+          ...globals.es6,
+          ...globals.jest,
+          ...globals.node,
+          spyFn: true,
         },
       },
-    ],
-    globals: {
-      spyFn: true,
     },
-  };
+    {
+      // it's a bit confusing, but this needs to be in a config all by itself
+      // https://github.com/eslint/eslint/issues/17400
+      ignores: [
+        '!.*',
+        '.cache/',
+        '.git/',
+        '.github/actions/',
+        '.npm/',
+        'coverage/',
+        'lib-cov/',
+        'node_modules/',
+        '**/*.min.*',
+      ],
+    },
+  ];
 })();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-config-simplesense",
-  "version": "3.2.0",
-  "description": "ESLint Config for SimpleSense Styles",
+  "version": "4.0.1",
+  "description": "ESLint Config for Simplesense Styles",
   "keywords": [
     "eslint",
     "config",
@@ -20,26 +20,31 @@
   "main": "index.js",
   "files": [
     "index.js",
-    "plugins/**/*"
+    "config/**/*",
+    "rules/**/*"
   ],
   "scripts": {
-    "docs": "npm run docs:clean && npm run docs:generate && npm run docs:build && npm run docs:mv && npm run docs:nojekyll",
-    "docs:build": "vuepress build docs",
-    "docs:clean": "rm -rf docs/.vuepress/dist ./dist",
-    "docs:dev": "npm run docs:clean && npm run docs:generate && vuepress dev docs",
+    "configs:build": "node scripts/generate-configs.js",
+    "docs": "npm run docs:clean && npm run docs:generate && npm run vitepress:sidebar && npm run docs:build && npm run docs:mv && npm run docs:nojekyll",
+    "docs:build": "vitepress build docs",
+    "docs:clean": "rm -rf docs/.vitepress/dist ./dist",
+    "docs:dev": "npm run docs:clean && npm run docs:generate && npm run vitepress:sidebar && vitepress dev docs",
     "docs:generate": "node scripts/generate-docs.js",
-    "docs:mv": "mv docs/.vuepress/dist ./",
+    "docs:mv": "mv docs/.vitepress/dist ./",
     "docs:nojekyll": "touch dist/.nojekyll",
     "lint": "npm run lint:package-json && npm run lint:eslint",
-    "lint:eslint": "eslint --config index.js --fix '**/*.{js,vue,yaml,yml}'",
+    "lint:eslint": "eslint --fix '**/*.{mjs,js,vue,yaml,yml}'",
     "lint:package-json": "sort-package-json",
-    "test": "jest"
+    "pretest": "npm run configs:build",
+    "test": "NODE_OPTIONS=\"${NODE_OPTIONS} --experimental-vm-modules\" jest",
+    "vitepress:sidebar": "node scripts/generate-vitepress-sidebar.js"
   },
   "jest": {
     "collectCoverage": true,
     "collectCoverageFrom": [
       "index.js",
-      "plugins/*.js"
+      "config/*.js",
+      "rules/*.js"
     ],
     "moduleNameMapper": {
       "eslint/use-at-your-own-risk": "eslint/lib/unsupported-api"
@@ -58,29 +63,29 @@
     "verbose": true
   },
   "dependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
+    "@eslint/js": "^9.5.0",
+    "core-js": "^3.37.1",
     "eslint-plugin-array-func": "^4.0.0",
-    "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^17.4.0",
     "eslint-plugin-no-use-extend-native": "^0.5.0",
-    "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-optimize-regex": "^1.2.1",
-    "eslint-plugin-regexp": "^2.3.0",
-    "eslint-plugin-security": "^2.1.1",
-    "eslint-plugin-sonarjs": "^0.24.0",
-    "eslint-plugin-unicorn": "^51.0.1",
-    "eslint-plugin-vue": "^9.23.0",
-    "eslint-plugin-yml": "^1.13.1"
+    "eslint-plugin-regexp": "^2.6.0",
+    "eslint-plugin-security": "^3.0.1",
+    "eslint-plugin-sonarjs": "^1.0.3",
+    "eslint-plugin-unicorn": "^54.0.0",
+    "eslint-plugin-vue": "^9.26.0",
+    "eslint-plugin-yml": "^1.14.0",
+    "globals": "^15.6.0"
   },
   "devDependencies": {
-    "@vuepress/plugin-pwa": "^1.9.10",
     "eslint": "^8.57.0",
-    "hash-sum": "^2.0.0",
     "jest": "^29.7.0",
-    "sort-package-json": "^2.8.0",
-    "vuepress": "^1.9.10",
-    "vuepress-theme-default-prefers-color-scheme": "^2.0.0"
+    "sort-package-json": "^2.10.0",
+    "vitepress": "^1.2.3"
   },
   "peerDependencies": {
-    "eslint": ">=8.0.0"
+    "eslint": "8.x"
   }
 }

package/rules/node.js

@@ -0,0 +1,71 @@
+(() => {
+  'use strict';
+
+  const path = require('path');
+
+  const NODE_VERSION = '>=16.0.0';
+  const ROOT_DIR = path.resolve(__dirname, '../../../'); // this will be in <PROJECT>/node_modules/eslint-config-simplesense/rules/
+
+  module.exports = {
+    'n/callback-return': [
+      'error', [
+        'callback',
+        'cb',
+        'done',
+        'next',
+      ],
+    ],
+    // not used because it does not support IIFE
+    // 'n/global-require': ['error'],
+    'n/handle-callback-err': ['error'],
+    'n/no-deprecated-api': [
+      'error', {
+        version: NODE_VERSION,
+      },
+    ],
+    'n/no-missing-import': ['error'],
+    'n/no-missing-require': [
+      'error', {
+        allowModules: ['aws-sdk'],
+        resolvePaths: [path.resolve(__dirname, `${ ROOT_DIR }/lambda/layers/node-modules/nodejs/node_modules`)],
+      },
+    ],
+    'n/no-mixed-requires': [
+      'error', {
+        allowCall: true,
+        grouping: true,
+      },
+    ],
+    'n/no-new-require': ['error'],
+    'n/no-path-concat': ['error'],
+    'n/no-unsupported-features/es-builtins': [
+      'error', {
+        version: NODE_VERSION,
+      },
+    ],
+    'n/no-unsupported-features/es-syntax': ['off'],
+    'n/no-unsupported-features/node-builtins': [
+      'error', {
+        version: NODE_VERSION,
+      },
+    ],
+    'n/no-unpublished-bin': ['error'],
+    'n/no-unpublished-import': ['error'],
+    'n/no-unpublished-require': [
+      'error', {
+        convertPath: {
+          [`${ path.relative(ROOT_DIR, '/opt/nodejs') }/*`]: [ '^(.*?)/opt/nodejs/(.*?)$', 'lambda/layers/$2/nodejs/$2' ],
+        },
+      },
+    ],
+    'n/prefer-global/buffer': [ 'error', 'always' ],
+    'n/prefer-global/console': [ 'error', 'always' ],
+    'n/prefer-global/process': [ 'error', 'always' ],
+    'n/prefer-global/text-decoder': [ 'error', 'never' ],
+    'n/prefer-global/text-encoder': [ 'error', 'never' ],
+    'n/prefer-global/url-search-params': [ 'error', 'never' ],
+    'n/prefer-global/url': [ 'error', 'never' ],
+    'n/prefer-promises/dns': ['error'],
+    'n/prefer-promises/fs': ['error'],
+  };
+})();

package/rules/vue.js

@@ -0,0 +1,14 @@
+(() => {
+  'use strict';
+
+  module.exports = {
+    'unicorn/filename-case': [
+      'error', {
+        case: 'pascalCase',
+      },
+    ],
+    'vue/component-name-in-template-casing': [ 'error', 'kebab-case' ],
+    'vue/component-definition-name-casing': [ 'error', 'kebab-case' ],
+    'vue/singleline-html-element-content-newline': 'off',
+  };
+})();

package/rules/yaml.js

@@ -0,0 +1,27 @@
+(() => {
+  'use strict';
+
+  module.exports = {
+    'yml/block-sequence': [ 'error', 'always' ],
+    'yml/file-extension': [
+      'error',
+      {
+        extension: 'yaml',
+        caseSensitive: true,
+      },
+    ],
+    'yml/indent': [
+      'error',
+      2,
+      {
+        indentBlockSequences: true,
+      },
+    ],
+    'yml/no-empty-document': ['off'],
+    'yml/quotes': [
+      'error', {
+        prefer: 'single',
+      },
+    ],
+  };
+})();

package/plugins/node.js

@@ -1,71 +0,0 @@
-(() => {
-  'use strict';
-
-  const path = require('path');
-
-  const NODE_VERSION = '>=14.0.0';
-  const ROOT_DIR = path.resolve(__dirname, '../../../');
-
-  module.exports = {
-    'node/callback-return': [
-      'error', [
-        'callback',
-        'cb',
-        'done',
-        'next',
-      ],
-    ],
-    // not used because it does not support IIFE
-    // 'node/global-require': ['error'],
-    'node/handle-callback-err': ['error'],
-    'node/no-deprecated-api': [
-      'error', {
-        version: NODE_VERSION,
-      },
-    ],
-    'node/no-missing-import': ['error'],
-    'node/no-missing-require': [
-      'error', {
-        allowModules: ['aws-sdk'],
-        resolvePaths: [path.resolve(__dirname, `${ ROOT_DIR }/lambda/layers/node-modules/nodejs/node_modules`)],
-      },
-    ],
-    'node/no-mixed-requires': [
-      'error', {
-        allowCall: true,
-        grouping: true,
-      },
-    ],
-    'node/no-new-require': ['error'],
-    'node/no-path-concat': ['error'],
-    'node/no-unsupported-features/es-builtins': [
-      'error', {
-        version: NODE_VERSION,
-      },
-    ],
-    'node/no-unsupported-features/es-syntax': ['off'],
-    'node/no-unsupported-features/node-builtins': [
-      'error', {
-        version: NODE_VERSION,
-      },
-    ],
-    'node/no-unpublished-bin': ['error'],
-    'node/no-unpublished-import': ['error'],
-    'node/no-unpublished-require': [
-      'error', {
-        convertPath: {
-          [`${ path.relative(ROOT_DIR, '/opt/nodejs') }/*`]: [ '^(.*?)/opt/nodejs/(.*?)$', 'lambda/layers/$2/nodejs/$2' ],
-        },
-      },
-    ],
-    'node/prefer-global/buffer': [ 'error', 'always' ],
-    'node/prefer-global/console': [ 'error', 'always' ],
-    'node/prefer-global/process': [ 'error', 'always' ],
-    'node/prefer-global/text-decoder': [ 'error', 'never' ],
-    'node/prefer-global/text-encoder': [ 'error', 'never' ],
-    'node/prefer-global/url-search-params': [ 'error', 'never' ],
-    'node/prefer-global/url': [ 'error', 'never' ],
-    'node/prefer-promises/dns': ['error'],
-    'node/prefer-promises/fs': ['error'],
-  };
-})();