@hayuno/eslint-config 1.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hayuno AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,96 @@
+# @hayuno-ag/eslint-config
+
+This packages offers configurations for ESLint and Prettier which are used for projects at Hayuno AG.
+
+## Prerequisites
+
+Install `eslint`, `typescript`, `@typescript-eslint/parser`, `eslint-config-prettier`, `prettier` and `@hayuno-ag/eslint-config` as dev dependencies:
+
+```sh
+npm install --save-dev @hayuno-ag/eslint-config eslint typescript @typescript-eslint/parser eslint-config-prettier prettier
+```
+
+Note: If you're using Next.js, `next` is already expected to be installed in your project. The plugin is included as a dependency of this package: `@next/eslint-plugin-next`.
+
+## Integration
+
+By setting-up your `eslint.config.mjs` (example):
+
+```js
+import { defineConfig } from 'eslint/config';
+import eslintConfig from '@hayuno-ag/eslint-config';
+// additional imports
+
+export default defineConfig([
+  globalIgnores(['**/node_modules', '**/dist', '**/build', 'bin/**', 'package-lock.json']),
+  ...eslintConfig,
+  {
+    languageOptions: {
+      /* your language options */
+    },
+    rules: {
+      /* your override rules */
+    },
+  },
+  // Test-specific rules
+  {
+    files: ['tests/**/*.test.tsx', 'tests/**/*.test.ts'],
+    rules: {
+      '@hayuno-ag/no-speculative-it': 'warn',
+      /* your additional rule overrides */
+    },
+  },
+  // Ignore patterns
+  {
+    ignores: [
+      /* your ignore file patterns */
+    ],
+  },
+]);
+```
+
+## Custom Rules Plugin
+
+This package also offers a custom rules plugin, which can be used to add custom rules to your project.
+
+Currently, there's only one rule: `@hayuno-ag/no-speculative-it`, defined at `rules/no-speculative-it.ts`.
+
+### Defining additional rules
+
+Taking `no-speculative-it.js` as template, you can easily define additional rules by just adding another
+js-file implementing the rule and storing it at `rules/custom`. `rules/custom/index.js` will then automatically
+load all rules from this directory and `index.mjs` will export them as long as `jest` is installed as
+dependency in the consuming project.
+
+By default, all newly-created rules are set to `error` severity. If you want to change this, you can
+simply set the `meta.severity` property in the rule definition as shown in `no-speculative-it.js`.
+
+As shown in [Integration](#integration) above, you can change a rule's severity level by adding it to the `rules`
+property of your `eslint.config.mjs`. If you don't want to override a rule's severity level, you don't have
+to add it to the according `rules` property. It then is executed with its default severity level.
+
+The names of the rules defined in this project are prefixed with `@hayuno-ag/`. Therefore, `no-speculative-it`
+is referenced by `@hayuno-ag/no-speculative-it`.
+
+### `@hayuno-ag/no-speculative-it`
+
+This rule is used to prevent speculative `it` statements and enforces the usage of imperative statements instead.
+
+Example: Instead of `it('should restart the universe from the beginning')` the imperative statement
+`it('restarts the universe from the beginning')` should be used.
+
+Default severity: `error`.
+
+## Additional information
+
+This package requires the following peer dependencies to be installed in your project:
+
+- `eslint` (>= 9.33.0)
+- `typescript` (>= 4.0.0)
+- `@typescript-eslint/parser` (^8.37.0)
+- `eslint-config-prettier` (^10.1.8)
+- `prettier` (^3.6.2)
+- `jest` (^30.2.0) - only required if you want to use the Jest-related rules
+
+All ESLint plugins (such as `eslint-plugin-react`, `eslint-plugin-react-hooks`, `eslint-plugin-jsx-a11y`,
+etc.) are included as regular dependencies in this package, so you don't need to install them separately.

package/index.mjs

@@ -0,0 +1,72 @@
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { FlatCompat } from '@eslint/eslintrc';
+import js from '@eslint/js';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import importPlugin from 'eslint-plugin-import';
+import jestPlugin from 'eslint-plugin-jest';
+import reactPlugin from 'eslint-plugin-react';
+import reactHooksPlugin from 'eslint-plugin-react-hooks';
+import testingLibraryPlugin from 'eslint-plugin-testing-library';
+import jsxA11yPlugin from 'eslint-plugin-jsx-a11y';
+import nextPlugin from '@next/eslint-plugin-next';
+import prettierConfig from 'eslint-config-prettier';
+
+const require = createRequire(import.meta.url);
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const moduleExists = (module) => {
+  try {
+    require.resolve(module, {
+      paths: [process.cwd(), path.join(process.cwd(), 'node_modules')],
+    });
+    return true;
+  } catch (error) {
+    if (error && error.code === 'MODULE_NOT_FOUND') return false;
+    throw error;
+  }
+};
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+const legacyRuleConfigs = ['./rules/base'];
+if (moduleExists('next')) legacyRuleConfigs.push('./rules/next');
+if (moduleExists('react')) legacyRuleConfigs.push('./rules/react');
+if (moduleExists('jest')) legacyRuleConfigs.push('./rules/jest');
+if (moduleExists('typescript')) legacyRuleConfigs.push('./rules/typescript');
+legacyRuleConfigs.push('./rules/prettier');
+
+const baseConfigs = compat.extends(...legacyRuleConfigs.map(require.resolve));
+
+const globalPlugins = [
+  {
+    plugins: {
+      '@typescript-eslint': typescriptEslint,
+      import: importPlugin,
+      jest: jestPlugin,
+      react: reactPlugin,
+      'react-hooks': reactHooksPlugin,
+      'jsx-a11y': jsxA11yPlugin,
+      '@next/next': nextPlugin,
+      'testing-library': testingLibraryPlugin,
+    },
+  },
+];
+
+const customPlugin = require('./rules/custom');
+const customRules = {
+  plugins: {
+    '@hayuno-ag': customPlugin,
+  },
+  rules: Object.fromEntries(
+    Object.entries(customPlugin.rules).map(([name, rule]) => [`@hayuno-ag/${name}`, rule.meta?.severity || 'error']),
+  ),
+};
+
+export default [...globalPlugins, ...baseConfigs, customRules, prettierConfig];

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@hayuno/eslint-config",
+  "version": "1.0.5",
+  "description": "ESLint configuration used for projects at Hayuno AG",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "typescript",
+    "prettier"
+  ],
+  "homepage": "https://gitlab.com/hayuno/eslint-config#hayuno-ageslint-config",
+  "bugs": {
+    "url": "https://gitlab.com/hayuno/eslint-config/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@gitlab.com/hayuno/eslint-config.git"
+  },
+  "license": "MIT",
+  "author": "Hayuno AG",
+  "type": "commonjs",
+  "main": "index.mjs",
+  "files": [
+    "*.js",
+    "*.mjs",
+    "rules"
+  ],
+  "scripts": {
+    "format": "prettier --check .",
+    "format:fix": "prettier --write .",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "@next/eslint-plugin-next": ">=15.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.37.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jest": "^29.0.1",
+    "eslint-plugin-jest-dom": "^5.5.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-testing-library": "^7.15.1"
+  },
+  "devDependencies": {
+    "husky": "^9.1.7",
+    "prettier": "^3.6.2"
+  },
+  "peerDependencies": {
+    "@typescript-eslint/parser": "^8.37.0",
+    "eslint": ">=9.33.0",
+    "eslint-config-prettier": "^10.1.8",
+    "jest": "^30.2.0",
+    "prettier": "^3.6.2",
+    "typescript": ">=4.0.0"
+  },
+  "engines": {
+    "node": ">=22.14.0"
+  }
+}

