@code-essentials/tsconfig 1.2.1 → 1.2.3

package/README.md

@@ -2,6 +2,15 @@
 
 ## Install
 
+Automatic
+
+```bash
+pnpm i -d @code-essentials/tsconfig
+pnpm dlx setup-tsconfig
+```
+
+Manual install
+
 ```bash
 pnpm i -d @code-essentials/tsconfig
 cp -r node_modules/@code-essentials/tsconfig/template/* .
@@ -11,6 +20,18 @@ cp -r node_modules/@code-essentials/tsconfig/template/* .
 
 2. Copy [tsconfig.json.template](./tsconfig.json.template), [tsconfig.prod.json.template](./tsconfig.prod.json.template), and [tsconfig.debug.json.template](./tsconfig.debug.json.template) into project root, removing `.template`.
 
+3. Write the following scripts in your `package.json`
+
+```json
+{
+    "clean": "rm -rf dist",
+    "prebuild": "pnpm run clean",
+    "prebuild:debug": "pnpm run clean",
+    "build": "tsc -p tsconfig.prod.json",
+    "build:debug": "tsc -p tsconfig.debug.json",
+}
+```
+
 ## License
 
 MIT

package/cli/setup.js

@@ -0,0 +1,77 @@
+#!/usr/bin/env node
+
+import { fileURLToPath } from 'url';
+import path from 'path';
+import fs from 'fs/promises';
+import { constants } from 'fs';
+
+// --- Configuration ---
+// Assuming this script is located at 'cli/setup.js'
+const SCRIPT_PATH = fileURLToPath(import.meta.url);
+const SCRIPT_DIR = path.dirname(SCRIPT_PATH);
+
+// Source directory is two levels up from the script location, then into 'template'
+const SOURCE_DIR = path.resolve(SCRIPT_DIR, '..', 'template');
+
+// Destination is the user's current working directory (project root)
+const DEST_DIR = process.cwd();
+// ---------------------
+
+/**
+ * Recursively copies a directory's contents from source to destination.
+ * @param {string} src The source directory path.
+ * @param {string} dest The destination directory path.
+ */
+async function copyDir(src, dest) {
+    try {
+        // 1. Create the destination directory if it doesn't exist
+        await fs.mkdir(dest, { recursive: true });
+
+        // 2. Read the contents of the source directory
+        const entries = await fs.readdir(src, { withFileTypes: true });
+
+        // 3. Process each entry
+        for (const entry of entries) {
+            const srcPath = path.join(src, entry.name);
+            const destPath = path.join(dest, entry.name);
+
+            if (entry.isDirectory()) {
+                // If it's a directory, recurse
+                await copyDir(srcPath, destPath);
+            } else if (entry.isFile()) {
+                // If it's a file, copy it.
+                // COPYFILE_EXCL ensures we do not overwrite existing files,
+                // which is often desired for config templates.
+                await fs.copyFile(srcPath, destPath, constants.COPYFILE_EXCL);
+                console.log(`- Created ${path.relative(DEST_DIR, destPath)}`);
+            }
+            // Ignore symbolic links and other types
+        }
+    } catch (err) {
+        // If a file already exists due to COPYFILE_EXCL, skip it and continue.
+        // Otherwise, throw the error.
+        if (err.code === 'EEXIST') {
+             // Inform the user that a file was skipped
+             console.log(`- Skipped ${path.relative(DEST_DIR, dest)} (File already exists)`);
+        } else {
+            throw err;
+        }
+    }
+}
+
+async function main() {
+    console.log(`🚀 Starting TSConfig setup in: ${DEST_DIR}`);
+    console.log(`Source template: ${SOURCE_DIR}`);
+
+    try {
+        await copyDir(SOURCE_DIR, DEST_DIR);
+        console.log('\n✅ **Setup Complete!** TSConfig template files have been copied.');
+        console.log('   Note: Existing files were skipped to prevent accidental overwrites.');
+    } catch (error) {
+        console.error('\n❌ **Setup Failed!**');
+        console.error('An unexpected error occurred during file copying:', error.message);
+        process.exit(1);
+    }
+}
+
+main();

package/package.json

@@ -1,12 +1,22 @@
 {
   "name": "@code-essentials/tsconfig",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "",
   "type": "module",
+  "files": [
+    "template",
+    "cli/setup.js"
+  ],
+  "bin": {
+    "setup-tsconfig": "cli/setup.js"
+  },
   "peerDependencies": {
-    "@tsconfig/node24": "^24.0.1",
+    "@tsconfig/node24": "^24.10.0",
     "@tsconfig/strictest": "^2.0.5"
   },
+  "devDependencies": {
+    "@types/node": "^24.10.1"
+  },
   "keywords": [],
   "author": {
     "name": "Isaac Valdez",
@@ -14,6 +24,10 @@
     "url": "https://i12345.github.io"
   },
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/code-essentials/tsconfig.git"
+  },
   "scripts": {
     "build": "",
     "test": ""

package/tsconfig.debug.json

@@ -1,9 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "sourceMap": true,
-        "rootDir": ".",
-        "lib": ["ESNext", "Decorators", "DOM"]
-    },
-    "exclude": ["node_modules"]
-}

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-    "extends": [
-        "@tsconfig/node24/tsconfig.json",
-        "@tsconfig/strictest/tsconfig.json",
-    ],
-    "compilerOptions": {
-        "declaration": true,
-        "rootDir": ".",
-        "lib": ["ESNext", "Decorators", "DOM"],
-        "moduleResolution": "nodenext",
-    },
-    "exclude": ["node_modules"]
-}

package/tsconfig.prod.json

@@ -1,10 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "sourceMap": false,
-        "rootDir": "src",
-        // remove DOM
-        "lib": ["ESNext", "Decorators"],
-    },
-    "exclude": ["node_modules", "test"]
-}