express-generator-typescript 2.7.11 → 2.7.12

package/lib/express-generator-typescript.js

@@ -9,18 +9,51 @@ const path = require('path'),
                                  Constants
 ******************************************************************************/
 
-// Project folder paths
 const PROJECT_FOLDER_PATH = './project-files';
 
-// Project-folder dependencies
-const DEPENDENCIES = 'express dotenv morgan cookie-parser jet-logger ' +
-  'module-alias helmet jsonfile jet-paths dayjs jet-env ' + 
+const DEPENDENCIES = [
+  'cookie-parser',
+  'dayjs',
+  'dotenv',
+  'express',
+  'helmet',
+  'jet-env',
+  'jet-logger',
+  'jet-paths',
   'jet-validators',
-  DEV_DEPENDENCIES = 'ts-node typescript nodemon find supertest vitest ' +
-    '@types/node @types/find @types/morgan @types/cookie-parser ' +
-    '@types/supertest fs-extra tsconfig-paths jiti @swc/core @types/jsonfile ' +
-    '@types/fs-extra @types/module-alias @stylistic/eslint-plugin eslint ' +
-    '@eslint/js typescript-eslint eslint-plugin-n';
+  'jsonfile',
+  'module-alias',
+  'morgan',
+];
+
+const DEV_DEPENDENCIES = [
+  '@eslint/js',
+  '@swc/core',
+  '@trivago/prettier-plugin-sort-imports',
+  '@types/cookie-parser',
+  '@types/find',
+  '@types/fs-extra',
+  '@types/jsonfile',
+  '@types/module-alias',
+  '@types/morgan',
+  '@types/node',
+  '@types/supertest',
+  'eslint',
+  'eslint-config-prettier',
+  'eslint-plugin-n',
+  'find',
+  'fs-extra',
+  'jiti',
+  'nodemon',
+  'prettier',
+  'supertest',
+  'ts-node',
+  'tsconfig-paths',
+  'typescript',
+  'typescript-eslint',
+  'vitest',
+];
+
 
 // "ncp" options
 const ncpOpts = {
@@ -91,8 +124,8 @@ function renameGitigoreFile(destination) {
 function downloadNodeModules(destination, useYarn) {
   const options = { cwd: destination };
   // Setup dependencies string
-  let depStr = DEPENDENCIES,
-    devDepStr = DEV_DEPENDENCIES;
+  let depStr = DEPENDENCIES.join(' '),
+    devDepStr = DEV_DEPENDENCIES.join(' ');
   // Setup download command
   let downloadLibCmd,
     downloadDepCmd;

package/lib/project-files/.prettierignore

@@ -0,0 +1,12 @@
+# Ignore everything
+*
+
+# Allow these folders
+!src/
+!test/
+!script/
+
+# Allow all files inside them
+!src/**
+!test/**
+!scripts/**

package/lib/project-files/.prettierrc.json

@@ -0,0 +1,15 @@
+{
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
+  "importOrder": [
+    "<THIRD_PARTY_MODULES>",
+    "^@src/[^/]+(/.*)?$",
+    "^\\.(?!.*\\.css$).*$",
+    "^.+\\.css$"
+  ],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true,
+  "importOrderCaseInsensitive": true,
+  "singleQuote": true,
+  "printWidth": 80,
+  "tabWidth": 2
+}

package/lib/project-files/README.md

@@ -1,65 +1,58 @@
-## 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`. 
+## 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.ts

@@ -1,22 +1,20 @@
-/* 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');
-}
+import dotenv from 'dotenv';
+import moduleAlias from 'module-alias';
+import path from 'path';
+
+// Check the env
+// eslint-disable-next-line no-process-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 +1,46 @@
-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',
-    },
-  },
-);
+import js from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier/flat';
+import n from 'eslint-plugin-n';
+import { defineConfig, globalIgnores } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+
+export default defineConfig([
+  // global ignores
+  globalIgnores(['**/dist/**']),
+  // linting rules (code quality only)
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      js.configs.recommended,
+      ...tseslint.configs.recommendedTypeChecked,
+    ],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    plugins: {
+      n,
+    },
+    rules: {
+      // code quality / correctness
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        {
+          argsIgnorePattern: '^_',
+          caughtErrorsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+        },
+      ],
+      'no-console': 'warn',
+      'no-extra-boolean-cast': 'off',
+      'no-process-env': 'warn',
+      // node correctness
+      'n/no-extraneous-import': 'error'
+    },
+  },
+  // MUST be last — disables ALL formatting rules
+  eslintConfigPrettier,
+]);

package/lib/project-files/package.json

@@ -1,56 +1,59 @@
-{
-  "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.19",
-    "dotenv": "^17.2.3",
-    "express": "^5.2.1",
-    "helmet": "^8.1.0",
-    "jet-env": "^1.1.6",
-    "jet-logger": "^2.2.3",
-    "jet-paths": "^2.0.1",
-    "jet-validators": "^2.2.0",
-    "jsonfile": "^6.2.0",
-    "module-alias": "^2.2.3",
-    "morgan": "^1.10.1"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.39.2",
-    "@stylistic/eslint-plugin": "^5.7.0",
-    "@swc/core": "^1.15.8",
-    "@types/cookie-parser": "^1.4.10",
-    "@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.10",
-    "@types/node": "^25.0.5",
-    "@types/supertest": "^6.0.3",
-    "eslint": "^9.39.2",
-    "eslint-plugin-n": "^17.23.1",
-    "find": "^0.3.0",
-    "fs-extra": "^11.3.3",
-    "jiti": "^2.6.1",
-    "nodemon": "^3.1.11",
-    "supertest": "^7.2.2",
-    "ts-node": "^10.9.2",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.52.0",
-    "vitest": "^4.0.16"
-  }
-}
+{
+  "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/main",
+    "dev:hot": "nodemon --exec \"npm run dev\" --watch ./src --ext .ts",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "start": "NODE_ENV=production node -r ./config.js ./dist/main",
+    "test": "NODE_ENV=test vitest",
+    "type-check": "tsc -b --noEmit"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "dependencies": {
+    "cookie-parser": "^1.4.7",
+    "dayjs": "^1.11.19",
+    "dotenv": "^17.2.3",
+    "express": "^5.2.1",
+    "helmet": "^8.1.0",
+    "jet-env": "^1.1.6",
+    "jet-logger": "^2.2.3",
+    "jet-paths": "^2.0.1",
+    "jet-validators": "2.2.5",
+    "jsonfile": "^6.2.0",
+    "module-alias": "^2.2.3",
+    "morgan": "^1.10.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@swc/core": "^1.15.8",
+    "@trivago/prettier-plugin-sort-imports": "^6.0.2",
+    "@types/cookie-parser": "^1.4.10",
+    "@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.10",
+    "@types/node": "^25.0.5",
+    "@types/supertest": "^6.0.3",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-n": "^17.23.2",
+    "find": "^0.3.0",
+    "fs-extra": "^11.3.3",
+    "jiti": "^2.6.1",
+    "nodemon": "^3.1.11",
+    "prettier": "^3.8.0",
+    "supertest": "^7.2.2",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.52.0",
+    "vitest": "^4.0.16"
+  }
+}

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

@@ -1,28 +1,23 @@
-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);
-  }
-})();
-
+import logger from 'jet-logger';
+
+import { copy, copyFilesRec, exec, remove } from './common/utils';
+
+/******************************************************************************
+                                  Run
+******************************************************************************/
+
+(async () => {
+  // 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);
+    process.exit(1);
+})
+

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

@@ -1,6 +1,6 @@
+import childProcess from 'child_process';
 import fs from 'fs-extra';
 import logger from 'jet-logger';
-import childProcess from 'child_process';
 import path from 'path';
 
 /******************************************************************************
@@ -12,8 +12,8 @@ import path from 'path';
  */
 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());
+    return fs.copy(src, dest, (err) => {
+      return !!err ? rej(err) : res();
     });
   });
 }
