@sinemacula/coding-standards 1.12.3 → 1.13.0

package/README.md

@@ -195,6 +195,32 @@ package_filters = [
 ]
 ```
 
+### TypeScript (tsconfig)
+
+The package ships a shared `tsconfig` base so every TypeScript repository checks its code to the same bar. Install the
+package (as above) and extend the base from your `tsconfig.json`:
+
+```json
+{
+    "extends": "@sinemacula/coding-standards/js/tsconfig.base.json",
+    "compilerOptions": {
+        "lib": ["ES2023", "DOM", "DOM.Iterable"],
+        "types": ["node"]
+    },
+    "include": ["src"]
+}
+```
+
+The base carries only the environment-independent options: the full strictness set and the module/resolution
+discipline. Everything environment-specific stays in the consuming repo and layers on top - `lib` (DOM for the browser,
+none for a Node service), `types`, Vue's `jsx`/`jsxImportSource`, `paths`, `noEmit`, and the `include`/`exclude` globs.
+The `target` and `module` defaults suit bundler-built apps and libraries; a non-bundler project overrides them.
+
+The base sets `noPropertyAccessFromIndexSignature`, so a property that comes from an index signature is accessed with
+brackets (`config['key']`), not a dot. Biome cannot see types and so cannot tell that access apart from a normal one,
+which is why its `useLiteralKeys` rule is off and the type-aware `@typescript-eslint/dot-notation` rule enforces dot
+access for real properties instead. Load the type-checked ESLint layer to get it.
+
 ### Knip (JavaScript / TypeScript)
 
 ```json

package/js/biome.json

@@ -38,7 +38,7 @@
                 "noUselessTernary": "warn",
                 "noUselessUndefinedInitialization": "warn",
                 "useArrowFunction": "warn",
-                "useLiteralKeys": "warn",
+                "useLiteralKeys": "off",
                 "useNumericLiterals": "warn"
             },
             "correctness": {

package/js/eslint/type-checked.js

@@ -31,6 +31,9 @@ export default [
 
             '@typescript-eslint/await-thenable': 'error',
             '@typescript-eslint/consistent-type-imports': 'error',
+            // Type-aware replacement for Biome's useLiteralKeys: dot access for
+            // real properties, bracket access allowed on index signatures.
+            '@typescript-eslint/dot-notation': ['error', { allowIndexSignaturePropertyAccess: true }],
             '@typescript-eslint/explicit-module-boundary-types': 'error',
             '@typescript-eslint/no-floating-promises': 'error',
             '@typescript-eslint/no-misused-promises': 'error',

package/js/tsconfig.base.json

@@ -0,0 +1,27 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "display": "@sinemacula/coding-standards base",
+    "compilerOptions": {
+        "target": "ES2023",
+        "module": "Preserve",
+        "moduleResolution": "Bundler",
+        "moduleDetection": "force",
+        "verbatimModuleSyntax": true,
+        "isolatedModules": true,
+        "resolveJsonModule": true,
+        "esModuleInterop": true,
+        "strict": true,
+        "noUncheckedIndexedAccess": true,
+        "noPropertyAccessFromIndexSignature": true,
+        "exactOptionalPropertyTypes": true,
+        "noImplicitOverride": true,
+        "noFallthroughCasesInSwitch": true,
+        "noImplicitReturns": true,
+        "allowUnreachableCode": false,
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "noUncheckedSideEffectImports": true,
+        "forceConsistentCasingInFileNames": true,
+        "skipLibCheck": true
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sinemacula/coding-standards",
-    "version": "1.12.3",
+    "version": "1.13.0",
     "description": "Centralized coding standards, static analysis configurations, and code quality tooling for all Sine Macula repositories.",
     "license": "Apache-2.0",
     "author": "Ben Carey <bdmc@sinemacula.co.uk>",
@@ -16,6 +16,7 @@
         "biome",
         "knip",
         "eslint",
+        "typescript",
         "coding-standards",
         "linting",
         "config"
@@ -36,6 +37,7 @@
         "./js/eslint": "./js/eslint/index.js",
         "./js/eslint/type-checked": "./js/eslint/type-checked.js",
         "./js/eslint/vue": "./js/eslint/vue.js",
+        "./js/tsconfig.base.json": "./js/tsconfig.base.json",
         "./*": "./*"
     },
     "scripts": {