express-generator-typescript 2.7.7 → 2.7.8

package/README-git

@@ -10,11 +10,11 @@
 
 # express-generator-typescript
 
-Production-ready Express application scaffolding with TypeScript baked in. Generate a modern API starter in seconds that follows the [TypeScript best practices](https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md) used to build this tool.
+Command line tool which generates production-ready express templates with TypeScript baked in. Spin up a web server in seconds that follows the [TypeScript best practices](https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md).
 
 ## Overview
 
-`express-generator-typescript` creates a new Express application similar to the classic `express-generator` package, but the generated project is fully wired for TypeScript from day one. You get strict typing, linting, hot reloading, production builds, testing utilities, and sane defaults that focus on APIs (no view engine or opinionated ORM). Path aliases are preconfigured through `tsconfig-paths` and `_moduleAliases`, so referencing modules stays clean even as the app grows.
+`express-generator-typescript` creates a new Express application similar to the classic `express-generator` package, but the generated project is fully wired for TypeScript. You get strict typing, linting, hot reloading, production builds, testing utilities, and sane defaults that focus on APIs (no view engine or opinionated ORM). Path aliases are preconfigured through `tsconfig-paths` and `_moduleAliases`, so referencing modules stays clean even as the app grows.
 
 ## Features
 
@@ -52,7 +52,6 @@ Use `--use-yarn` if you prefer Yarn over npm. If you omit the project name, the
 | ----------------- | --------------------------------------------------------------------------- |
 | `project name`    | Folder to create. Defaults to `express-gen-ts` if omitted.                  |
 | `--use-yarn`      | Installs dependencies with Yarn instead of npm.                             |