package/rules/base.js

@@ -0,0 +1,41 @@
+module.exports = {
+  ignorePatterns: ['!.*'],
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  plugins: ['@typescript-eslint'],
+  env: {
+    browser: true,
+    node: true,
+    es2022: true,
+  },
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+  },
+  reportUnusedDisableDirectives: true,
+  rules: {
+    'import/extensions': ['error', 'ignorePackages', { js: 'never', '': 'never' }],
+    'import/no-cycle': 'off',
+    'import/no-extraneous-dependencies': [
+      'error',
+      {
+        devDependencies: ['**/*.test.ts'],
+      },
+    ],
+    'import/no-useless-path-segments': ['error', { noUselessIndex: true }],
+    'import/order': ['error', { 'newlines-between': 'never' }],
+    'import/prefer-default-export': 'off',
+    'arrow-body-style': 'error',
+    'max-classes-per-file': 'off',
+    'max-len': ['error', { code: 120 }],
+    'no-console': 'error',
+    'no-empty-function': ['error', { allow: ['arrowFunctions'] }],
+    'no-use-before-define': ['error', { functions: false }],
+    'prefer-arrow-callback': 'error',
+  },
+  overrides: [
+    {
+      files: ['scripts/**', 'bin/**'],
+    },
+  ],
+};

