ts-package-init 0.1.0

package/README.md

@@ -0,0 +1,147 @@
+# ts-package-init
+
+A fast, minimal, and modern TypeScript project initializer.
+
+Create a TypeScript project with sensible defaults in seconds — no frameworks, no boilerplate overload.
+
+---
+
+## ✨ Features
+
+- Zero-config TypeScript setup
+- Presets: `base`, `library`, `backend`, `cli`
+- CommonJS or ESM (`--esm`)
+- Optional ESLint & Prettier
+- Uses `tsx` for fast dev experience
+- Works with Node.js 18+
+
+---
+
+## 🚀 Usage
+
+### Quick start
+
+```bash
+npx ts-package-init my-app
+cd my-app
+npm run dev
+```
+
+### Using npm init
+
+```bash
+npm init ts-package my-app
+```
+
+---
+
+## 📦 Presets
+
+### Base (default)
+
+Minimal runnable TypeScript project.
+
+```bash
+npx ts-package-init my-app
+```
+
+Scripts:
+```json
+{
+  "build": "tsc",
+  "dev": "tsx watch src/index.ts"
+}
+```
+
+---
+
+### Library
+
+For reusable npm packages.
+
+```bash
+npx ts-package-init my-lib --preset library
+```
+
+Includes:
+- type declarations
+- clean build output
+
+---
+
+### Backend
+
+For APIs, workers, and services.
+
+```bash
+npx ts-package-init api --preset backend
+```
+
+Includes:
+- `dev`, `build`, `start` scripts
+- long-running process defaults
+
+---
+
+### CLI
+
+For command-line tools.
+
+```bash
+npx ts-package-init my-cli --preset cli
+```
+
+Includes:
+- executable binary
+- Node shebang support
+
+---
+
+## 📘 ESM Support
+
+Enable ESM with:
+
+```bash
+npx ts-package-init my-app --esm
+```
+
+This will:
+- set `"type": "module"`
+- adjust TypeScript config automatically
+
+---
+
+## 🧹 ESLint & Prettier (optional)
+
+```bash
+npx ts-package-init my-app --eslint
+npx ts-package-init my-app --prettier
+```
+
+Prettier automatically enables ESLint integration.
+
+---
+
+## 🧪 Examples
+
+```bash
+npx ts-package-init demo
+npx ts-package-init my-lib --preset library --esm
+npx ts-package-init api --preset backend --eslint --prettier
+npx ts-package-init tool --preset cli
+```
+
+---
+
+## 🛣 Roadmap
+
+- Preset-aware ESLint rules
+- Interactive mode
+- Monorepo preset
+- Framework presets (NestJS, Moleculer)
+
+---
+
+## 📄 License
+
+MIT

package/dist/cli.js

@@ -0,0 +1,149 @@
+#!/usr/bin/env node
+import path from "node:path";
+import fs from "fs-extra";
+import minimist from "minimist";
+import { execa } from "execa";
+import { fileURLToPath } from "node:url";
+const VALID_PRESETS = ["base", "cli", "library", "backend"];
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+function die(msg) {
+    console.error(`❌ ${msg}`);
+    process.exit(1);
+}
+async function run(cmd, args, cwd) {
+    try {
+        await execa(cmd, args, { cwd, stdio: "inherit" });
+    }
+    catch (error) {
+        die(error?.message);
+    }
+}
+function getTemplateDir(preset) {
+    return path.resolve(__dirname, `../templates/${preset}`);
+}
+async function patchTsConfig(targetDir, isESM) {
+    const tsConfigPath = path.join(targetDir, "tsconfig.json");
+    const tsconfig = await fs.readJson(tsConfigPath);
+    if (isESM) {
+        tsconfig.compilerOptions.module = "ES2022";
+        tsconfig.compilerOptions.moduleResolution = "Bundler";
+    }
+    await fs.writeJson(tsConfigPath, tsconfig, { spaces: 2 });
+}
+function getEslintTemplate(withPrettier) {
+    return withPrettier
+        ? "eslint.prettier.config.js"
+        : "eslint.config.js";
+}
+async function copyEslintConfig(targetDir, withPrettier) {
+    const filename = getEslintTemplate(withPrettier);
+    await fs.copy(path.resolve(__dirname, `../templates/eslint/${filename}`), path.join(targetDir, "eslint.config.js"));
+}
+async function copyPrettierConfig(targetDir) {
+    await fs.copy(path.resolve(__dirname, "../templates/eslint/.prettierrc.json"), path.join(targetDir, ".prettierrc.json"));
+}
+async function main() {
+    const args = minimist(process.argv.slice(2), {
+        default: {
+            preset: "base",
+            esm: false,
+            eslint: false,
+            prettier: false
+        },
+    });
+    const name = args._[0];
+    const preset = args.preset;
+    const isESM = Boolean(args.esm);
+    const useEslint = Boolean(args.eslint);
+    const usePrettier = Boolean(args.prettier);
+    const enableEslint = useEslint || usePrettier;
+    const enablePrettier = usePrettier;
+    const options = {
+        yes: args.yes,
+    };
+    if (!name)
+        die("Please provide a package name");
+    // Check valid preset
+    if (!VALID_PRESETS.includes(preset))
+        die(`Invalid preset: ${preset}`);
+    const targetDir = path.join(process.cwd(), name);
+    if (await fs.pathExists(targetDir))
+        die("A directory already exists");
+    // 1) create directory
+    await fs.mkdirp(targetDir);
+    // 2) copy base template
+    const templateDir = getTemplateDir(preset);
+    if (!await fs.pathExists(templateDir))
+        die(`Template not found for preset: ${preset}`);
+    await fs.copy(templateDir, targetDir);
+    await patchTsConfig(targetDir, isESM);
+    if (enableEslint) {
+        await copyEslintConfig(targetDir, enablePrettier);
+    }
+    if (enablePrettier) {
+        await copyPrettierConfig(targetDir);
+    }
+    // 3) npm init -y
+    await run("npm", ["init", "-y"], targetDir);
+    // 4) install deps
+    await run("npm", ["i", "-D", "typescript", "ts-node", "@types/node"], targetDir);
+    if (enableEslint) {
+        await run("npm", [
+            "i",
+            "-D",
+            "eslint",
+            "@typescript-eslint/parser",
+            "@typescript-eslint/eslint-plugin"
+        ], targetDir);
+    }
+    if (enablePrettier) {
+        await run("npm", [
+            "i",
+            "-D",
+            "prettier",
+            "eslint-config-prettier"
+        ], targetDir);
+    }
+    // 5) patch package.json
+    const pkgPath = path.join(targetDir, "package.json");
+    const pkg = await fs.readJson(pkgPath);
+    pkg.scripts = pkg.scripts || {};
+    if (isESM) {
+        pkg.type = "module";
+    }
+    switch (preset) {
+        case "base":
+            pkg.scripts.build = "tsc";
+            pkg.scripts.dev = "tsx watch src/index.ts";
+            break;
+        case "library":
+            pkg.main = "dist/index.js";
+            pkg.types = "dist/index.d.ts";
+            pkg.scripts.build = "tsc";
+            break;
+        case "backend":
+            pkg.scripts.build = "tsc";
+            pkg.scripts.dev = "tsx watch src/index.ts";
+            pkg.scripts.start = "node dist/index.js";
+            break;
+        case "cli":
+            pkg.bin = {
+                ...(pkg.bin || {}),
+                [name]: "dist/index.js"
+            };
+            pkg.scripts.build = "tsc";
+            break;
+    }
+    if (enableEslint) {
+        pkg.scripts.lint = "eslint .";
+    }
+    if (enablePrettier) {
+        pkg.scripts.format = "prettier --write .";
+    }
+    await fs.writeJson(pkgPath, pkg, { spaces: 2 });
+    console.log("\n✅ Done!");
+    console.log(`👉 cd ${name}`);
+    console.log("👉 npm run build");
+}
+main().catch((e) => die(e?.message || String(e)));

