express-scaffolding-typescript 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Qiuyi Hong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/bin/cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import "../lib/cli.js";

package/lib/cli.js

@@ -0,0 +1,35 @@
+import { resolve } from "node:path";
+import expressGenTs from "./express-scaffolding-typescript.js";
+
+/******************************************************************************
+                                 Run
+******************************************************************************/
+
+// Init
+console.log("Setting up new Express/TypeScript project...");
+const args = process.argv.slice(2);
+
+// Setup use yarn
+let useYarn = false;
+const useYarnIdx = args.indexOf("--use-yarn");
+if (useYarnIdx > -1) {
+  useYarn = true;
+  args.splice(useYarnIdx, 1);
+}
+
+// Setup destination
+let destination = "express-scaffolding-ts";
+if (args.length > 0) {
+  destination = args[0];
+}
+destination = resolve(process.cwd(), destination);
+
+// Creating new project finished
+expressGenTs(destination, useYarn)
+  .then(() => {
+    console.log("Project setup complete!");
+  })
+  .catch((err) => {
+    console.error(err);
+    process.exitCode = 1;
+  });

package/lib/express-scaffolding-typescript.js

@@ -0,0 +1,125 @@
+import { existsSync } from "node:fs";
+import { rename } from "node:fs/promises";
+import { execSync } from "node:child_process";
+import { basename, dirname, join, relative } from "node:path";
+import { fileURLToPath } from "node:url";
+import editJsonFile from "edit-json-file";
+import ncpPackage from "ncp";
+
+/******************************************************************************
+                                 Constants
+******************************************************************************/
+
+const MODULE_DIR = dirname(fileURLToPath(import.meta.url));
+const PROJECT_FOLDER_PATH = join(MODULE_DIR, "projectFolder");
+const { ncp } = ncpPackage;
+const EXCLUDED_TEMPLATE_ENTRIES = new Set([
+  ".npmignore",
+  "node_modules",
+  "package-lock.json",
+]);
+
+const DEPENDENCIES = ["body-parser", "dotenv", "express", "path", "uuid"];
+
+const DEV_DEPENDENCIES = [
+  "@eslint/js",
+  "@types/express",
+  "@types/node",
+  "eslint",
+  "eslint-config-prettier",
+  "eslint-plugin-prettier",
+  "globals",
+  "jiti",
+  "prettier",
+  "tsx",
+  "typescript",
+  "typescript-eslint",
+];
+
+// "ncp" options
+const ncpOpts = {
+  filter: (fileName) => {
+    return !relative(PROJECT_FOLDER_PATH, fileName)
+      .split(/[\\/]/)
+      .some((entry) => EXCLUDED_TEMPLATE_ENTRIES.has(entry));
+  },
+};
+
+/******************************************************************************
+                                 Functions
+******************************************************************************/
+
+/**
+ * Entry point
+ */
+async function expressGenTs(destination, useYarn) {
+  await copyProjectFiles(destination);
+  updatePackageJson(destination);
+  await renameGitignoreFile(destination);
+  downloadNodeModules(destination, useYarn);
+}
+
+/**
+ * Copy project files
+ */
+function copyProjectFiles(destination) {
+  const source = PROJECT_FOLDER_PATH;
+  return /** @type {Promise<void>} */ (
+    new Promise((res, rej) => {
+      return ncp(source, destination, ncpOpts, (err) => {
+        return err ? rej(err) : res();
+      });
+    })
+  );
+}
+
+/**
+ * Set update the package.json file.
+ */
+function updatePackageJson(destination) {
+  let file = editJsonFile(destination + "/package.json", {
+    autosave: true,
+  });
+  file.set("name", basename(destination));
+  file.set("dependencies", {});
+  file.set("devDependencies", {});
+}
+
+/**
+ * Because npm does not allow .gitignore to be published.
+ */
+async function renameGitignoreFile(destination) {
+  const source = join(destination, "gitignore");
+  if (!existsSync(source)) {
+    return;
+  }
+  await rename(source, join(destination, ".gitignore"));
+}
+
+/**
+ * Download the dependencies.
+ */
+function downloadNodeModules(destination, useYarn) {
+  const options = { cwd: destination };
+  // Setup dependencies string
+  let depStr = DEPENDENCIES.join(" "),
+    devDepStr = DEV_DEPENDENCIES.join(" ");
+  // Setup download command
+  let downloadLibCmd, downloadDepCmd;
+  if (useYarn) {
+    downloadLibCmd = "yarn add " + depStr;
+    downloadDepCmd = "yarn add " + devDepStr + " -D";
+  } else {
+    downloadLibCmd = "npm i -s " + depStr;
+    downloadDepCmd = "npm i -D " + devDepStr;
+  }
+  // Execute command
+  execSync(downloadLibCmd, options);
+  execSync(downloadDepCmd, options);
+}
+
+/******************************************************************************
+                                Export
+******************************************************************************/
+
+export default expressGenTs;

