@zayne-labs/tsconfig 0.0.6

package/README.md

@@ -0,0 +1,76 @@
+# `@zayne-labs/tsconfig`
+
+This package helps set proper presets for most projects. Inspired by Matt Pocock's [TSConfig Cheat Sheet](https://www.totaltypescript.com/tsconfig-cheat-sheet).
+
+## Setup
+
+1. Install:
+
+```bash
+# Npm
+ npm install --save-dev @zayne-labs/tsconfig
+
+# Pnpm
+pnpm add -D @zayne-labs/tsconfig
+```
+
+2. Choose which `tsconfig.json` you need from the [list](#list-of-tsconfigs) below.
+
+3. Add it to your `tsconfig.json`:
+
+```jsonc
+{
+	// When building an app that runs in the DOM with an external bundler
+	"extends": "@zayne-labs/tsconfig/bundler/dom/app",
+}
+```
+
+## List of TSConfigs
+
+### Are You Using `tsc` To Turn Your `.ts` Files Into `.js` Files?
+
+#### Yes
+
+If yes, use this selection of configs:
+
+```jsonc
+{
+	// For code that runs in the DOM:
+	"extends": "@zayne-labs/tsconfig/tsc/dom/app", // For an app
+	"extends": "@zayne-labs/tsconfig/tsc/dom/library", // For a library
+
+	// For code that doesn't run in the DOM (for instance, in Node.js):
+	"extends": "@zayne-labs/tsconfig/tsc/no-dom/app", // For an app
+	"extends": "@zayne-labs/tsconfig/tsc/no-dom/library", // For a library
+}
+```
+
+#### No
+
+If no, you're probably using an external bundler.
+
+```jsonc
+{
+	// For code that runs in the DOM:
+	"extends": "@zayne-labs/tsconfig/bundler/dom/app", // For an app
+	"extends": "@zayne-labs/tsconfig/bundler/dom/library", // For a library
+
+	// For code that doesn't run in the DOM (for instance, in Node.js):
+	"extends": "@zayne-labs/tsconfig/bundler/no-dom/app", // For an app
+	"extends": "@zayne-labs/tsconfig/bundler/no-dom/library", // For a library
+}
+```
+
+### Framework-Specific Options
+
+The following are currently supported framework-specific options, will add more if needed in future:
+
+```jsonc
+{
+	// For a vite app
+	"extends": "@zayne-labs/tsconfig/bundler/dom/vite",
+
+	// For a nextjs app
+	"extends": "@zayne-labs/tsconfig/bundler/dom/next",
+}
+```

package/bundler/tsconfig.dom.json

@@ -0,0 +1,36 @@
+{
+	"compilerOptions": {
+		/* Base Options: */
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"resolveJsonModule": true,
+		"moduleDetection": "force",
+		"isolatedModules": true,
+		"verbatimModuleSyntax": true,
+		"useDefineForClassFields": true,
+
+		/* Don't allow importing JavaScript files by default, to avoid mistake "any" (burnt me before): */
+		"allowJs": false,
+
+		/* Linting: */
+		"strict": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noFallthroughCasesInSwitch": true,
+		"allowUnreachableCode": false,
+		"allowSyntheticDefaultImports": true,
+		"forceConsistentCasingInFileNames": true,
+		"noErrorTruncation": true,
+		"noUncheckedIndexedAccess": true,
+
+		/* Bundler Mode: */
+		"module": "Preserve",
+		"target": "ESNext",
+		"noEmit": true,
+		"jsx": "preserve",
+
+		/* If your code runs in the DOM: */
+		"lib": ["ESNext", "DOM", "DOM.Iterable"]
+	}
+}

package/bundler/tsconfig.next.json

@@ -0,0 +1,40 @@
+{
+	"compilerOptions": {
+		/* Base Options: */
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"resolveJsonModule": true,
+		"moduleDetection": "force",
+		"useDefineForClassFields": true,
+		"isolatedModules": true,
+		"verbatimModuleSyntax": true,
+
+		/* Don't allow importing JavaScript files by default, to avoid mistake "any" (burnt me before): */
+		"allowJs": false,
+
+		/* Linting: */
+		"strict": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noFallthroughCasesInSwitch": true,
+		"allowUnreachableCode": false,
+		"allowSyntheticDefaultImports": true,
+		"forceConsistentCasingInFileNames": true,
+		"noErrorTruncation": true,
+		"noUncheckedIndexedAccess": true,
+
+		/* Bundler mode: */
+		"module": "Preserve",
+		"target": "ESNext",
+		"noEmit": true,
+		"jsx": "preserve",
+
+		/* NextJs Bundler mode: */
+		"plugins": [{ "name": "next" }],
+		"incremental": true,
+
+		/* If your code runs in the DOM: */
+		"lib": ["ESNext", "DOM", "DOM.Iterable"]
+	}
+}

package/bundler/tsconfig.no-dom.json

@@ -0,0 +1,36 @@
+{
+	"compilerOptions": {
+		/* Base Options: */
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"resolveJsonModule": true,
+		"moduleDetection": "force",
+		"isolatedModules": true,
+		"verbatimModuleSyntax": true,
+		"useDefineForClassFields": true,
+
+		/* Don't allow importing JavaScript files by default, to avoid mistake "any" (burnt me before): */
+		"allowJs": false,
+
+		/* Linting: */
+		"strict": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noFallthroughCasesInSwitch": true,
+		"allowUnreachableCode": false,
+		"allowSyntheticDefaultImports": true,
+		"forceConsistentCasingInFileNames": true,
+		"noErrorTruncation": true,
+		"noUncheckedIndexedAccess": true,
+
+		/* If NOT transpiling with TypeScript: */
+		"module": "Preserve",
+		"target": "ESNext",
+		"noEmit": true,
+		"jsx": "preserve",
+
+		/* If your code doesn't run in the DOM: */
+		"lib": ["ESNext"]
+	}
+}

package/bundler/tsconfig.vite.json

@@ -0,0 +1,39 @@
+{
+	"compilerOptions": {
+		/* Base Options: */
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"resolveJsonModule": true,
+		"moduleDetection": "force",
+		"useDefineForClassFields": true,
+		"isolatedModules": true,
+		"verbatimModuleSyntax": true,
+
+		/* Don't allow importing JavaScript files by default, to avoid mistake "any" (burnt me before): */
+		"allowJs": false,
+
+		/* Linting: */
+		"strict": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noFallthroughCasesInSwitch": true,
+		"allowUnreachableCode": false,
+		"allowSyntheticDefaultImports": true,
+		"forceConsistentCasingInFileNames": true,
+		"noErrorTruncation": true,
+		"noUncheckedIndexedAccess": true,
+
+		/* Bundler mode: */
+		"module": "Preserve",
+		"target": "ESNext",
+		"noEmit": true,
+		"jsx": "preserve",
+
+		/* Vite Bundler mode: */
+		"types": ["vite/client"],
+
+		/* If your code runs in the DOM: */
+		"lib": ["ESNext", "DOM", "DOM.Iterable"]
+	}
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@zayne-labs/tsconfig",
+  "version": "0.0.6",
+  "description": "A collection of TypeScript configurations for various projects, based on Total TypeScript's TSConfig Cheat Sheet, with a few additions.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ryan-zayne/tsconfig.git"
+  },
+  "homepage": "https://github.com/ryan-zayne/tsconfig#readme",
+  "license": "MIT",
+  "author": "Ryan Zayne",
+  "exports": {
+    "./tsc": "./tsc/dom/tsconfig.app.json",
+    "./tsc/dom": "./tsc/dom/tsconfig.app.json",
+    "./tsc/dom/app": "./tsc/dom/tsconfig.app.json",
+    "./tsc/dom/library": "./tsc/dom/tsconfig.lib.json",
+    "./tsc/no-dom": "./tsc/no-dom/tsconfig.app.json",
+    "./tsc/no-dom/app": "./tsc/no-dom/tsconfig.app.json",
+    "./tsc/no-dom/library": "./tsc/no-dom/tsconfig.lib.json",
+    "./bundler": "./bundler/tsconfig.dom.json",
+    "./bundler/dom": "./bundler/tsconfig.dom.json",
+    "./bundler/dom/app": "./bundler/tsconfig.dom.json",
+    "./bundler/dom/library": "./bundler/tsconfig.dom.json",
+    "./bundler/no-dom": "./bundler/tsconfig.no-dom.json",
+    "./bundler/no-dom/app": "./bundler/tsconfig.no-dom.json",
+    "./bundler/no-dom/library": "./bundler/tsconfig.no-dom.json",
+    "./bundler/vite": "./bundler/tsconfig.vite.json",
+    "./bundler/next": "./bundler/tsconfig.next.json"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.5"
+  }
+}