package/dist/index.js

@@ -0,0 +1,4 @@
+// Entry point for your TypeScript package
+export function hello(name) {
+    return `Hello, ${name}!`;
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "ts-package-init",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Fast, minimal, and modern TypeScript project initializer",
+  "author": "Mostafa Hanafy",
+  "license": "MIT",
+  "bin": {
+    "ts-package-init": "dist/cli.js"
+  },
+  "scripts": {
+    "dev": "tsx ./src/cli.ts",
+    "build": "tsc -p tsconfig.json"
+  },
+  "keywords": [
+    "typescript",
+    "cli",
+    "scaffold",
+    "generator",
+    "init",
+    "create-ts",
+    "typescript-cli"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mostafasayed/ts-package-init"
+  },
+  "homepage": "https://github.com/mostafasayed/ts-package-init",
+  "dependencies": {
+    "execa": "^9.6.1",
+    "fs-extra": "^11.3.3",
+    "minimist": "^1.2.8"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/minimist": "^1.2.5",
+    "@types/node": "^25.0.5",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}

package/templates/backend/src/index.ts

@@ -0,0 +1 @@
+console.log("Backend service started");

package/templates/backend/tsconfig.json

@@ -0,0 +1,10 @@
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        "module": "CommonJS",
+        "rootDir": "src",
+        "outDir": "dist",
+        "strict": true,
+        "esModuleInterop": true
+    }
+}

package/templates/base/src/index.ts

@@ -0,0 +1,3 @@
+export function hello(name: string) {
+    console.log(`Hello, ${name}`);
+}

package/templates/base/tsconfig.json

@@ -0,0 +1,12 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "module": "CommonJS",
+        "rootDir": "src",
+        "outDir": "dist",
+        "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true
+    }
+}

package/templates/cli/src/index.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+console.log("CLI tool running");

package/templates/cli/tsconfig.json

@@ -0,0 +1,10 @@
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        "module": "CommonJS",
+        "rootDir": "src",
+        "outDir": "dist",
+        "strict": true,
+        "esModuleInterop": true
+    }
+}

package/templates/eslint/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "printWidth": 100
+}

package/templates/eslint/eslint.config.js

@@ -0,0 +1,12 @@
+import js from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default [
+    js.configs.recommended,
+    ...tseslint.configs.recommended,
+    {
+        rules: {
+            "no-console": "off"
+        }
+    }
+];

package/templates/eslint/eslint.prettier.config.js

@@ -0,0 +1,14 @@
+import js from "@eslint/js";
+import tseslint from "typescript-eslint";
+import prettier from "eslint-config-prettier";
+
+export default [
+    js.configs.recommended,
+    ...tseslint.configs.recommended,
+    prettier,
+    {
+        rules: {
+            "no-console": "off"
+        }
+    }
+];

package/templates/library/src/index.ts

@@ -0,0 +1,3 @@
+export function hello() {
+    return "Hello from library";
+}

package/templates/library/tsconfig.json

@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "module": "CommonJS",
+        "rootDir": "src",
+        "outDir": "dist",
+        "declaration": true,
+        "strict": true,
+        "esModuleInterop": true
+    }
+}