eslint-config-simplesense 4.0.6 → 5.0.0

package/README.md

@@ -38,5 +38,5 @@ npm install
 npm run lint
 npm run test
 npm run docs:dev
-# navigate to the URL provided by Vuepress
+# navigate to the URL provided by Vitepress
 ```

package/config/array-func.js

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

package/config/eslint-comments.js

@@ -1,13 +1,9 @@
-(() => {
-  'use strict';
+import plugin from '@eslint-community/eslint-plugin-eslint-comments';
 
-  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,
-  };
-})();
+export default {
+  name: 'simplesense/eslint-comments',
+  plugins: {
+    '@eslint-community/eslint-comments': plugin,
+  },
+  rules: plugin.configs.recommended.rules,
+};

package/config/eslint.js

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

package/config/globals.js

@@ -0,0 +1,21 @@
+import globals from 'globals';
+
+const vitest = {
+  vi: true,
+  describe: true,
+  it: true,
+  expect: true,
+  beforeEach: true,
+  afterEach: true,
+  beforeAll: true,
+  afterAll: true,
+  spyFn: true,
+};
+
+export default {
+  ...globals.browser,
+  ...globals.es2021,
+  ...globals.es6,
+  ...globals.node,
+  ...vitest,
+};

package/config/import.js

@@ -1,11 +1,27 @@
-(() => {
-  'use strict';
+import plugin from 'eslint-plugin-import';
 
-  module.exports = {
-    name: 'simplesense/import',
-    plugins: {
-      import: require('eslint-plugin-import'),
+import rules from '../rules/import.js';
+
+export default {
+  name: 'simplesense/import',
+  plugins: {
+    import: plugin,
+  },
+  rules,
+  // ERROR: parserPath or languageOptions.parser is required!
+  // see https://github.com/import-js/eslint-plugin-import/issues/2556
+  languageOptions: {
+    parserOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+    },
+  },
+  settings: {
+    'import/parsers': {
+      espree: ['.js'],
+    },
+    'import/resolver': {
+      node: true,
     },
-    rules: require('../rules/import'),
-  };
-})();
+  },
+};

package/config/node.js

@@ -1,25 +1,29 @@
-(() => {
-  'use strict';
+import path from 'node:path';
+import {
+  fileURLToPath,
+} from 'node:url';
 
-  const path = require('path');
+import plugin from 'eslint-plugin-n';
 
-  const ROOT_DIR = path.resolve(__dirname, '../../../'); // this will be in <PROJECT>/node_modules/eslint-config-simplesense/rules/
-  const NODE_VERSION = '>=16.0.0';
+import rules from '../rules/node.js';
 
-  module.exports = {
-    name: 'simplesense/node',
-    plugins: {
-      n: require('eslint-plugin-n'),
-    },
-    rules: require('../rules/node'),
-    settings: {
-      n: {
-        allowModules: ['aws-sdk'],
-        convertPath: {
-          [`${ path.relative(ROOT_DIR, '/opt/nodejs') }/*`]: [ '^(.*?)/opt/nodejs/(.*?)$', 'lambda/layers/$2/nodejs/$2' ],
-        },
-        version: NODE_VERSION,
+const DIRNAME = path.dirname(fileURLToPath(import.meta.url));
+const ROOT_DIR = path.resolve(DIRNAME, '../../../'); // this will be in <PROJECT>/node_modules/eslint-config-simplesense/rules/
+const NODE_VERSION = '>=18.0.0';
+
+export default {
+  name: 'simplesense/node',
+  plugins: {
+    n: plugin,
+  },
+  rules,
+  settings: {
+    n: {
+      allowModules: ['aws-sdk'],
+      convertPath: {
+        [`${ path.relative(ROOT_DIR, '/opt/nodejs') }/*`]: [ '^(.*?)/opt/nodejs/(.*?)$', 'lambda/layers/$2/nodejs/$2' ],
       },
+      version: NODE_VERSION,
     },
-  };
-})();
+  },
+};

package/config/optimize-regex.js

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

package/config/regexp.js

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

package/config/security.js

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

package/config/sonarjs.js

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

package/config/stylistic.js

@@ -0,0 +1,11 @@
+import plugin from '@stylistic/eslint-plugin-js';
+
+import rules from '../rules/stylistic.js';
+
+export default {
+  name: 'simplesense/stylistic',
+  plugins: {
+    '@stylistic/js': plugin,
+  },
+  rules,
+};

package/config/unicorn.js

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

package/config/vue.js

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

package/config/yaml.js

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

package/index.js

@@ -1,56 +1,51 @@
-(() => {
-  'use strict';
+import eslintConfig from './config/eslint.js';
+import arrayFuncConfig from './config/array-func.js';
+import eslintCommentsConfig from './config/eslint-comments.js';
+import globals from './config/globals.js';
+import importConfig from './config/import.js';
+import nodeConfig from './config/node.js';
+import optimizeRegexConfig from './config/optimize-regex.js';
+import regexpConfig from './config/regexp.js';
+import securityConfig from './config/security.js';
+import sonarJsConfig from './config/sonarjs.js';
+import stylisticConfig from './config/stylistic.js';
+import unicornConfig from './config/unicorn.js';
+import vueConfig from './config/vue.js';
+import yamlConfig from './config/yaml.js';
 
-  const globals = require('globals');
-
-  // 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 = [
-    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,
-        },
-      },
-    },
-    {
-      // 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.*',
-      ],
+export default [
+  eslintConfig,
+  arrayFuncConfig,
+  eslintCommentsConfig,
+  importConfig,
+  nodeConfig,
+  optimizeRegexConfig,
+  regexpConfig,
+  securityConfig,
+  stylisticConfig,
+  sonarJsConfig,
+  unicornConfig,
+  ...vueConfig, // exports an array
+  ...yamlConfig, // exports an array
+  {
+    languageOptions: {
+      sourceType: 'module',
+      globals,
     },
-  ];
-})();
+  },
+  {
+    // 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,6 +1,6 @@
 {
   "name": "eslint-config-simplesense",
-  "version": "4.0.6",
+  "version": "5.0.0",
   "description": "ESLint Config for Simplesense Styles",
   "keywords": [
     "eslint",
@@ -17,6 +17,10 @@
     "url": "git+https://github.com/simplesenseio/eslint-config-simplesense.git"
   },
   "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    ".": "./index.js"
+  },
   "main": "index.js",
   "files": [
     "index.js",
@@ -27,7 +31,7 @@
     "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:clean": "rm -rf  ./docs/rules ./docs/.vitepress/dist ./docs/.vitepress/sidebar.json ./docs/.vitepress/cache ./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/.vitepress/dist ./",
@@ -36,40 +40,16 @@
     "lint:eslint": "eslint --fix '**/*.{mjs,js,vue,yaml,yml}'",
     "lint:package-json": "sort-package-json",
     "pretest": "npm run configs:build",
