@northware/tsconfig

Das Package @northware/tsconfig stellt einige Config-Presets für TypeScript zur Verfügung, die von Apps und Packages verwendet werden. Durch die Verwendung dieser Presets wird sichergestellt, das alle Apps und Packages den gleichen Konfigurationsstandards unterliegen.

Das Package basiert auf einem Standard-Package von Turborepo. Die Standard-Konfigurationen allerdings auf den Stack in diesem Projekt abgestimmt. Auf der Website von Turborepo ist genauer beschrieben, wie das Package funktioniert und konfiguriert werden kann.

Das Base Preset

In der Datei base.json ist die Basis-Konfiguration von TypeScript definiert. Diese Konfiguration wird von allen übrigen Presets verwendet und erweitert.

TSConfig in einer Next.js App

Das Preset @northware/tsconfig/nextjs.json enthält die Standard-Konfiguration für Next.js Apps. Innerhalb der einzelnen Apps muss dieses Preset dann nur noch importiert werden und die baseUrl, einzelne paths und die zu prüfenden Dateien müssen definiert werden.

{
  "extends": "@northware/tsconfig/nextjs.json",
  "compilerOptions": {
    "baseUrl": ".",
    "plugins": [{ "name": "next" }],
    "paths": {
      "@/*": ["./src/*"],
      "@northware/ui/*": ["../../packages/ui/*"]
    }
  },
  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
  "exclude": ["node_modules"]
}

Sollte es in einer App spezielle Anforderungen an die TypeScript Konfiguration geben, kann das Next.js Preset in der tsconfig.json der App erweitert werdem.

TSConfig in einem Package

Das Preset @northware/tsconfig/react-library.json enthält die Standard-Konfiguration für alle Packages (Library Packages) innerhalb des Monorepos.

Das Preset kann innerhalb der einzelnen Packages importiert werden. Hier müssen dann nur noch die baseUrl und die zu beachtenden Dateien definiert werden.

{
  "extends": "@northware/tsconfig/react-library.json",
  "include": ["."],
  "exclude": ["node_modules"],
  "compilerOptions": {
    "baseUrl": "."
  }
}

Dieses Preset enthält weniger Konfigurationen als das Next.js Preset. Die Konfigurationen können bei Bedarf auf die individuellen Anforderungen des Packages abgestimmt werden.