package/lib/projectFolder/.env

@@ -0,0 +1,2 @@
+PORT=3000
+NODE_ENV=development

package/lib/projectFolder/eslint.config.mjs

@@ -0,0 +1,24 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import { defineConfig, globalIgnores } from "eslint/config";
+import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
+
+export default defineConfig([
+  globalIgnores(["dist"]),
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+    plugins: { js },
+    extends: [
+      js.configs.recommended,
+      tseslint.configs.recommended,
+      eslintPluginPrettierRecommended,
+    ],
+    languageOptions: { globals: { ...globals.browser, ...globals.node } },
+    rules: {
+      "prettier/prettier": "warn",
+      "no-unused-vars": "warn",
+      "@typescript-eslint/no-unused-vars": "warn",
+    },
+  },
+]);

package/lib/projectFolder/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "Express.js project",
+  "version": "1.0.0",
+  "description": "",
+  "license": "ISC",
+  "author": "Qiuyi Hong",
+  "type": "module",
+  "main": "server.ts",
+  "scripts": {
+    "dev": "tsx --watch src/server.ts",
+    "start": "node dist/server.js",
+    "build": "tsc",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/express": "^5.0.6",
+    "@types/node": "^26.0.1",
+    "eslint": "^10.6.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.6",
+    "globals": "^17.7.0",
+    "jiti": "^2.7.0",
+    "prettier": "3.9.4",
+    "tsx": "^4.22.4",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.62.1"
+  },
+  "dependencies": {
+    "body-parser": "^2.3.0",
+    "dotenv": "^17.4.2",
+    "express": "^5.2.1",
+    "path": "^0.12.7",
+    "uuid": "^14.0.1"
+  }
+}

package/lib/projectFolder/src/app.ts

@@ -0,0 +1,30 @@
+import express from "express";
+import itemRoutes from "./routes/itemRoutes.ts";
+import { errorHandler } from "./middlewares/errorHandler.ts";
+import bodyParser from "body-parser";
+
+const app = express();
+
+app.use(bodyParser.json());
+app.use(express.static("public"));
+
+app.use((req, res, next) => {
+  res.setHeader("Access-Control-Allow-Origin", "*");
+  res.setHeader(
+    "Access-Control-Allow-Methods",
+    "GET, POST, PUT, DELETE, OPTIONS",
+  );
+  res.setHeader(
+    "Access-Control-Allow-Headers",
+    "X-Requested-With,content-type",
+  );
+  next();
+});
+
+// Routes
+app.use("/items", itemRoutes);
+
+// Global error handler (should be after routes)
+app.use(errorHandler);
+
+export default app;

package/lib/projectFolder/src/config/config.ts

@@ -0,0 +1,15 @@
+import dotenv from "dotenv";
+
+dotenv.config();
+
+interface Config {
+  port: number;
+  nodeEnv: string;
+}
+
+const config: Config = {
+  port: Number(process.env.PORT) || 3000,
+  nodeEnv: process.env.NODE_ENV || "development",
+};
+
+export default config;

package/lib/projectFolder/src/controllers/itemController.ts