@@ -23,8 +23,8 @@ export function copy(src: string, dest: string): Promise<void> {
  */
 export function remove(loc: string): Promise<void> {
   return new Promise((res, rej) => {
-    return fs.remove(loc, err => {
-      return (!!err ? rej(err) : res());
+    return fs.remove(loc, (err) => {
+      return !!err ? rej(err) : res();
     });
   });
 }
@@ -37,7 +37,7 @@ export function exec(cmd: string, loc = './'): Promise<string> {
   const callingDir = path.dirname(require.main?.filename ?? './'),
     cwd = path.join(callingDir, loc);
   // Wrap in promise
-  return new Promise((res, rej) => 
+  return new Promise((res, rej) =>
     childProcess.exec(cmd, { cwd }, (err, stdout, stderr) => {
       if (!!stdout) {
         logger.info(stdout);
@@ -57,18 +57,18 @@ export function exec(cmd: string, loc = './'): Promise<string> {
 }
 
 /**
- * Recursively search for a folder for all files and copy them to the new 
+ * Recursively search for a folder for all files and copy them to the new
  * destination keeping their paths relative to the "src" param.
- * 
- * Example: 
+ *
+ * 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, 
+  dest: string,
   excludeExt?: string[],
 ): Promise<void> {
   const copyReqs: Promise<void>[] = [];