@mkvlrn/config 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mike Valeriano <mkvlrn@gmail.com>
+
+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,63 @@
+# @mkvlrn/config
+
+Custom, opinionated configurations for biome and typescript (tsconfig.json).
+
+To be used in my node projects - aimed at modern, type-safe, non-spaghetti codebases.
+
+They'll work well in most base node, nest, and react (non next) projects without changes, just by extending these configs.
+
+[![npm](https://img.shields.io/npm/v/@mkvlrn/config)](https://www.npmjs.com/package/@mkvlrn/config)
+
+## Installation
+
+```bash
+pnpm add @mkvlrn/config -D
+```
+
+## Usage
+
+Obs: Both biome and typescript need to be installed separately and be available in the project.
+
+### biome
+
+Create your configuration file (`biome.json` or `biome.jsonc`):
+
+<details>
+<summary><code>biome.jsonc</code></summary>
+
+```jsonc
+{
+  "$schema": "node_modules/@biomejs/biome/configuration_schema.json",
+  "root": true, // if this is the root of your project, false otherwise
+  "extends": ["@mkvlrn/config/biome"],
+  "overrides": [
+    // any overrides, see biome docs
+  ]
+}
+```
+
+</details>
+
+### typescript (tsconfig.json)
+
+Create your configuration file:
+
+<details>
+<summary><code>tsconfig.json</code></summary>
+
+```jsonc
+{
+  "extends": "@mkvlrn/config/tsconfig",
+  "compilerOptions": {
+    // add your custom rules here
+  }
+}
+```
+
+</details>
+
+Obs: anything related to files needs to be set: rootDir, outDir, baseUrl, paths, etc - this prevents path confusion because the "original" tsconfig will be in node_modules.
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@mkvlrn/config",
+  "description": "Opinionated configurations for biome and typescript",
+  "version": "3.0.0",
+  "license": "MIT",
+  "type": "module",
+  "author": "Mike Valeriano <mkvlrn@proton.me>",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:mkvlrn/tools"
+  },
+  "keywords": [
+    "node",
+    "typescript",
+    "biome",
+    "tsconfig"
+  ],
+  "engines": {
+    "node": "22.x"
+  },
+  "files": [
+    "src"
+  ],
+  "exports": {
+    "./biome": "./src/biome.jsonc",
+    "./tsconfig": "./src/tsconfig.json"
+  },
+  "devDependencies": {
+    "lint-staged": "^16.2.7"
+  }
+}

package/src/biome.jsonc

@@ -0,0 +1,89 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",
+  "root": false,
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": "on",
+        "useSortedAttributes": "on",
+        "useSortedKeys": "off",
+        "useSortedProperties": "on"
+      }
+    }
+  },
+  "javascript": {
+    "parser": {
+      // for nest decorators
+      "unsafeParameterDecoratorsEnabled": true
+    }
+  },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": true,
+    "lineEnding": "lf",
+    "lineWidth": 100,
+    "indentStyle": "space",
+    "indentWidth": 2
+  },
+  "linter": {
+    "domains": {
+      "project": "all",
+      "test": "all",
+      "react": "all",
+      "next": "none",
+      "solid": "none",
+      "qwik": "none"
+    },
+    "enabled": true,
+    "rules": {
+      "a11y": "on",
+      "complexity": "on",
+      "correctness": "on",
+      "nursery": "off",
+      "performance": "on",
+      "security": "on",
+      "style": "on",
+      "suspicious": "on"
+    }
+  },
+  "overrides": [
+    {
+      "includes": ["**/*"],
+      "linter": {
+        "rules": {
+          "complexity": {
+            // because of typescript's noPropertyAccessFromIndexSignature
+            "useLiteralKeys": "off"
+          },
+          "correctness": {
+            // bundler mode for imports, no need for extensions
+            "useImportExtensions": "off"
+          }
+        }
+      }
+    },
+    {
+      // test files, config files, and some scripts
+      // should be able to import from node
+      "includes": ["**/*.config.ts", "**/*.test.ts", "**/*.spec.ts"],
+      "linter": {
+        "rules": {
+          "correctness": {
+            "noNodejsModules": "off"
+          }
+        }
+      }
+    },
+    {
+      // config files should be able to export defaults as per tooling requirements
+      "includes": ["**/*.config.ts"],
+      "linter": {
+        "rules": {
+          "style": {
+            "noDefaultExport": "off"
+          }
+        }
+      }
+    }
+  ]
+}

package/src/tsconfig.json

@@ -0,0 +1,37 @@
+{
+  "compilerOptions": {
+    // no emit by default, using bundler
+    "noEmit": true,
+    // typescript QOL
+    "allowImportingTsExtensions": true,
+    // very strict
+    "allowJs": false,
+    "erasableSyntaxOnly": true,
+    "verbatimModuleSyntax": true,
+    "exactOptionalPropertyTypes": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "noUncheckedSideEffectImports": true,
+    // esm
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "lib": ["ESNext"],
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "moduleDetection": "force",
+    "target": "esnext",
+    // pnpm compatibility
+    "preserveSymlinks": false,
+    // self explanatory
+    "resolveJsonModule": true,
+    // don't try to check for errors on imported libs
+    "skipLibCheck": true,
+    // nest still uses these old experimental decorators
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    // react
+    "jsx": "react-jsx"
+  }
+}