@@ -0,0 +1,78 @@
+import type { Request, Response, NextFunction } from "express";
+import { items, type Item } from "../models/item.ts";
+import { v4 as uuidv4 } from "uuid";
+
+// Create an item
+export const createItem = (req: Request, res: Response, next: NextFunction) => {
+  try {
+    const { name } = req.body;
+    const newItem: Item = { id: uuidv4(), name };
+    items.push(newItem);
+    res.status(201).json(newItem);
+  } catch (error) {
+    next(error);
+  }
+};
+
+// Read all items
+export const getItems = (req: Request, res: Response, next: NextFunction) => {
+  try {
+    res.json(items);
+  } catch (error) {
+    next(error);
+  }
+};
+
+// Read single item
+export const getItemById = (
+  req: Request,
+  res: Response,
+  next: NextFunction,
+) => {
+  try {
+    const id = req.params.id as string;
+    const item = items.find((i) => i.id === id);
+    if (!item) {
+      res.status(404).json({ message: "Item not found" });
+      return;
+    }
+    res.json(item);
+  } catch (error) {
+    next(error);
+  }
+};
+
+// Update an item
+export const updateItem = (req: Request, res: Response, next: NextFunction) => {
+  try {
+    const id = req.params.id as string;
+    const { name } = req.body;
+    const itemIndex = items.findIndex((i) => i.id === id);
+    if (itemIndex === -1) {
+      res.status(404).json({ message: "Item not found" });
+      return;
+    }
+    if (name !== undefined) {
+      items[itemIndex]!.name = name;
+    }
+    res.json(items[itemIndex]);
+  } catch (error) {
+    next(error);
+  }
+};
+
+// Delete an item
+export const deleteItem = (req: Request, res: Response, next: NextFunction) => {
+  try {
+    const id = req.params.id as string;
+    const itemIndex = items.findIndex((i) => i.id === id);
+    if (itemIndex === -1) {
+      res.status(404).json({ message: "Item not found" });
+      return;
+    }
+    const deletedItem = items.splice(itemIndex, 1)[0];
+    res.json(deletedItem);
+  } catch (error) {
+    next(error);
+  }
+};

package/lib/projectFolder/src/middlewares/errorHandler.ts

@@ -0,0 +1,18 @@
+import type { Request, Response, NextFunction } from "express";
+
+export interface AppError extends Error {
+  status?: number;
+}
+
+export const errorHandler = (
+  err: AppError,
+  req: Request,
+  res: Response,
+  next: NextFunction,
+) => {
+  void next;
+  console.error(err);
+  res.status(err.status || 500).json({
+    message: err.message || "Internal Server Error",
+  });
+};

package/lib/projectFolder/src/models/item.ts

@@ -0,0 +1,6 @@
+export interface Item {
+  id: string;
+  name: string;
+}
+
+export const items: Item[] = [];

package/lib/projectFolder/src/routes/itemRoutes.ts

@@ -0,0 +1,18 @@
+import { Router } from "express";
+import {
+  createItem,
+  getItems,
+  getItemById,
+  updateItem,
+  deleteItem,
+} from "../controllers/itemController.ts";
+
+const router = Router();
+
+router.get("/", getItems);
+router.get("/:id", getItemById);
+router.post("/", createItem);
+router.put("/:id", updateItem);
+router.delete("/:id", deleteItem);
+
+export default router;

package/lib/projectFolder/src/server.ts

@@ -0,0 +1,6 @@
+import app from "./app.ts";
+import config from "./config/config.ts";
+
+app.listen(config.port, () => {
+  console.log(`Server running on port ${config.port}`);
+});

package/lib/projectFolder/tsconfig.json

@@ -0,0 +1,51 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    "rootDir": "./src",
+    "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    // "types": [],
+    // For nodejs:
+    "lib": ["esnext"],
+    "types": ["node"],
+    // and npm install -D @types/node
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+
+    // Additional Options
+    "esModuleInterop": true,
+    "allowImportingTsExtensions": true,
+    "noEmit": true
+  }
+  // "include": ["src"],
+  // "exclude": ["dist"]
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "express-scaffolding-typescript",
+  "version": "1.0.0",
+  "description": "Scaffold new Express.js application with TypeScript",
+  "keywords": [
+    "express"
+  ],
+  "license": "MIT",
+  "author": "Qiuyi Hong",
+  "type": "module",
+  "main": "lib/express-scaffolding-typescript.js",
+  "bin": {
+    "express-scaffolding-typescript": "bin/cli.js"
+  },
+  "files": [
+    "bin",
+    "lib"
+  ],
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "start": "node bin/cli.js",
+    "lint": "eslint bin lib/*.js test eslint.config.mjs",
+    "test": "node --test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Qiuyi-Hong/express-scaffolding-typescript.git"
+  },
+  "homepage": "https://github.com/Qiuyi-Hong/express-scaffolding-typescript#readme",
+
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.6.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.6",
+    "globals": "^17.7.0",
+    "prettier": "3.9.4",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.62.1"
+  },
+  "dependencies": {
+    "edit-json-file": "^1.8.1",
+    "ncp": "^2.0.0"
+  }
+}