package/tsc/dom/tsconfig.app.json

@@ -0,0 +1,36 @@
+{
+	"compilerOptions": {
+		/* Base Options: */
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"resolveJsonModule": true,
+		"moduleDetection": "force",
+		"isolatedModules": true,
+		"verbatimModuleSyntax": true,
+		"useDefineForClassFields": true,
+
+		/* Don't allow importing JavaScript files by default, to avoid mistake "any" (burnt me before): */
+		"allowJs": false,
+
+		/* Linting: */
+		"strict": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noFallthroughCasesInSwitch": true,
+		"allowUnreachableCode": false,
+		"allowSyntheticDefaultImports": true,
+		"forceConsistentCasingInFileNames": true,
+		"noErrorTruncation": true,
+		"noUncheckedIndexedAccess": true,
+
+		/* If transpiling with TypeScript: */
+		"module": "NodeNext",
+		"sourceMap": true,
+		"target": "ES2022",
+		"outDir": "dist",
+
+		/* If your code runs in the DOM: */
+		"lib": ["ES2022", "DOM", "DOM.Iterable"]
+	}
+}

package/tsc/dom/tsconfig.lib.json

@@ -0,0 +1,39 @@
+{
+	"compilerOptions": {
+		/* Base Options: */
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"resolveJsonModule": true,
+		"moduleDetection": "force",
+		"isolatedModules": true,
+		"verbatimModuleSyntax": true,
+		"useDefineForClassFields": true,
+
+		/* Don't allow importing JavaScript files by default, to avoid mistake "any" (burnt me before): */
+		"allowJs": false,
+
+		/* Linting: */
+		"strict": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noFallthroughCasesInSwitch": true,
+		"allowUnreachableCode": false,
+		"allowSyntheticDefaultImports": true,
+		"forceConsistentCasingInFileNames": true,
+		"noErrorTruncation": true,
+		"noUncheckedIndexedAccess": true,
+
+		/* If transpiling with TypeScript: */
+		"module": "NodeNext",
+		"sourceMap": true,
+		"target": "ES2022",
+		"outDir": "dist",
+
+		/* If you're building for a library: */
+		"declaration": true,
+
+		/* If your code runs in the DOM: */
+		"lib": ["ES2022", "DOM", "DOM.Iterable"]
+	}
+}