-    "test": "NODE_OPTIONS=\"${NODE_OPTIONS} --experimental-vm-modules\" jest",
+    "test": "vitest --run",
     "vitepress:sidebar": "node scripts/generate-vitepress-sidebar.js"
   },
-  "jest": {
-    "collectCoverage": true,
-    "collectCoverageFrom": [
-      "index.js",
-      "config/*.js",
-      "rules/*.js"
-    ],
-    "moduleNameMapper": {
-      "eslint/use-at-your-own-risk": "eslint/lib/unsupported-api"
-    },
-    "reporters": [
-      "default",
-      "github-actions"
-    ],
-    "setupFiles": [
-      "<rootDir>/test/setup/global-functions.js"
-    ],
-    "testPathIgnorePatterns": [
-      "/node_modules/",
-      "<rootDir>/\\.github/"
-    ],
-    "verbose": true
-  },
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
     "@eslint/js": "^9.8.0",
-    "core-js": "^3.38.0",
-    "eslint-plugin-array-func": "^4.0.0",
+    "@stylistic/eslint-plugin-js": "^2.6.1",
+    "eslint-plugin-array-func": "^5.0.2",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^17.4.0",
-    "eslint-plugin-no-use-extend-native": "^0.5.0",
+    "eslint-plugin-n": "^17.10.2",
     "eslint-plugin-optimize-regex": "^1.2.1",
     "eslint-plugin-regexp": "^2.6.0",
     "eslint-plugin-security": "^3.0.1",
@@ -80,10 +60,11 @@
     "globals": "^15.9.0"
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "^2.0.5",
     "eslint": "^8.57.0",
-    "jest": "^29.7.0",
     "sort-package-json": "^2.10.0",
-    "vitepress": "^1.3.2"
+    "vitepress": "^1.3.2",
+    "vitest": "^2.0.5"
   },
   "peerDependencies": {
     "eslint": "8.x"

package/rules/array-func.js

@@ -1,10 +1,6 @@
-(() => {
-  'use strict';
-
-  module.exports = {
-    'array-func/avoid-reverse': ['error'],
-    'array-func/no-unnecessary-this-arg': ['error'],
-    'array-func/prefer-flat': ['error'],
-    'array-func/prefer-flat-map': ['error'],
-  };
-})();
+export default {
+  'array-func/avoid-reverse': ['error'],
+  'array-func/no-unnecessary-this-arg': ['error'],
+  'array-func/prefer-flat': ['error'],
+  'array-func/prefer-flat-map': ['error'],
+};