package/rules/custom/index.js

@@ -0,0 +1,18 @@
+const fs = require('fs');
+const path = require('path');
+
+const customDir = __dirname;
+const files = fs.readdirSync(customDir);
+
+const ruleFiles = files.filter((file) => file.endsWith('.js') && file !== 'index.js');
+
+const rules = {};
+ruleFiles.forEach((file) => {
+  const filePath = path.join(customDir, file);
+  const ruleModule = require(filePath);
+  Object.assign(rules, ruleModule);
+});
+
+module.exports = {
+  rules,
+};

package/rules/custom/no-speculative-it.js

@@ -0,0 +1,57 @@
+module.exports = {
+  'no-speculative-it': {
+    meta: {
+      type: 'suggestion',
+      docs: {
+        description: 'Enforce imperative mood in it-descriptions instead of "should"',
+        category: 'Best Practices',
+        recommended: false,
+      },
+      fixable: null,
+      schema: [],
+      messages: {
+        noShould: 'Prefer using imperative mood (e.g. "{{suggestion}}") instead of "should {{action}}"',
+      },
+      severity: 'error',
+    },
+    create(context) {
+      const shouldPattern = /^should\s+(.+)/i;
+
+      return {
+        CallExpression(node) {
+          if (node.callee.type === 'Identifier' && node.callee.name === 'it' && node.arguments.length > 0) {
+            const firstArg = node.arguments[0];
+
+            if (firstArg.type === 'Literal' && typeof firstArg.value === 'string') {
+              const match = firstArg.value.match(shouldPattern);
+
+              if (match) {
+                const action = match[1];
+                const suggestion = action.replace(/^(\w+)/, (word) => {
+                  switch (word) {
+                    case 'not':
+                      return 'does not';
+                    case 'be':
+                      return 'is/has';
+                  }
+                  if (word.endsWith('y')) return word.slice(0, -1) + 'ies';
+                  if (word.endsWith('ch')) return word + 'es';
+                  return word + 's';
+                });
+
+                context.report({
+                  node: firstArg,
+                  messageId: 'noShould',
+                  data: {
+                    action,
+                    suggestion,
+                  },
+                });
+              }
+            }
+          }
+        },
+      };
+    },
+  },
+};

package/rules/jest.js

@@ -0,0 +1,13 @@
+module.exports = {
+  overrides: [
+    {
+      files: ['*.test.*'],
+      extends: ['plugin:jest/recommended', 'plugin:jest-dom/recommended'],
+      env: { 'jest/globals': true },
+      rules: {
+        'require-await': 'error',
+        'jest/consistent-test-it': ['error', { fn: 'it', withinDescribe: 'it' }],
+      },
+    },
+  ],
+};

package/rules/next.js

@@ -0,0 +1,4 @@
+module.exports = {
+  extends: ['plugin:@next/next/recommended', 'plugin:@next/next/core-web-vitals'],
+  parser: '@typescript-eslint/parser',
+};

package/rules/prettier.js

@@ -0,0 +1,7 @@
+module.exports = {
+  extends: ['plugin:prettier/recommended'],
+  plugins: ['prettier'],
+  rules: {
+    'prettier/prettier': 'error',
+  },
+};

package/rules/react.js