package/tsc/no-dom/tsconfig.app.json

@@ -0,0 +1,36 @@
+{
+	"compilerOptions": {
+		/* Base Options: */
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"resolveJsonModule": true,
+		"moduleDetection": "force",
+		"isolatedModules": true,
+		"verbatimModuleSyntax": true,
+		"useDefineForClassFields": true,
+
+		/* Don't allow importing JavaScript files by default, to avoid mistake "any" (burnt me before): */
+		"allowJs": false,
+
+		/* Linting: */
+		"strict": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noFallthroughCasesInSwitch": true,
+		"allowUnreachableCode": false,
+		"allowSyntheticDefaultImports": true,
+		"forceConsistentCasingInFileNames": true,
+		"noErrorTruncation": true,
+		"noUncheckedIndexedAccess": true,
+
+		/* If transpiling with TypeScript: */
+		"module": "NodeNext",
+		"sourceMap": true,
+		"target": "ES2022",
+		"outDir": "dist",
+
+		/* If your code doesn't run in the DOM: */
+		"lib": ["ES2022"]
+	}
+}

package/tsc/no-dom/tsconfig.lib.json

@@ -0,0 +1,39 @@
+{
+	"compilerOptions": {
+		/* Base Options: */
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"resolveJsonModule": true,
+		"moduleDetection": "force",
+		"isolatedModules": true,
+		"verbatimModuleSyntax": true,
+		"useDefineForClassFields": true,
+
+		/* Don't allow importing JavaScript files by default, to avoid mistake "any" (burnt me before): */
+		"allowJs": false,
+
+		/* Linting: */
+		"strict": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noFallthroughCasesInSwitch": true,
+		"allowUnreachableCode": false,
+		"allowSyntheticDefaultImports": true,
+		"forceConsistentCasingInFileNames": true,
+		"noErrorTruncation": true,
+		"noUncheckedIndexedAccess": true,
+
+		/* If transpiling with TypeScript: */
+		"module": "NodeNext",
+		"sourceMap": true,
+		"target": "ES2022",
+		"outDir": "dist",
+
+		/* If you're building for a library: */
+		"declaration": true,
+
+		/* If your code doesn't run in the DOM: */
+		"lib": ["ES2022"]
+	}
+}