@adbayb/stack 0.0.0-next-d3d6a87 → 0.0.0-next-2ad39fd

package/config/typescript/README.md

@@ -1,4 +1,52 @@
+<br>
 <div align="center">
-	<h1>⚙️ ts-config</h1>
-	<strong>My opinionated TypeScript configuration preset</strong>
+    <h1>@adbayb/stack/typescript</h1>
+    <strong>My opinionated TypeScript configuration preset</strong>
 </div>
+<br>
+<br>
+
+## ✨ Features
+
+This package offers an opinionated but extensible **[TSConfigs](https://www.typescriptlang.org/tsconfig/)** to align TypeScript configurations across my projects.
+
+It allows to:
+
+-   Make collaboration across my projects effective (including onboarding with a consistent look and writing patterns).
+-   Include a minimum viable and required set of rules to foster maintainable, testable, secure, and green code over time.
+-   Accelerate development by reusing common configuration and convention defaults.
+
+<br />
+
+## 🚀 Quick Start
+
+### 1️⃣ Installation
+
+At the root level of your project, run the following command:
+
+```bash
+pnpm add @adbayb/stack --save-dev --workspace-root
+```
+
+### 2️⃣ Usage
+
+Edit the `tsconfig.json` file to include the following:
+
+```jsonc
+{
+	"$schema": "https://json.schemastore.org/tsconfig",
+	"extends": "@adbayb/stack/typescript",
+	"include": ["src"], // Depending on your project specificities
+	"exclude": ["node_modules", "dist"], // Depending on your project specificities
+}
+```
+
+The default configuration is versatile and suitable for all projects, whether back-end or front-end.
+
+However, certain configuration flavors are also available for tailoring project-specific needs, which require extending the base `@adbayb/stack/typescript` configuration:
+
+| Flavor                           | Description                                                   | Usage                                                                       |
+| -------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `@adbayb/stack/typescript/react` | React-based configurations to set up JSX and global DOM types | `"extends": ["@adbayb/stack/typescript", "@adbayb/stack/typescript/react"]` |
+
+<br />

package/config/typescript/base.json

@@ -0,0 +1,28 @@
+{
+	"$schema": "http://json.schemastore.org/tsconfig.json",
+	"compilerOptions": {
+		"allowArbitraryExtensions": true,
+		"allowImportingTsExtensions": false,
+		"allowJs": false,
+		"allowUnreachableCode": false,
+		"allowUnusedLabels": false,
+		"checkJs": false,
+		"composite": true,
+		"exactOptionalPropertyTypes": true,
+		"lib": ["ESNext"],
+		"module": "Preserve",
+		"noEmit": true,
+		"noErrorTruncation": true,
+		"noFallthroughCasesInSwitch": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noUncheckedIndexedAccess": true,
+		"noUncheckedSideEffectImports": true,
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"skipLibCheck": true,
+		"strict": true,
+		"target": "ESNext",
+		"verbatimModuleSyntax": true
+	}
+}

package/config/typescript/react.json

@@ -0,0 +1,13 @@
+{
+	"$schema": "http://json.schemastore.org/tsconfig.json",
+	"compilerOptions": {
+		"lib": [
+			"ESNext",
+			"DOM",
+			"DOM.AsyncIterable",
+			"DOM.Iterable",
+			"WebWorker.ImportScripts"
+		],
+		"jsx": "react-jsx"
+	}
+}

package/dist/index.mjs

@@ -327,7 +327,7 @@ const PRESERVE_FILES = [
 ];
 
 var name = "@adbayb/stack";
-var version = "0.0.0-next-d3d6a87";
+var version = "0.0.0-next-2ad39fd";
 var description = "My opinionated JavaScript-based toolchain";
 var publishConfig = {
 	access: "public"
@@ -349,7 +349,8 @@ var exports = {
 	},
 	"./eslint": "./config/eslint/index.mjs",
 	"./prettier": "./config/prettier/index.mjs",
-	"./typescript": "./config/typescript/index.json"
+	"./typescript": "./config/typescript/base.json",
+	"./typescript/react": "./config/typescript/react.json"
 };
 var scripts = {
 	prepublishOnly: "pnpm build",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adbayb/stack",
-  "version": "0.0.0-next-d3d6a87",
+  "version": "0.0.0-next-2ad39fd",
   "description": "My opinionated JavaScript-based toolchain",
   "publishConfig": {
     "access": "public"
@@ -22,7 +22,8 @@
     },
     "./eslint": "./config/eslint/index.mjs",
     "./prettier": "./config/prettier/index.mjs",
-    "./typescript": "./config/typescript/index.json"
+    "./typescript": "./config/typescript/base.json",
+    "./typescript/react": "./config/typescript/react.json"
   },
   "keywords": [
     "stack",

package/config/typescript/index.json

@@ -1,30 +0,0 @@
-{
-	"$schema": "http://json.schemastore.org/tsconfig.json",
-	"compilerOptions": {
-		"incremental": true,
-		"target": "ESNext",
-		"jsx": "react-jsx",
-		"experimentalDecorators": true,
-		"module": "ESNext",
-		"moduleResolution": "Bundler",
-		"resolveJsonModule": true,
-		"allowJs": false,
-		"checkJs": false,
-		"maxNodeModuleJsDepth": 1,
-		"declaration": true,
-		"removeComments": false,
-		"isolatedModules": true,
-		"allowSyntheticDefaultImports": true,
-		"esModuleInterop": true,
-		"forceConsistentCasingInFileNames": true,
-		"strict": true,
-		"noUnusedLocals": true,
-		"noUnusedParameters": true,
-		"exactOptionalPropertyTypes": true,
-		"noImplicitReturns": true,
-		"noFallthroughCasesInSwitch": true,
-		"noUncheckedIndexedAccess": true,
-		"noImplicitOverride": true,
-		"skipLibCheck": true
-	}
-}