@@ -0,0 +1,58 @@
+module.exports = {
+  extends: ['plugin:react/recommended', 'plugin:react-hooks/recommended', 'plugin:jsx-a11y/recommended'],
+  rules: {
+    'react/default-props-match-prop-types': 'off',
+    'react/destructuring-assignment': ['error', 'always', { ignoreClassFields: true }],
+    'react/function-component-definition': [
+      'error',
+      {
+        unnamedComponents: 'arrow-function',
+        namedComponents: ['arrow-function', 'function-declaration'],
+      },
+    ],
+    'react/jsx-filename-extension': ['error', { extensions: ['.js', '.jsx'] }],
+    'react/jsx-props-no-spreading': 'off',
+    'react/no-unused-prop-types': 'off',
+    'react/prop-types': 'off',
+    'react/react-in-jsx-scope': 'off',
+    'react/require-default-props': 'off',
+    'react/state-in-constructor': 'off',
+    'import/order': [
+      'error',
+      {
+        pathGroups: [{ pattern: 'react', group: 'external', position: 'before' }],
+        pathGroupsExcludedImportTypes: ['react'],
+        'newlines-between': 'never',
+      },
+    ],
+    'jsx-a11y/anchor-is-valid': [
+      'error',
+      {
+        specialLink: ['hrefLeft', 'hrefRight', 'to'],
+        aspects: ['noHref', 'invalidHref', 'preferButton'],
+      },
+    ],
+    'no-restricted-globals': ['error', { name: 'React', message: 'Prefer importing from "react".' }],
+    'no-restricted-imports': [
+      'error',
+      {
+        name: 'react',
+        importNames: ['default'],
+        message: 'Prefer using named exports.',
+      },
+      {
+        name: 'react',
+        importNames: ['FC'],
+        message: 'Prefer type inference for component return types.',
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx'],
+      rules: {
+        'react/jsx-filename-extension': ['error', { extensions: ['.tsx'] }],
+      },
+    },
+  ],
+};

package/rules/typescript.js

@@ -0,0 +1,80 @@
+module.exports = {
+  settings: {
+    react: {
+      version: 'detect',
+    },
+    'import/extensions': ['.ts', '.tsx'],
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx'],
+    },
+    'import/resolver': {
+      node: {
+        extensions: ['.ts', '.tsx'],
+        moduleDirectory: ['node_modules', 'src/'],
+      },
+    },
+  },
+  rules: {
+    'import/extensions': [
+      'error',
+      'ignorePackages',
+      {
+        js: 'never',
+        ts: 'never',
+        tsx: 'never',
+        '': 'never',
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx'],
+      parser: '@typescript-eslint/parser',
+      plugins: ['@typescript-eslint'],
+      extends: [
+        'plugin:@typescript-eslint/recommended',
+        'plugin:@typescript-eslint/recommended-requiring-type-checking',
+      ],
+      parserOptions: {
+        project: ['./tsconfig.json', './**/tsconfig.json'],
+        createDefaultProgram: true,
+        ecmaVersion: 2022,
+        sourceType: 'module',
+      },
+      rules: {
+        '@typescript-eslint/consistent-type-imports': 'error',
+        '@typescript-eslint/default-param-last': 'error',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/no-empty-function': ['error', { allow: ['arrowFunctions'] }],
+        '@typescript-eslint/no-explicit-any': 'error',
+        '@typescript-eslint/no-unused-vars': [
+          'error',
+          {
+            args: 'all',
+            argsIgnorePattern: '^_',
+            caughtErrors: 'all',
+            caughtErrorsIgnorePattern: '^_',
+            destructuredArrayIgnorePattern: '^_',
+            varsIgnorePattern: '^_',
+            ignoreRestSiblings: true,
+          },
+        ],
+        '@typescript-eslint/no-use-before-define': ['error', { functions: false }],
+        '@typescript-eslint/no-useless-constructor': 'error',
+        '@typescript-eslint/switch-exhaustiveness-check': 'error',
+        'import/no-unresolved': 'off',
+        'consistent-return': 'off',
+        'default-case': 'off',
+        'default-param-last': 'off',
+        'no-empty-function': 'off',
+        'no-restricted-syntax': [
+          'error',
+          { selector: 'TSEnumDeclaration', message: 'Prefer types over enums because enums are not type-safe.' },
+        ],
+        'no-use-before-define': 'off',
+        'no-useless-constructor': 'off',
+      },
+    },
+  ],
+};