express-generator-typescript 3.0.3 → 3.0.4

package/README.md

@@ -72,7 +72,9 @@ npm run dev
 
 The generated project is a small CRUD app for a `User` record. It shows how to structure models, services, and routes in Express + TypeScript. Linting, formatting, building, and hot reloading are all set up for you.
 
-### Available `package.json` Scripts
+---
+
+#### Available `package.json` scripts
 
 - `npm run dev` – Run the server in development with live reload and browser refresh.
 - `npm test` – Run the tests with Vitest.
@@ -84,7 +86,9 @@ The generated project is a small CRUD app for a `User` record. It shows how to s
 - `npm run typecheck` – Check for TypeScript errors without building.
 - `npm run install:clean` – Delete `node_modules` and the lockfile, then reinstall.
 
-### Architecture
+---
+
+#### Architecture
 
 The app uses a **layered** architecture, which suits a small CRUD app. If you plan to grow it, consider switching to a **domain-based** layout. The [Typescript Best Practices README](https://github.com/seanpmaxwell/Typescript-Best-Practices/tree/main?tab=readme-ov-file#architecture) explains both patterns.
 

package/lib/template/README.md

@@ -53,7 +53,7 @@ Delete `node_modules/` and `package-lock.json`, then reinstall all dependencies.
   - **Request logging**: [morgan](https://github.com/expressjs/morgan) (development only)
   - **General logging**: [jet-logger](https://github.com/seanpmaxwell/jet-logger)
 - **Validation**: [jet-validators](https://github.com/seanpmaxwell/jet-validators)
-- **Environment variables**: [dotenv](https://github.com/motdotla/dotenv) loads `config/.env.*`, and [jet-env](https://github.com/seanpmaxwell/jet-env) validates them
+- **Environment variables**: [dotenv](https://github.com/motdotla/dotenv) loads `config/.env.*`
 - **Reloading**: [tsx](https://tsx.hirok.io) (`tsx watch` restarts the server) and [livereload](https://github.com/napcs/node-livereload) + [connect-livereload](https://github.com/intesso/connect-livereload) (refreshes the browser)
 - **Testing**: [Vitest](https://vitest.dev) + [Supertest](https://github.com/ladjs/supertest)
 - **Linting**: [ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io/packages/typescript-eslint) and [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)

package/lib/template/package.json

@@ -21,10 +21,9 @@
     "dotenv": "^18.0.4",
     "express": "^5.2.1",
     "helmet": "^8.3.0",
-    "jet-env": "^1.1.6",
     "jet-id": "^1.3.1",
     "jet-logger": "3.0.0",
-    "jet-paths": "^4.0.2",
+    "jet-paths": "^4.1.3",
     "jet-validators": "^2.3.1",
     "jsonfile": "^6.2.1",
     "morgan": "^1.12.1"
@@ -53,5 +52,8 @@
     "typescript": "^6.0.3",
     "typescript-eslint": "^8.70.1",
     "vitest": "^5.0.2"
+  },
+  "allowScripts": {
+    "esbuild@0.28.2": true
   }
 }

package/lib/template/src/common/classes/route-errors.ts

@@ -25,6 +25,15 @@ export class RouteError extends Error {
   }
 }
 
+/**
+ * Don't have to manually pass `HttpStatusCodes.NOT_FOUND` each time.
+ */
+export class NotFoundError extends RouteError {
+  public constructor(message: string) {
+    super(HttpStatusCodes.NOT_FOUND, message);
+  }
+}
+
 /**
  * Request data failed schema validation.
  */

package/lib/template/src/common/constants/HttpStatusCodes.ts

@@ -1,4 +1,4 @@
-import type { ValueOf } from '../types/utility-types';
+import type { ValueOf } from '../utils/validators';
 
 // ========================================================================= //
 //                                 CONSTANTS                                 //
@@ -385,14 +385,9 @@ const HttpStatusCodes = {
   NETWORK_AUTHENTICATION_REQUIRED: 511,
 } as const;
 
-// ========================================================================= //
-//                                   TYPES                                   //
-// ========================================================================= //
-
-type HttpStatusCodes = ValueOf<typeof HttpStatusCodes>;
-
 // ========================================================================= //
 //                                  EXPORT                                   //
 // ========================================================================= //
 
+type HttpStatusCodes = ValueOf<typeof HttpStatusCodes>;
 export default HttpStatusCodes;

package/lib/template/src/common/constants/Paths.ts

@@ -1,22 +1,16 @@
 import jetPaths from 'jet-paths';
 
 // ========================================================================= //
-//                                 CONSTANTS                                 //
+//                                  EXPORT                                   //
 // ========================================================================= //
 
-const Paths = jetPaths({
-  _: '/api',
+export default jetPaths({
+  $path: '/api',
   Users: {
-    _: '/users',
+    $path: '/users',
     Get: '/all',
     Add: '/add',
     Update: '/update',
-    Delete: '/delete',
+    Delete: '/delete/:id',
   },
 } as const);
-
-// ========================================================================= //
-//                                  EXPORT                                   //
-// ========================================================================= //
-
-export default Paths;

package/lib/template/src/common/constants/environment-consts.ts

@@ -0,0 +1,44 @@
+/* eslint-disable no-process-env */
+import logger from 'jet-logger';
+
+import { isNumber, isValueOf, type ValueOf } from '../utils/validators';
+
+// ========================================================================= //
+//                                 CONSTANTS                                 //
+// ========================================================================= //
+
+// NOTE: These need to match the names of your ".env" files
+export const NodeEnvs = {
+  DEVELOPMENT: 'development',
+  TEST: 'test',
+  PRODUCTION: 'production',
+} as const;
+export type NodeEnvs = ValueOf<typeof NodeEnvs>;
+
+export const EnvVars = {
+  NODE_ENV: process.env.NODE_ENV?.toLowerCase(),
+  PORT: Number(process.env.PORT),
+} as const;
+
+// ========================================================================= //
+//                                   EXEC                                    //
+// ========================================================================= //
+
+// ---- Validation
+// Validate the "environment variables"
+{
+  try {
+    const isNodeEnv = isValueOf(NodeEnvs);
+    if (!isNodeEnv(EnvVars.NODE_ENV)) {
+      throw new Error(
+        'process.env.NODE_ENV must be "development", "test", or "production"',
+      );
+    }
+    if (!isNumber(EnvVars.PORT)) {
+      throw new Error('process.env.PORT must be a valid number');
+    }
+  } catch (err) {
+    logger.err(err);
+    throw err;
+  }
+}

package/lib/template/src/common/utils/validators.ts

@@ -0,0 +1,28 @@
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
+
+export type ValueOf<T> = T[keyof T];
+type Table = Record<string, string> | Record<string, number>;
+
+// ========================================================================= //
+//                                   EXEC                                    //
+// ========================================================================= //
+
+/**
+ * Check if an `unknown` is a number type.
+ */
+export function isNumber<T>(val: T): val is Extract<T, number> {
+  return typeof val === 'number' && !isNaN(val);
+}
+
+/**
+ * Check if an `unknown` is a value of an object.
+ */
+export function isValueOf<T extends Table>(
+  table: T,
+): (v: unknown) => v is ValueOf<T> {
+  const vals = Object.values(table);
+  const set = new Set(vals);
+  return (val: unknown): val is ValueOf<T> => set.has(val);
+}

package/lib/template/src/entities/User/types.ts

@@ -1,4 +1,4 @@
-import type { Entity } from '@src/entities/common/types';
+import type { Entity } from '@src/entities/common/entity-base-types';
 
 // ========================================================================= //
 //                                   TYPES                                   //

package/lib/template/src/main.ts

@@ -1,21 +1,20 @@
 import logger from 'jet-logger';
 
-import { EnvVars } from './common/constants/env-inv';
+import { EnvVars } from './common/constants/environment-consts';
 import server from './server';
 
 // ========================================================================= //
 //                                 CONSTANTS                                 //
 // ========================================================================= //
 
-const SERVER_START_MESSAGE =
-  'Express server started on port: ' + EnvVars.Port.toString();
+const SERVER_START_MESSAGE = `Express server started on port: ${EnvVars.PORT}`;
 
 // ========================================================================= //
 //                                   EXEC                                    //
 // ========================================================================= //
 
 // Start the server
-server.listen(EnvVars.Port, (err) => {
+server.listen(EnvVars.PORT, (err) => {
   if (!!err) {
     logger.err(err.message);
   } else {

package/lib/template/src/public/scripts/users.js

@@ -154,7 +154,7 @@ function submitEdit(ele) {
  */
 function deleteUser(ele) {
   var id = ele.getAttribute('data-user-id');
-  HttpClient.delete('/api/users/delete?id=' + encodeURIComponent(id))
+  HttpClient.delete('/api/users/delete/' + encodeURIComponent(id))
     .then(checkResponse)
     .then(() => displayUsers())
     .catch(showError);

package/lib/template/src/repos/MockOrm.ts

@@ -2,7 +2,7 @@ import fs from 'fs/promises';
 import jsonfile from 'jsonfile';
 import path from 'path';
 
-import { EnvVars, NodeEnvs } from '@src/common/constants/env-inv';
+import { EnvVars, NodeEnvs } from '@src/common/constants/environment-consts';
 import type { UserEntity } from '@src/entities/User';
 
 // ========================================================================= //
@@ -12,7 +12,7 @@ import type { UserEntity } from '@src/entities/User';
 const DATABASE_FILE_PATH = path.join(
   import.meta.dirname,
   'common',
-  EnvVars.NodeEnv === NodeEnvs.TEST ? 'database.test.json' : 'database.json',
+  EnvVars.NODE_ENV === NodeEnvs.TEST ? 'database.test.json' : 'database.json',
 );
 
 // ========================================================================= //

package/lib/template/src/repos/UserRepo.ts

@@ -33,7 +33,7 @@ async function getAll(): Promise<UserEntity[]> {
 /**
  * Add one user.
  */
-async function add(user: UserEntity): Promise<void> {
+async function addOne(user: UserEntity): Promise<void> {
   const db = await orm.openDb();
   db.users.push(user);
   return orm.saveDb(db);
@@ -42,7 +42,7 @@ async function add(user: UserEntity): Promise<void> {
 /**
  * Update a user.
  */
-async function update(user: UserEntity): Promise<void> {
+async function updateOne(user: UserEntity): Promise<void> {
   const db = await orm.openDb();
   for (let i = 0; i < db.users.length; i++) {
     if (db.users[i].id === user.id) {
@@ -60,7 +60,7 @@ async function update(user: UserEntity): Promise<void> {
 /**
  * Delete one user.
  */
-async function delete_(id: string): Promise<void> {
+async function deleteOne(id: string): Promise<void> {
   const db = await orm.openDb();
   for (let i = 0; i < db.users.length; i++) {
     if (db.users[i].id === id) {
@@ -73,9 +73,9 @@ async function delete_(id: string): Promise<void> {
 // ============================ Unit-tests Only ============================ //
 
 /**
- * @testOnly
- *
  * Delete every user record.
+ *
+ * @testOnly
  */
 async function deleteAllUsers(): Promise<void> {
   const db = await orm.openDb();
@@ -84,9 +84,9 @@ async function deleteAllUsers(): Promise<void> {
 }
 
 /**
- * @testOnly
- *
  * Insert copies of `users` with fresh ids; the inputs are not modified.
+ *
+ * @testOnly
  */
 async function insertMultiple(
   users: UserEntity[] | readonly UserEntity[],
@@ -106,12 +106,15 @@ async function insertMultiple(
 //                                  EXPORT                                   //
 // ========================================================================= //
 
+export const UserRepoTestOnly = {
+  deleteAllUsers,
+  insertMultiple,
+} as const;
+
 export default {
   persists,
   getAll,
-  add,
-  update,
-  delete: delete_,
-  deleteAllUsers,
-  insertMultiple,
+  addOne,
+  updateOne,
+  deleteOne,
 } as const;

package/lib/template/src/routes/UserRoutes.ts

@@ -9,7 +9,7 @@ import parseReq from './common/parseReq';
 //                                   EXEC                                    //
 // ========================================================================= //
 
-const reqValidators = {
+const validators = {
   add: parseReq({ user: User.isInput }),
   update: parseReq({ user: User.isComplete }),
   delete: parseReq({ id: User.isId }),
@@ -34,8 +34,8 @@ async function getAll(_: Req, res: Res) {
  *
  * @route POST /api/users/add
  */
-async function add(req: Req, res: Res) {
-  const { user } = reqValidators.add(req.body);
+async function addOne(req: Req, res: Res) {
+  const { user } = validators.add(req.body);
   const created = await UserService.addOne(user);
   res.status(HttpStatusCodes.CREATED).json({ user: created });
 }
@@ -45,8 +45,8 @@ async function add(req: Req, res: Res) {
  *
  * @route PUT /api/users/update
  */
-async function update(req: Req, res: Res) {
-  const { user } = reqValidators.update(req.body);
+async function updateOne(req: Req, res: Res) {
+  const { user } = validators.update(req.body);
   await UserService.updateOne(user);
   res.status(HttpStatusCodes.OK).end();
 }
@@ -54,11 +54,11 @@ async function update(req: Req, res: Res) {
 /**
  * Delete one user.
  *
- * @route DELETE /api/users/delete?id=:id
+ * @route DELETE /api/users/delete/:id
  */
-async function delete_(req: Req, res: Res) {
-  const { id } = reqValidators.delete(req.query);
-  await UserService.delete(id);
+async function deleteOne(req: Req, res: Res) {
+  const { id } = validators.delete(req.params);
+  await UserService.deleteOne(id);
   res.status(HttpStatusCodes.OK).end();
 }
 
@@ -68,7 +68,7 @@ async function delete_(req: Req, res: Res) {
 
 export default {
   getAll,
-  add,
-  update,
-  delete: delete_,
+  addOne,
+  updateOne,
+  deleteOne,
 } as const;

package/lib/template/src/routes/apiRouter.ts

@@ -14,12 +14,12 @@ const apiRouter = Router();
 
 const userRouter = Router();
 
-userRouter.get(Paths.Users.Get._, UserRoutes.getAll);
-userRouter.post(Paths.Users.Add._, UserRoutes.add);
-userRouter.put(Paths.Users.Update._, UserRoutes.update);
-userRouter.delete(Paths.Users.Delete._, UserRoutes.delete);
+userRouter.get(Paths.Users.Get.$path, UserRoutes.getAll);
+userRouter.post(Paths.Users.Add.$path, UserRoutes.addOne);
+userRouter.put(Paths.Users.Update.$path, UserRoutes.updateOne);
+userRouter.delete(Paths.Users.Delete.$path, UserRoutes.deleteOne);
 
-apiRouter.use(Paths.Users._, userRouter);
+apiRouter.use(Paths.Users.$path, userRouter);
 
 // ========================================================================= //
 //                                  EXPORT                                   //

package/lib/template/src/server.ts

@@ -8,12 +8,12 @@ import logger from 'jet-logger';
 import morgan from 'morgan';
 import path from 'path';
 
+import { RouteError } from '@src/common/classes/route-errors';
 import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
 import Paths from '@src/common/constants/Paths';
-import { RouteError } from '@src/common/classes/route-errors';
 import BaseRouter from '@src/routes/apiRouter';
 
-import { EnvVars, NodeEnvs } from './common/constants/env-inv';
+import { EnvVars, NodeEnvs } from './common/constants/environment-consts';
 
 // ========================================================================= //
 //                                   EXEC                                    //
@@ -28,17 +28,17 @@ app.use(express.json());
 app.use(express.urlencoded({ extended: true }));
 
 // Show routes called in console during development
-if (EnvVars.NodeEnv === NodeEnvs.DEV) {
+if (EnvVars.NODE_ENV === NodeEnvs.DEVELOPMENT) {
   app.use(morgan('dev'));
 }
 
 // Security
-if (EnvVars.NodeEnv === NodeEnvs.PRODUCTION) {
+if (EnvVars.NODE_ENV === NodeEnvs.PRODUCTION) {
   app.use(helmet());
 }
 
 // Add APIs, must be after middleware
-app.use(Paths._, BaseRouter);
+app.use(Paths.$path, BaseRouter);
 
 // Add error handler. `_next` must stay: Express only treats 4-arg middleware
 // as an error handler.
@@ -48,7 +48,7 @@ app.use((err: Error, _: Request, res: Response, _next: NextFunction) => {
       .status(err.status)
       .json({ error: err.message, errors: err.errors });
   }
-  if (EnvVars.NodeEnv !== NodeEnvs.TEST) {
+  if (EnvVars.NODE_ENV !== NodeEnvs.TEST) {
     logger.err(err, true);
   }
   return res
@@ -58,15 +58,13 @@ app.use((err: Error, _: Request, res: Response, _next: NextFunction) => {
 
 // =========================== Front-end Content =========================== //
 
-// Views directory (html)
+// Views/HTML directory (html)
 const viewsDir = path.join(import.meta.dirname, 'views');
-
-// Set static directory (js and css).
 const staticDir = path.join(import.meta.dirname, 'public');
 
 // Refresh the browser on changes. Imported lazily because livereload is a
 // dev dependency and isn't installed in production.
-if (EnvVars.NodeEnv === NodeEnvs.DEV) {
+if (EnvVars.NODE_ENV === NodeEnvs.DEVELOPMENT) {
   const { setupLiveReload } = await import('@src/common/utils/dev-only');
   setupLiveReload(app, [staticDir, viewsDir]);
 }

package/lib/template/src/services/UserService.ts

@@ -1,5 +1,4 @@
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
-import { RouteError } from '@src/common/classes/route-errors';
+import { NotFoundError } from '@src/common/classes/route-errors';
 import User, { type UserEntity, type UserInput } from '@src/entities/User';
 import UserRepo from '@src/repos/UserRepo';
 
@@ -7,7 +6,7 @@ import UserRepo from '@src/repos/UserRepo';
 //                                 CONSTANTS                                 //
 // ========================================================================= //
 
-const Errors = {
+const UserServiceErrors = {
   USER_NOT_FOUND: 'User not found',
 } as const;
 
@@ -27,7 +26,7 @@ function getAll(): Promise<UserEntity[]> {
  */
 async function addOne(input: UserInput): Promise<UserEntity> {
   const user = User.create(input);
-  await UserRepo.add(user);
+  await UserRepo.addOne(user);
   return user;
 }
 
@@ -36,10 +35,8 @@ async function addOne(input: UserInput): Promise<UserEntity> {
  */
 async function updateOne(user: UserEntity): Promise<void> {
   const persists = await UserRepo.persists(user.id);
-  if (!persists) {
-    throw new RouteError(HttpStatusCodes.NOT_FOUND, Errors.USER_NOT_FOUND);
-  }
-  return UserRepo.update(user);
+  if (!persists) throw new NotFoundError(UserServiceErrors.USER_NOT_FOUND);
+  return UserRepo.updateOne(user);
 }
 
 /**
@@ -47,10 +44,8 @@ async function updateOne(user: UserEntity): Promise<void> {
  */
 async function deleteOne(id: string): Promise<void> {
   const persists = await UserRepo.persists(id);
-  if (!persists) {
-    throw new RouteError(HttpStatusCodes.NOT_FOUND, Errors.USER_NOT_FOUND);
-  }
-  return UserRepo.delete(id);
+  if (!persists) throw new NotFoundError(UserServiceErrors.USER_NOT_FOUND);
+  return UserRepo.deleteOne(id);
 }
 
 // ========================================================================= //
@@ -58,9 +53,9 @@ async function deleteOne(id: string): Promise<void> {
 // ========================================================================= //
 
 export default {
-  Errors,
+  Errors: UserServiceErrors,
   getAll,
   addOne,
   updateOne,
-  delete: deleteOne,
+  deleteOne,
 } as const;

package/lib/template/tests/common/comparators.ts

@@ -16,14 +16,12 @@ type UserArray = UserEntity[] | readonly UserEntity[];
  */
 export function compareUserArrays(a: UserArray, b: UserArray): boolean {
   if (a.length !== b.length) return false;
-  const aSorted = sortByEmail(a),
-    bSorted = sortByEmail(b);
+  const aSorted = sortByEmail(a);
+  const bSorted = sortByEmail(b);
   for (let i = 0; i < aSorted.length; i++) {
-    const a = aSorted[i],
-      b = bSorted[i];
-    if (a.email !== b.email || a.name !== b.name) {
-      return false;
-    }
+    const a = aSorted[i];
+    const b = bSorted[i];
+    if (a.email !== b.email || a.name !== b.name) return false;
   }
   return true;
 }

package/lib/template/tests/users.test.ts

@@ -1,10 +1,10 @@
 import jetid from 'jet-id';
 
+import { ValidationError } from '@src/common/classes/route-errors';
 import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
 import Paths from '@src/common/constants/Paths';
-import { ValidationError } from '@src/common/classes/route-errors';
 import User, { type UserEntity } from '@src/entities/User';
-import UserRepo from '@src/repos/UserRepo';
+import UserRepo, { UserRepoTestOnly } from '@src/repos/UserRepo';
 import UserService from '@src/services/UserService';
 
 import { compareUserArrays } from './common/comparators';
@@ -15,15 +15,23 @@ import { agent } from './support/agent';
 //                                 CONSTANTS                                 //
 // ========================================================================= //
 
+// Path constants
+const PATH_USERS_GET = Paths.Users.Get();
+const PATH_USERS_ADD = Paths.Users.Add();
+const PATH_USERS_UPDATE = Paths.Users.Update();
+const PATH_USERS_DELETE = Paths.Users.Delete.$tmpl;
+
+// Errors
+const ERR_USER_NOT_FOUND = UserService.Errors.USER_NOT_FOUND;
+const { BAD_REQUEST, CREATED, INTERNAL_SERVER_ERROR, OK, NOT_FOUND } =
+  HttpStatusCodes;
+
 const DUMMY_USERS = [
   User.of('Sean Maxwell', 'sean.maxwell@gmail.com'),
   User.of('John Smith', 'john.smith@gmail.com'),
   User.of('Gordan Freeman', 'gordan.freeman@gmail.com'),
 ] as const;
 
-const { BAD_REQUEST, CREATED, INTERNAL_SERVER_ERROR, OK, NOT_FOUND } =
-  HttpStatusCodes;
-
 // ========================================================================= //
 //                                   TESTS                                   //
 // ========================================================================= //
@@ -35,8 +43,8 @@ describe('UserRouter', () => {
   let dbUsers: UserEntity[] = [];
 
   beforeEach(async () => {
-    await UserRepo.deleteAllUsers();
-    dbUsers = await UserRepo.insertMultiple(DUMMY_USERS);
+    await UserRepoTestOnly.deleteAllUsers();
+    dbUsers = await UserRepoTestOnly.insertMultiple(DUMMY_USERS);
   });
 
   afterEach(() => {
@@ -44,162 +52,147 @@ describe('UserRouter', () => {
   });
 
   // ---- `Get`
-  describe(`"GET:${Paths.Users.Get()}"`, () => {
-    it(
-      'should return a JSON object with all the users and a status code of ' +
-        `"${OK}" if the request was successful.`,
-      async () => {
-        const res: TestRes<{ users: UserEntity[] }> = await agent.get(
-          Paths.Users.Get(),
-        );
+  describe(`"GET - ${PATH_USERS_GET}"`, () => {
+    describe('on success', () => {
+      it(`returns all users as JSON with status "${OK}"`, async () => {
+        const res: TestRes<{ users: UserEntity[] }> =
+          await agent.get(PATH_USERS_GET);
         expect(res.status).toBe(OK);
-        expect(compareUserArrays(res.body.users, DUMMY_USERS)).toBeTruthy();
-      },
-    );
-
-    it(
-      `should return a JSON error and a status code of ` +
-        `"${INTERNAL_SERVER_ERROR}" if an unexpected error is thrown.`,
-      async () => {
-        vi.spyOn(UserService, 'getAll').mockRejectedValueOnce(
-          new Error('boom'),
-        );
-        const res: TestRes = await agent.get(Paths.Users.Get());
+        const usersMatch = compareUserArrays(res.body.users, DUMMY_USERS);
+        expect(usersMatch).toBeTruthy();
+      });
+    });
+
+    describe('when an unexpected error is thrown', () => {
+      it(`returns status "${INTERNAL_SERVER_ERROR}"`, async () => {
+        const error = new Error('boom');
+        const getAllSpy = vi.spyOn(UserService, 'getAll');
+        getAllSpy.mockRejectedValueOnce(error);
+        const res: TestRes = await agent.get(PATH_USERS_GET);
         expect(res.status).toBe(INTERNAL_SERVER_ERROR);
         expect(res.body.error).toBe('Internal Server Error');
-      },
-    );
+      });
+    });
   });
 
   // ---- `Add`
-  describe(`"POST:${Paths.Users.Add()}"`, () => {
-    it(
-      `should return a status code of "${CREATED}" and persist the user ` +
-        'with a server-generated id if the request was successful.',
-      async () => {
+  describe(`"POST - ${PATH_USERS_ADD}"`, () => {
+    describe('on success', () => {
+      it(`persists the user and returns status "${CREATED}"`, async () => {
         // Same payload shape the front-end sends
         const input = { name: 'a', email: 'a@a.com' };
         const res: TestRes<{ user: UserEntity }> = await agent
-          .post(Paths.Users.Add())
+          .post(PATH_USERS_ADD)
           .send({ user: input });
         expect(res.status).toBe(CREATED);
-        expect(User.isId(res.body.user.id)).toBe(true);
+        const isId = User.isId(res.body.user.id);
+        expect(isId).toBe(true);
         const all = await UserRepo.getAll();
         expect(all).toHaveLength(DUMMY_USERS.length + 1);
         expect(all).toContainEqual(res.body.user);
-      },
-    );
+      });
+    });
 
-    it(
-      'should return a JSON object with an error message and a status ' +
-        `code of "${BAD_REQUEST}" if the user param was missing.`,
-      async () => {
+    describe('when the user param is missing', () => {
+      it('returns a validation error', async () => {
         const res: TestRes = await agent
-          .post(Paths.Users.Add())
+          .post(PATH_USERS_ADD)
           .send({ user: null });
         expect(res.status).toBe(BAD_REQUEST);
         expect(res.body.error).toBe(ValidationError.MESSAGE);
         expect(res.body.errors?.[0].key).toStrictEqual('user');
-      },
-    );
+      });
+    });
 
-    it(
-      `should return a status code of "${BAD_REQUEST}" if the name is ` +
-        'empty.',
-      async () => {
+    describe('when the name is empty', () => {
+      it(`returns status "${BAD_REQUEST}"`, async () => {
         const res: TestRes = await agent
-          .post(Paths.Users.Add())
+          .post(PATH_USERS_ADD)
           .send({ user: { name: '', email: 'a@a.com' } });
         expect(res.status).toBe(BAD_REQUEST);
-        expect(await UserRepo.getAll()).toHaveLength(DUMMY_USERS.length);
-      },
-    );
+        const allUsers = await UserRepo.getAll();
+        expect(allUsers).toHaveLength(DUMMY_USERS.length);
+      });
+    });
   });
 
   // ---- `Update`
-  describe(`"PUT:${Paths.Users.Update()}"`, () => {
-    it(
-      `should return a status code of "${OK}" and save the change if the ` +
-        'request was successful.',
-      async () => {
+  describe(`"PUT - ${PATH_USERS_UPDATE}"`, () => {
+    describe('on success', () => {
+      it(`saves the change and returns status "${OK}"`, async () => {
         const user = { ...dbUsers[0], name: 'Bill' };
-        const res = await agent.put(Paths.Users.Update()).send({ user });
+        const res = await agent.put(PATH_USERS_UPDATE).send({ user });
         expect(res.status).toBe(OK);
-        const saved = (await UserRepo.getAll()).find((u) => u.id === user.id);
+        const allUsers = await UserRepo.getAll();
+        const saved = allUsers.find((u) => u.id === user.id);
         expect(saved?.name).toBe('Bill');
-      },
-    );
-
-    it(
-      'should return a JSON object with an error message and a status code ' +
-        `of "${BAD_REQUEST}" if id is not a valid id`,
-      async () => {
-        const user = { ...User.create(), name: 'a', email: 'a@a.com', id: '5' };
-        const res: TestRes = await agent
-          .put(Paths.Users.Update())
-          .send({ user });
+      });
+    });
+
+    describe('when the id is invalid', () => {
+      it('returns a validation error', async () => {
+        const newUser = User.create();
+        const user = {
+          ...newUser,
+          name: 'a',
+          email: 'a@a.com',
+          id: '5',
+        };
+        const res: TestRes = await agent.put(PATH_USERS_UPDATE).send({ user });
         expect(res.status).toBe(BAD_REQUEST);
         expect(res.body.error).toBe(ValidationError.MESSAGE);
         expect(res.body.errors?.[0].keyPath).toStrictEqual(['user', 'id']);
-      },
-    );
-
-    it(
-      'should return a JSON object with the error message of ' +
-        `"${UserService.Errors.USER_NOT_FOUND}" and a status code of ` +
-        `"${NOT_FOUND}" if the id was not found.`,
-      async () => {
-        const user = User.create({ id: jetid(), name: 'a', email: 'a@a.com' }),
-          res: TestRes = await agent.put(Paths.Users.Update()).send({ user });
+      });
+    });
+
+    describe('when the user is not found', () => {
+      it(`returns status "${NOT_FOUND}"`, async () => {
+        const id = jetid();
+        const user = User.create({ id, name: 'a', email: 'a@a.com' });
+        const res: TestRes = await agent.put(PATH_USERS_UPDATE).send({ user });
         expect(res.status).toBe(NOT_FOUND);
-        expect(res.body.error).toBe(UserService.Errors.USER_NOT_FOUND);
-      },
-    );
+        expect(res.body.error).toBe(ERR_USER_NOT_FOUND);
+      });
+    });
   });
 
   // ---- `Delete`
-  describe(`"DELETE:${Paths.Users.Delete()}"`, () => {
-    it(
-      `should return a status code of "${OK}" and remove the user if the ` +
-        'request was successful.',
-      async () => {
-        const id = dbUsers[0].id,
-          res = await agent.delete(Paths.Users.Delete({ id }));
+  describe(`"DELETE - ${PATH_USERS_DELETE}"`, () => {
+    describe('on success', () => {
+      it(`removes the user and returns status "${OK}"`, async () => {
+        const id = dbUsers[0].id;
+        const path = Paths.Users.Delete({ id });
+        const res = await agent.delete(path);
         expect(res.status).toBe(OK);
-        expect(await UserRepo.persists(id)).toBe(false);
-      },
-    );
-
-    it(
-      'should return a JSON object with the error message of ' +
-        `"${UserService.Errors.USER_NOT_FOUND}" and a status code of ` +
-        `"${NOT_FOUND}" if the id was not found.`,
-      async () => {
-        const res: TestRes = await agent.delete(
-          Paths.Users.Delete({ id: jetid() }),
-        );
+        const persists = await UserRepo.persists(id);
+        expect(persists).toBe(false);
+      });
+    });
+
+    describe('when the user is not found', () => {
+      it(`returns status "${NOT_FOUND}"`, async () => {
+        const id = jetid();
+        const path = Paths.Users.Delete({ id });
+        const res: TestRes = await agent.delete(path);
         expect(res.status).toBe(NOT_FOUND);
-        expect(res.body.error).toBe(UserService.Errors.USER_NOT_FOUND);
-      },
-    );
-
-    it(
-      `should return a status code of "${BAD_REQUEST}" if the id is not a ` +
-        'valid id.',
-      async () => {
-        const res = await agent.delete(Paths.Users.Delete({ id: -1 }));
+        expect(res.body.error).toBe(ERR_USER_NOT_FOUND);
+      });
+    });
+
+    describe('when the id is invalid', () => {
+      it(`returns status "${BAD_REQUEST}"`, async () => {
+        const path = Paths.Users.Delete({ id: -1 });
+        const res = await agent.delete(path);
         expect(res.status).toBe(BAD_REQUEST);
-      },
-    );
-
-    it(
-      `should return a status code of "${BAD_REQUEST}" if the id query ` +
-        'param is missing.',
-      async () => {
-        const res: TestRes = await agent.delete(Paths.Users.Delete());
+      });
+    });
+
+    describe('when the id path param is missing', () => {
+      it(`returns status "${BAD_REQUEST}"`, async () => {
+        const res: TestRes = await agent.delete(PATH_USERS_DELETE);
         expect(res.status).toBe(BAD_REQUEST);
         expect(res.body.errors?.[0].key).toStrictEqual('id');
-      },
-    );
+      });
+    });
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "Generate new Express applications similar to express-generate which but sets it up to use TypeScript instead",
   "scripts": {
     "commit": "git add -A && git commit -m \"dev commit\"",

package/lib/template/src/common/constants/env-inv.ts

@@ -1,32 +0,0 @@
-import jetEnv, { num } from 'jet-env';
-
-import type { ValueOf } from '../types/utility-types';
-
-// ========================================================================= //
-//                                 CONSTANTS                                 //
-// ========================================================================= //
-
-// NOTE: These need to match the names of your ".env" files
-export const NodeEnvs = {
-  DEV: 'development',
-  TEST: 'test',
-  PRODUCTION: 'production',
-} as const;
-export type NodeEnvs = ValueOf<typeof NodeEnvs>;
-
-// ========================================================================= //
-//                                   EXEC                                    //
-// ========================================================================= //
-
-// Setup the is `NodeEnvs` validator
-const isNodeEnv = (() => {
-  const vals = Object.values(NodeEnvs);
-  const valsFin = vals.map((item) => item.toLowerCase());
-  const set = new Set(valsFin);
-  return (val: unknown): val is NodeEnvs => set.has(val as NodeEnvs);
-})();
-
-export const EnvVars = jetEnv({
-  NodeEnv: isNodeEnv,
-  Port: num,
-});

package/lib/template/src/common/types/utility-types.ts

@@ -1,5 +0,0 @@
-// ========================================================================= //
-//                                   TYPES                                   //
-// ========================================================================= //
-
-export type ValueOf<T> = T[keyof T];