-| `--version`       | Prints the generator version.                                               |
 
 > The historical `--with-auth` switch was removed in v2.5+. For an auth-ready example see the [express-jsonwebtoken-demo](https://github.com/seanpmaxwell/express-jsonwebtoken-demo) project.
 

package/README.md

@@ -10,7 +10,7 @@
 
 # express-generator-typescript
 
-Production-ready Express application scaffolding with TypeScript baked in. Generate a modern API starter in seconds that follows the [TypeScript best practices](https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md) used to build this tool.
+Command line tool which generates production-ready express templates with TypeScript baked in. Spin up a web server in seconds that follows the [TypeScript best practices](https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md).
 
 
 ## Documenation

package/lib/express-generator-typescript.js

@@ -14,7 +14,7 @@ const PROJECT_FOLDER_PATH = './project-files';
 
 // Project-folder dependencies
 const DEPENDENCIES = 'express dotenv morgan cookie-parser jet-logger ' +
-  'module-alias helmet jsonfile inserturlparams jet-paths dayjs jet-env ' + 
+  'module-alias helmet jsonfile jet-paths dayjs jet-env ' + 
   'jet-validators',
   DEV_DEPENDENCIES = 'ts-node typescript nodemon find supertest vitest ' +
     '@types/node @types/find @types/morgan @types/cookie-parser ' +

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.7.7",
+  "version": "2.7.8",
   "description": "Generate new Express applications similar to express-generate which but sets it up to use TypeScript instead",
   "scripts": {
     "express-generator-typescript": "node bin/cli.js",

package/lib/project-files/README.md

@@ -1,65 +0,0 @@
-## About
-
-This project was created with [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript).
-
-**IMPORTANT** for demo purposes I had to disable `helmet` in production. In any real world app you should change these 3 lines of code in `src/server.ts`:
-```ts
-// eslint-disable-next-line n/no-process-env
-if (!process.env.DISABLE_HELMET) {
-  app.use(helmet());
-}
-```
-
-To just this:
-```ts
-app.use(helmet());
-```
-
-
-## Available Scripts
-
-### `npm run clean-install`
-
-Remove the existing `node_modules/` folder, `package-lock.json`, and reinstall all library modules.
-
-
-### `npm run dev` or `npm run dev:hot` (hot reloading)
-
-Run the server in development mode.<br/>
-
-**IMPORTANT** development mode uses `swc` for performance reasons which DOES NOT check for typescript errors. Run `npm run type-check` to check for type errors. NOTE: you should use your IDE to prevent most type errors.
-
-
-### `npm test` or `npm run test:hot` (hot reloading)
-
-Run all unit-tests.
-
-
-### `npm test -- "name of test file" (i.e. users).`
-
-Run a single unit-test.
-
-
-### `npm run lint`
-
-Check for linting errors.
-
-
-### `npm run build`
-
-Build the project for production.
-
-
-### `npm start`
-
-Run the production build (Must be built first).
-
-
-### `npm run type-check`
-
-Check for typescript errors.
-
-
-## Additional Notes
-
-- If `npm run dev` gives you issues with bcrypt on MacOS you may need to run: `npm rebuild bcrypt --build-from-source`. 

package/lib/project-files/config/.env.development

@@ -1,15 +0,0 @@
-## Environment ##
-NODE_ENV=development
-
-
-## Server ##
-PORT=3000
-HOST=localhost
-
-
-## Setup jet-logger ##
-JET_LOGGER_MODE=CONSOLE
-JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=TRUE
-JET_LOGGER_FORMAT=LINE
-

package/lib/project-files/config/.env.production

@@ -1,15 +0,0 @@
-## Environment ##
-NODE_ENV=production
-
-
-## Server ##
-PORT=8081
-HOST=localhost
-DISABLE_HELMET=TRUE
-
-
-## Setup jet-logger ##
-JET_LOGGER_MODE=FILE
-JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=TRUE
-JET_LOGGER_FORMAT=LINE

package/lib/project-files/config/.env.test

@@ -1,14 +0,0 @@
-## Environment ##
-NODE_ENV=test
-
-
-## Server ##
-PORT=4000
-HOST=localhost
-
-
-## Setup jet-logger ##
-JET_LOGGER_MODE=CONSOLE
-JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=TRUE
-JET_LOGGER_FORMAT=LINE

package/lib/project-files/config.ts

@@ -1,22 +0,0 @@
-/* eslint-disable n/no-process-env */
-
-import path from 'path';
-import dotenv from 'dotenv';
-import moduleAlias from 'module-alias';
-
-
-// Check the env
-const NODE_ENV = (process.env.NODE_ENV ?? 'development');
-
-// Configure "dotenv"
-const result2 = dotenv.config({
-  path: path.join(__dirname, `./config/.env.${NODE_ENV}`),
-});
-if (result2.error) {
-  throw result2.error;
-}
-
-// Configure moduleAlias
-if (__filename.endsWith('js')) {
-  moduleAlias.addAlias('@src', __dirname + '/dist');
-}

package/lib/project-files/eslint.config.ts

@@ -1,100 +0,0 @@
-import eslint from '@eslint/js';
-import tseslint from 'typescript-eslint';
-import stylistic from '@stylistic/eslint-plugin';
-import nodePlugin from 'eslint-plugin-n';
-import { defineConfig } from 'eslint/config';
-
-export default defineConfig(
-  eslint.configs.recommended,
-  nodePlugin.configs['flat/recommended-script'],
-  ...tseslint.configs.strictTypeChecked,
-  ...tseslint.configs.stylisticTypeChecked,
-  {
-    ignores: [
-      '**/node_modules/*',
-      '**/*.mjs',
-      '**/*.js',
-    ],
-  },
-  {
-    languageOptions: {
-      parserOptions: {
-        project: './tsconfig.json',
-        warnOnUnsupportedTypeScriptVersion: false,
-      },
-    },
-  },
-  {
-    plugins: {
-      '@stylistic': stylistic,
-    },
-  },
-  {
-    files: ['**/*.ts'],
-  },
-  {
-    rules: {
-      '@typescript-eslint/explicit-member-accessibility': 'warn',
-      '@typescript-eslint/no-misused-promises': 0,
-      '@typescript-eslint/no-floating-promises': 0,
-      '@typescript-eslint/no-confusing-void-expression': 0,
-      '@typescript-eslint/no-unnecessary-condition': 0,
-      '@typescript-eslint/restrict-template-expressions': [
-        'error', { allowNumber: true },
-      ],
-      '@typescript-eslint/restrict-plus-operands': [
-        'warn', { allowNumberAndString: true },
-      ],
-      '@typescript-eslint/no-unused-vars': [
-        'warn',
-        {
-          argsIgnorePattern: '^_',
-          varsIgnorePattern: '^_',
-        },
-      ],
-      '@typescript-eslint/no-unsafe-enum-comparison': 0,
-      '@typescript-eslint/no-unnecessary-type-parameters': 0,
-      '@stylistic/no-extra-semi': 'warn',
-      'max-len': [
-        'warn',
-        {
-          'code': 80,
-        },
-      ],
-      '@stylistic/semi': ['warn', 'always'],
-      '@stylistic/member-delimiter-style': ['warn', {
-        'multiline': {
-          'delimiter': 'comma',
-          'requireLast': true,
-        },
-        'singleline': {
-          'delimiter': 'comma',
-          'requireLast': false,
-        },
-        'overrides': {
-          'interface': {
-            'singleline': {
-              'delimiter': 'semi',
-              'requireLast': false,
-            },
-            'multiline': {
-              'delimiter': 'semi',
-              'requireLast': true,
-            },
-          },
-        },
-      }],
-      '@typescript-eslint/no-non-null-assertion': 0,
-      '@typescript-eslint/no-unused-expressions': 'warn',
-      'comma-dangle': ['warn', 'always-multiline'],
-      'no-console': 1,
-      'no-extra-boolean-cast': 0,
-      'indent': ['warn', 2],
-      'quotes': ['warn', 'single'],
-      'n/no-process-env': 1,
-      'n/no-missing-import': 0,
-      'n/no-unpublished-import': 0,
-      'prefer-const': 'warn',
-    },
-  },
-);

package/lib/project-files/gitignore

@@ -1,6 +0,0 @@
-**/node_modules
-dist/
-temp/
-**/**/*.log
-config.js
-tsconfig.tsbuildinfo

package/lib/project-files/package.json

@@ -1,57 +0,0 @@
-{
-  "name": "express-typescript-example",
-  "version": "0.0.0",
-  "scripts": {
-    "build": "ts-node ./scripts/build.ts",
-    "clean-install": "rm -rf ./node_modules && rm -r package-lock.json && npm i",
-    "dev": "NODE_ENV=development ts-node ./src",
-    "dev:hot": "nodemon --exec \"npm run dev\" --watch ./src --ext .ts",
-    "lint": "eslint .",
-    "start": "NODE_ENV=production node -r ./config.js ./dist",
-    "test": "NODE_ENV=test vitest",
-    "type-check": "tsc -b --noEmit"
-  },
-  "engines": {
-    "node": ">=16.0.0"
-  },
-  "dependencies": {
-    "cookie-parser": "^1.4.7",
-    "dayjs": "^1.11.13",
-    "dotenv": "^16.5.0",
-    "express": "^5.1.0",
-    "helmet": "^8.1.0",
-    "inserturlparams": "^2.0.5",
-    "jet-env": "^1.1.4",
-    "jet-logger": "^2.1.1",
-    "jet-paths": "^2.0.1",
-    "jet-validators": "^1.6.5",
-    "jsonfile": "^6.1.0",
-    "module-alias": "^2.2.3",
-    "morgan": "^1.10.0"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.25.1",
-    "@stylistic/eslint-plugin": "^5.5.0",
-    "@swc/core": "^1.11.22",
-    "@types/cookie-parser": "^1.4.8",
-    "@types/find": "^0.2.4",
-    "@types/fs-extra": "^11.0.4",
-    "@types/jsonfile": "^6.1.4",
-    "@types/module-alias": "^2.0.4",
-    "@types/morgan": "^1.9.9",
-    "@types/node": "^22.14.1",
-    "@types/supertest": "^6.0.3",
-    "eslint": "^9.25.1",
-    "eslint-plugin-n": "^17.17.0",
-    "find": "^0.3.0",
-    "fs-extra": "^11.3.0",
-    "jiti": "^2.4.2",
-    "nodemon": "^3.1.10",
-    "supertest": "^7.1.0",
-    "ts-node": "^10.9.2",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.32.0",
-    "vitest": "^3.1.2"
-  }
-}

package/lib/project-files/scripts/build.ts

@@ -1,28 +0,0 @@
-import logger from 'jet-logger';
-import { copy, copyFilesRec, exec, remove } from './common/utils';
-
-/******************************************************************************
-                                  Run
-******************************************************************************/
-
-/**
- * Start
- */
-(async () => {
-  try {
-    // Remove current build
-    await remove('./dist/');
-    await exec('npm run lint', '../');
-    await exec('tsc --project tsconfig.prod.json', '../');
-    // Copy
-    await copyFilesRec('./src', './dist', ['.ts']);
-    await copy('./temp/config.js', './config.js');
-    await copy('./temp/src', './dist');
-    await remove('./temp/');
-  } catch (err) {
-    logger.err(err);
-    // eslint-disable-next-line n/no-process-exit
-    process.exit(1);
-  }
-})();
-

package/lib/project-files/scripts/common/utils.ts

@@ -1,93 +0,0 @@
-import fs from 'fs-extra';
-import logger from 'jet-logger';
-import childProcess from 'child_process';
-import path from 'path';
-
-/******************************************************************************
-                                Functions
-*******************************************************************************
-
-/**
- * Copy file.
- */
-export function copy(src: string, dest: string): Promise<void> {
-  return new Promise((res, rej) => {
-    return fs.copy(src, dest, err => {
-      return (!!err ? rej(err) : res());
-    });
-  });
-}
-
-/**
- * Remove file
- */
-export function remove(loc: string): Promise<void> {
-  return new Promise((res, rej) => {
-    return fs.remove(loc, err => {
-      return (!!err ? rej(err) : res());
-    });
-  });
-}
-
-/**
- * Run command-line command.
- */
-export function exec(cmd: string, loc = './'): Promise<string> {
-  // Setup directory
-  const callingDir = path.dirname(require.main?.filename ?? './'),
-    cwd = path.join(callingDir, loc);
-  // Wrap in promise
-  return new Promise((res, rej) => 
-    childProcess.exec(cmd, { cwd }, (err, stdout, stderr) => {
-      if (!!stdout) {
-        logger.info(stdout);
-      }
-      if (!!stderr) {
-        logger.err(stderr);
-      }
-      if (!!err) {
-        return rej(err);
-      } else if (!!stderr) {
-        return rej(new Error(stderr));
-      } else {
-        return res(stdout);
-      }
-    }),
-  );
-}
-
-/**
- * Recursively search for a folder for all files and copy them to the new 
- * destination keeping their paths relative to the "src" param.
- * 
- * Example: 
- *  If file "./src/foo/bar.txt" exists then:
- *  copyFilesRec('./src', './dest') => ["./dest/foo/bar.txt"]
- * 
- * @param excludeExt Exlude a list of file extensions.
- */
-export async function copyFilesRec(
-  src: string,
-  dest: string, 
-  excludeExt?: string[],
-): Promise<void> {
-  const copyReqs: Promise<void>[] = [];
-  try {
-    const entries = await fs.readdir(src, { withFileTypes: true });
-    for (const entry of entries) {
-      const currPath = src + '/' + entry.name,
-        currDest = dest + '/' + entry.name,
-        ext = path.extname(entry.name);
-      if (entry.isFile() && !excludeExt?.includes(ext)) {
-        const req = fs.copy(currPath, currDest);
-        copyReqs.push(req);
-      } else if (entry.isDirectory()) {
-        const req = copyFilesRec(currPath, currDest, excludeExt);
-        copyReqs.push(req);
-      }
-    }
-  } catch (error) {
-    logger.err(`Error searching in ${src}: ` + String(error));
-  }
-  await Promise.all(copyReqs);
-}

package/lib/project-files/src/common/constants/ENV.ts

@@ -1,19 +0,0 @@
-import jetEnv, { num } from 'jet-env';
-import { isValueOf } from 'jet-validators';
-
-import { NODE_ENVS } from '.';
-
-/******************************************************************************
-                                 Setup
-******************************************************************************/
-
-const ENV = jetEnv({
-  NodeEnv: isValueOf(NODE_ENVS),
-  Port: num,
-});
-
-/******************************************************************************
-                            Export default
-******************************************************************************/
-
-export default ENV;

package/lib/project-files/src/common/constants/HTTP_STATUS_CODES.ts

@@ -1,81 +0,0 @@
-/* eslint-disable max-len */
-
-import { ValueOf } from 'jet-validators';
-
-
-/**
- * Hypertext Transfer Protocol (HTTP) response status codes.
- * @see {@link https://en.wikipedia.org/wiki/List_of_HTTP_status_codes}
- * 
- * This file was copied from here: https://gist.github.com/scokmen/f813c904ef79022e84ab2409574d1b45
- */
-const HTTP_STATUS_CODES = {
-  Continue: 100,
-  SwitchingProtocols: 101,
-  Processing: 102,
-  Ok: 200,
-  Created: 201,
-  Accepted: 202,
-  NonAuthoritativeInformation: 203,
-  NoContent: 204,
-  ResetContent: 205,
-  PartialContent: 206,
-  MultiStatus: 207,
-  AlreadyReported: 208,
-  ImUsed: 226,
-  MultipleChoices: 300,
-  MovedPermanently: 301,
-  Found: 302,
-  SeeOther: 303,
-  NotModified: 304,
-  UseProxy: 305,
-  SwitchProxy: 306,
-  TemporaryRedirect: 307,
-  PermanentRedirect: 308,
-  BadRequest: 400,
-  Unauthorized: 401,
-  PaymentRequired: 402,
-  Forbidden: 403,
-  NotFound: 404,
-  MethodNotAllowed: 405,
-  NotAcceptable: 406,
-  ProxyAuthenticationRequired: 407,
-  RequestTimeout: 408,
-  Conflict: 409,
-  Gone: 410,
-  LengthRequired: 411,
-  PreconditionFailed: 412,
-  PayloadTooLarge: 413,
-  UriTooLong: 414,
-  UnsupportedMediaType: 415,
-  RangeNotSatisfiable: 416,
-  ExpectationFailed: 417,
-  IamaTeapot: 418,
-  MisdirectedRequest: 421,
-  UnprocessableEntity: 422,
-  Locked: 423,
-  FailedDependency: 424,
-  UpgradeRequired: 426,
-  PreconditionRequired: 428,
-  TooManyRequests: 429,
-  RequestHeaderFieldsTooLarge: 431,
-  UnavailableForLegalReasons: 451,
-  InternalServerError: 500,
-  NotImplemented: 501,
-  BadGateway: 502,
-  ServiceUnavailable: 503,
-  GatewayTimeout: 504,
-  HttpVersionNotSupported: 505,
-  VariantAlsoNegotiates: 506,
-  InsuffientStorage: 507,
-  LoopDetected: 508,
-  NotExtended: 510,
-  NetworkAuthenticationRequired: 511,
-} as const;
-
-/******************************************************************************
-                            Export default
-******************************************************************************/
-
-export type HttpStatusCodes = ValueOf<typeof HTTP_STATUS_CODES>;
-export default HTTP_STATUS_CODES;

package/lib/project-files/src/common/constants/PATHS.ts

@@ -1,15 +0,0 @@
-import jetPaths from 'jet-paths';
-
-const PATHS = {
-  _: '/api',
-  Users: {
-    _: '/users',
-    Get: '/all',
-    Add: '/add',
-    Update: '/update',
-    Delete: '/delete/:id',
-  },
-} as const;
-
-export const JET_PATHS = jetPaths(PATHS);
-export default PATHS;

package/lib/project-files/src/common/constants/index.ts

@@ -1,11 +0,0 @@
-
-/******************************************************************************
-                              Constants
-******************************************************************************/
-
-// NOTE: These need to match the names of your ".env" files
-export const NODE_ENVS = {
-  Dev: 'development',
-  Test: 'test',
-  Production: 'production',
-} as const;

package/lib/project-files/src/common/util/misc.ts

@@ -1,11 +0,0 @@
-
-/******************************************************************************
-                                Functions
-******************************************************************************/
-
-/**
- * Get a random number between 1 and 1,000,000,000,000
- */
-export function getRandomInt(): number {
-  return Math.floor(Math.random() * 1_000_000_000_000);
-}

package/lib/project-files/src/common/util/route-errors.ts

@@ -1,38 +0,0 @@
-import { IParseObjectError } from 'jet-validators/utils';
-
-import HTTP_STATUS_CODES, {
-  HttpStatusCodes,
-} from '@src/common/constants/HTTP_STATUS_CODES';
-
-/******************************************************************************
-                                 Classes
-******************************************************************************/
-
-/**
- * Error with status code and message.
- */
-export class RouteError extends Error {
-  public status: HttpStatusCodes;
-
-  public constructor(status: HttpStatusCodes, message: string) {
-    super(message);
-    this.status = status;
-  }
-}
-
-/**
- * Handle "parseObj" errors.
- */
-export class ValidationError extends RouteError {
-
-  public static MESSAGE = 'The parseObj() function discovered one or ' + 
-    'more errors.';
-
-  public constructor(errors: IParseObjectError[]) {
-    const msg = JSON.stringify({
-      message: ValidationError.MESSAGE,
-      errors,
-    });
-    super(HTTP_STATUS_CODES.BadRequest, msg);
-  }
-}

package/lib/project-files/src/common/util/validators.ts

@@ -1,21 +0,0 @@
-import { isNumber, isDate } from 'jet-validators';
-import { transform } from 'jet-validators/utils';
-
-/******************************************************************************
-                                Functions
-******************************************************************************/
-
-/**
- * Database relational key.
- */
-export function isRelationalKey(arg: unknown): arg is number {
-  return isNumber(arg) && arg >= -1;
-}
-
-/**
- * Convert to date object then check is a validate date.
- */
-export const transIsDate = transform(
-  arg => new Date(arg as string),
-  arg => isDate(arg),
-);