@hansevision/eslint-config 1.0.0

package/README.md

@@ -0,0 +1,107 @@
+# @hansevision/eslint-config
+
+A shareable, opinionated ESLint configuration for TypeScript projects.
+
+## Installation
+
+```bash
+npm install --save-dev @hansevision/eslint-config eslint typescript \
+  @typescript-eslint/eslint-plugin @typescript-eslint/parser \
+  eslint-plugin-sonarjs eslint-plugin-check-file
+```
+
+## Usage
+
+### ESLint v8 (`.eslintrc.js`)
+
+```js
+module.exports = {
+  extends: ["@hansevision/eslint-config"],
+  rules: {
+    // eigene Überschreibungen
+    "no-console": "warn",
+  },
+};
+```
+
+### Or ESLint in .eslintrc.json
+
+{
+"extends": ["@hansevision/eslint-config"]
+}
+
+### Or ESM import
+
+```js
+import base from "@hansevision/eslint-config";
+
+export default {
+  ...base,
+  // your project-specific overrides
+};
+```
+
+## Available Configurations
+
+| Export             | Description                               |
+| ------------------ | ----------------------------------------- |
+| `default` / `base` | Recommended rules for TypeScript projects |
+
+## Rules Overview
+
+### Plugins
+
+| Plugin               | Purpose                                 |
+| -------------------- | --------------------------------------- |
+| `@typescript-eslint` | TypeScript-aware lint rules             |
+| `sonarjs`            | Code quality and smell detection        |
+| `check-file`         | Enforce consistent file & folder naming |
+
+### Base rules
+
+| Rule                                       | Severity | Notes                                             |
+| ------------------------------------------ | -------- | ------------------------------------------------- |
+| `eslint:recommended`                       | —        | ESLint built-in recommended rules                 |
+| `plugin:@typescript-eslint/recommended`    | —        | typescript-eslint recommended rules               |
+| `plugin:sonarjs/recommended`               | —        | SonarJS recommended rules                         |
+| `quotes`                                   | error    | Enforce double quotes                             |
+| `no-var`                                   | error    | Disallow `var`, use `const`/`let`                 |
+| `no-console`                               | error    | Allow only `console.warn` and `console.error`     |
+| `no-debugger`                              | error    | Disallow `debugger` statements                    |
+| `eqeqeq`                                   | error    | Always require strict equality (`===`)            |
+| `curly`                                    | error    | Always require braces for control statements      |
+| `@typescript-eslint/no-explicit-any`       | warn     | Discourage use of `any` type                      |
+| `@typescript-eslint/no-unused-vars`        | error    | Ignore variables/args prefixed with `_`           |
+| `@typescript-eslint/no-non-null-assertion` | warn     | Discourage non-null assertions (`!`)              |
+| `sonarjs/no-duplicate-string`              | error    | Flag strings repeated ≥ 2 times                   |
+| `sonarjs/max-lines`                        | error    | Maximum 40 lines per file                         |
+| `sonarjs/arrow-function-convention`        | error    | Require parentheses and braces in arrow functions |
+| `check-file/folder-naming-convention`      | error    | `src/` subfolders must use camelCase              |
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build the package
+npm run build
+
+# Watch mode
+npm run dev
+
+# Lint the source
+npm run lint
+```
+
+## Publishing
+
+Update the package name in `package.json` (replace `@hansevision` with your npm scope or organization), then:
+
+```bash
+npm publish --access public
+```
+
+## License
+
+UNLICENSED — proprietary, all rights reserved.

package/dist/index.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+
+// Re-export from ESM build via dynamic import wrapper
+// For CJS consumers, we use a synchronous approach:
+const mod = require("./index.js");
+module.exports = mod;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from "eslint";
+export declare const base: Linter.Config;
+export default base;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,eAAO,MAAM,IAAI,EAAE,MAAM,CAAC,MAmCzB,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/index.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.base = void 0;
+exports.base = {
+    parser: "@typescript-eslint/parser",
+    parserOptions: {
+        ecmaVersion: 2020,
+        sourceType: "module",
+    },
+    plugins: ["@typescript-eslint", "sonarjs"],
+    extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:sonarjs/recommended",
+    ],
+    rules: {
+        "quotes": ["error", "double"],
+        "no-console": ["error", { "allow": ["warn", "error"] }],
+        "no-var": "error",
+        "@typescript-eslint/no-explicit-any": "warn",
+        "@typescript-eslint/no-unused-vars": [
+            "error",
+            { "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" },
+        ],
+        "@typescript-eslint/no-non-null-assertion": "warn",
+        "no-debugger": "error",
+        "eqeqeq": ["error", "always"],
+        "curly": ["error", "all"],
+        "check-file/folder-naming-convention": [
+            "error",
+            {
+                "src/**/": "CAMEL_CASE"
+            }
+        ],
+        "sonarjs/no-duplicate-string": ["error", { "threshold": 2 }],
+        "sonarjs/max-lines": ["error", { "maximum": 40 }],
+        "sonarjs/arrow-function-convention": ["error", { "requireParameterParentheses": true, "requireBodyBraces": true }]
+    },
+};
+exports.default = exports.base;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEa,QAAA,IAAI,GAAkB;IACjC,MAAM,EAAE,2BAA2B;IACnC,aAAa,EAAE;QACb,WAAW,EAAE,IAAI;QACjB,UAAU,EAAE,QAAQ;KACrB;IACD,OAAO,EAAE,CAAC,oBAAoB,EAAE,SAAS,CAAC;IAC1C,OAAO,EAAE;QACP,oBAAoB;QACpB,uCAAuC;QACvC,4BAA4B;KAC7B;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC7B,YAAY,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;QACvD,QAAQ,EAAE,OAAO;QACjB,oCAAoC,EAAE,MAAM;QAC5C,mCAAmC,EAAE;YACnC,OAAO;YACP,EAAE,mBAAmB,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE;SACzD;QACD,0CAA0C,EAAE,MAAM;QAClD,aAAa,EAAE,OAAO;QACtB,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;QAC7B,OAAO,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC;QACzB,qCAAqC,EAAE;YACrC,OAAO;YACP;gBACE,SAAS,EAAE,YAAY;aACxB;SACF;QACD,6BAA6B,EAAE,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;QAC5D,mBAAmB,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;QACjD,mCAAmC,EAAE,CAAC,OAAO,EAAE,EAAE,6BAA6B,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAC;KACnH;CACF,CAAC;AAEF,kBAAe,YAAI,CAAC"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@hansevision/eslint-config",
+  "author": "HanseVision",
+  "version": "1.0.0",
+  "description": "Shareable ESLint configuration with TypeScript support",
+  "keywords": [],
+  "license": "UNLICENSED",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json && node scripts/build-cjs.js",
+    "dev": "tsc --watch --project tsconfig.build.json",
+    "lint": "npm run build && eslint src --ext .ts",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@types/eslint": "^8.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "eslint": "^8.57.1",
+    "eslint-plugin-sonarjs": "^4.0.2",
+    "typescript": "^3.9.10"
+  },
+  "volta": {
+    "node": "16.20.2"
+  }
+}