express-generator-typescript 2.4.17 → 2.4.19

package/README.md

@@ -32,7 +32,7 @@ are packaged with this library.
 
 In addition, relative paths are also setup, so you don't have to go through the trouble of installing
 and configuring _tsconfig-paths_ and _module-alias_. Just make sure to update `paths` in _tsconfig.json_
-and `_moduleAliases` in _package.json_ if you want to add/edit the relative paths.
+and `_moduleAliases` in _preload.js_ if you want to add/edit the relative paths.
 
 
 ## Sample-project
@@ -74,13 +74,11 @@ $ cd "project name" && npm run dev
 ## Available commands for the server.
 
 - Run the server in development mode: `npm run dev`.
-- Run all unit-tests with hot-reloading: `npm test`.
+- Run all unit-tests: `npm test`.
 - Run a single unit-test: `npm test -- --testFile="name of test file" (i.e. --testFile=Users)`.
-- Run all unit-tests without hot-reloading: `npm run test:no-reloading`
 - Check for linting errors: `npm run lint`.
 - Build the project for production: `npm run build`.
 - Run the production build: `npm start`.
-- Run production build with a different env file `npm start -- --env="name of env file" (default is production)`.
 
 
 ## Debugging
@@ -91,34 +89,6 @@ This is located under `nodemonConfig:` in `package.json` for the server and `./s
 unit-testing. For the `exec` property, replace `ts-node` with `node --inspect -r ts-node/register`.
 
 
-## Note for VS-Code users
-
-A lot of users have asked about _launch.json_ configurations for running this in VS-Code, so
-here's a snippet of the launch.json configuration you need to bypass nodemon and run directly with
-VS-Code. 
-
-```JSON
-  {
-        "type": "pwa-node",
-        "request": "launch",
-        "name": "Debug Dev Env",
-        "runtimeArgs": [
-            "-r",
-            "ts-node/register",
-            "-r",
-            "tsconfig-paths/register",
-        ],
-        "args": [
-            "${workspaceFolder:express-gen-ts}/src/index.ts"
-        ],
-        "resolveSourceMapLocations": [
-            "${workspaceFolder}/**",
-            "!**/node_modules/**"
-        ],
-   }
-```
-
-
 ## Note for windows users
 
 If you are on Windows, the `bcrypt` module tends to be fussy. To use this module on Windows you 

package/lib/express-generator-typescript.js

@@ -20,13 +20,14 @@ const PROJECT_FOLDER_PATH = './project-files';
 // Project-folder dependencies
 const DEPENDENCIES = 'express dotenv morgan cookie-parser jet-logger ' +
   'module-alias express-async-errors helmet jsonfile inserturlparams ' + 
-  'ts-command-line-args jet-paths moment',
+  'jet-paths moment',
   DEPENDENCIES_AUTH = ' bcrypt jsonwebtoken',
   DEV_DEPENDENCIES = 'ts-node typescript nodemon find jasmine supertest ' +
     '@types/node @types/express @types/jasmine @types/find @types/morgan  ' +
     '@types/cookie-parser @types/supertest fs-extra tsconfig-paths ' +
     '@types/jsonfile @typescript-eslint/eslint-plugin eslint ' +
-    '@typescript-eslint/parser @types/fs-extra eslint-plugin-node',
+    '@typescript-eslint/parser @types/fs-extra eslint-plugin-node ' + 
+    'ts-command-line-args',
   DEV_DEPENDENCIES_AUTH = ' @types/bcrypt @types/jsonwebtoken';
 
 // "ncp" options

package/lib/project-files/.eslintignore

@@ -1,2 +1,2 @@
 src/public/
-dotenv.config.js
+preload.js

package/lib/project-files/package.json

@@ -2,18 +2,14 @@
   "name": "express-typescript-example",
   "version": "0.0.0",
   "scripts": {
-    "_ts": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register -r ./dotenv.config.js",
-    "build": "npx ts-node build.ts",
-    "dev": "npm run _ts -- ./src",
-    "dev:hot": "nodemon",
+    "build": "ts-node ./scripts/build.ts",
+    "dev": "NODE_ENV=development ts-node ./src",
+    "dev:hot": "nodemon --exec \"npm run dev\" --watch ./src -e ts",
     "lint": "npx eslint --ext .ts src/",
     "lint:tests": "npx eslint --ext .ts spec/",
-    "start": "NODE_ENV=production node -r module-alias/register -r ./dotenv.config.js ./dist",
-    "test": "NODE_ENV=test npm run _ts -- ./spec",
-    "test:hot": "nodemon --config ./nodemon.spec.json"
-  },
-  "_moduleAliases": {
-    "@src": "dist"
+    "start": "NODE_ENV=production node -r ./preload.js ./dist",
+    "test": "NODE_ENV=test ts-node ./spec",
+    "test:hot": "nodemon --exec \"npm run test\" --watch ./src --watch ./spec -e ts"
   },
   "engines": {
     "node": ">=8.10.0"
@@ -32,8 +28,7 @@
     "jsonwebtoken": "^8.5.1",
     "module-alias": "^2.2.2",
     "moment": "^2.30.1",
-    "morgan": "^1.10.0",
-    "ts-command-line-args": "^2.4.2"
+    "morgan": "^1.10.0"
   },
   "devDependencies": {
     "@types/bcrypt": "^5.0.0",
@@ -56,6 +51,7 @@
     "jasmine": "^4.3.0",
     "nodemon": "^2.0.19",
     "supertest": "^6.3.4",
+    "ts-command-line-args": "^2.4.2",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.1.0",
     "typescript": "^4.8.2"

package/lib/project-files/preload.js

@@ -0,0 +1,20 @@
+const dotenv = require('dotenv');
+const path = require('path');
+const moduleAlias = require('module-alias');
+
+
+// Check the env
+const NODE_ENV = (process.env.NODE_ENV || 'development');
+
+// Configure "dotenv"
+const result2 = dotenv.config({
+  path: path.join(__dirname, `./env/${NODE_ENV}.env`),
+});
+if (result2.error) {
+  throw result2.error;
+}
+
+// Configure module-alias
+if (NODE_ENV === 'production') {
+  moduleAlias.addAlias('@src', __dirname + '/dist');
+}

package/lib/project-files/{build.ts → scripts/build.ts}

@@ -14,11 +14,11 @@ import childProcess from 'child_process';
   try {
     // Remove current build
     await remove('./dist/');
-    // Copy front-end files
+    await exec('npx eslint --ext .ts src/', './');
+    await exec('tsc --build tsconfig.prod.json', './');
+    // Copy
     await copy('./src/public', './dist/public');
     await copy('./src/views', './dist/views');
-    // Copy back-end files
-    await exec('tsc --build tsconfig.prod.json', './');
   } catch (err) {
     logger.err(err);
     process.exit(1);

package/lib/project-files/src/repos/database.json

@@ -1,22 +1 @@
-{
-  "users": [
-    {
-      "id": 366115170645,
-      "name": "Sean Maxwell",
-      "email": "smaxwell@example.com",
-      "created": "2024-03-22T05:14:36.252Z"
-    },
-    {
-      "id": 310946254456,
-      "name": "John Smith",
-      "email": "john.smith@example.com",
-      "created": "2024-03-22T05:20:55.079Z"
-    },
-    {
-      "id": 143027113460,
-      "name": "Gordan Freeman",
-      "email": "nova@prospect.com",
-      "created": "2024-03-22T05:42:18.895Z"
-    }
-  ]
-}
+{"users":[{"id":366115170645,"name":"Sean Maxwell","email":"smaxwell@example.com","created":"2024-03-22T05:14:36.252Z"},{"id":310946254456,"name":"John Smith","email":"john.smith@example.com","created":"2024-03-22T05:20:55.079Z"},{"id":143027113460,"name":"Gordan Freeman","email":"nova@prospect.com","created":"2024-03-22T05:42:18.895Z"}]}

package/lib/project-files/tsconfig.json

@@ -72,10 +72,13 @@
     },
     "useUnknownInCatchVariables": false
   },
+  "ts-node": {
+    "require": ["tsconfig-paths/register", "./preload.js"]
+  },
   "include": [
     "src/**/*.ts",
     "spec/**/*.ts",
-    "build.ts"
+    "scripts"
   ],
   "exclude": [
     "src/public/"

package/lib/project-files/tsconfig.prod.json

@@ -7,6 +7,6 @@
   "exclude": [
     "spec",
     "src/public/",
-    "build.ts"
+    "scripts"
   ]
 }

package/lib/project-files-auth/.eslintignore

@@ -1,2 +1,2 @@
 src/public/
-dotenv.config.js
+preload.js

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

@@ -2,18 +2,14 @@
   "name": "express-typescript-example",
   "version": "0.0.0",
   "scripts": {
-    "_ts": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register -r ./dotenv.config.js",
-    "build": "npx ts-node build.ts",
-    "dev": "npm run _ts -- ./src",
-    "dev:hot": "nodemon",
+    "build": "ts-node ./scripts/build.ts",
+    "dev": "NODE_ENV=development ts-node ./src",
+    "dev:hot": "nodemon --exec \"npm run dev\" --watch ./src -e ts",
     "lint": "npx eslint --ext .ts src/",
     "lint:tests": "npx eslint --ext .ts spec/",
-    "start": "NODE_ENV=production node -r module-alias/register -r ./dotenv.config.js ./dist",
-    "test": "NODE_ENV=test npm run _ts -- ./spec",
-    "test:hot": "nodemon --config ./nodemon.spec.json"
-  },
-  "_moduleAliases": {
-    "@src": "dist"
+    "start": "NODE_ENV=production node -r ./preload.js ./dist",
+    "test": "NODE_ENV=test ts-node ./spec",
+    "test:hot": "nodemon --exec \"npm run test\" --watch ./src --watch ./spec -e ts"
   },
   "engines": {
     "node": ">=8.10.0"
@@ -32,8 +28,7 @@
     "jsonwebtoken": "^8.5.1",
     "module-alias": "^2.2.2",
     "moment": "^2.30.1",
-    "morgan": "^1.10.0",
-    "ts-command-line-args": "^2.4.2"
+    "morgan": "^1.10.0"
   },
   "devDependencies": {
     "@types/bcrypt": "^5.0.0",
@@ -56,6 +51,7 @@
     "jasmine": "^4.3.0",
     "nodemon": "^2.0.19",
     "supertest": "^6.3.4",
+    "ts-command-line-args": "^2.4.2",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.1.0",
     "typescript": "^4.8.2"

package/lib/project-files-auth/preload.js

@@ -0,0 +1,20 @@
+const dotenv = require('dotenv');
+const path = require('path');
+const moduleAlias = require('module-alias');
+
+
+// Check the env
+const NODE_ENV = (process.env.NODE_ENV || 'development');
+
+// Configure "dotenv"
+const result2 = dotenv.config({
+  path: path.join(__dirname, `./env/${NODE_ENV}.env`),
+});
+if (result2.error) {
+  throw result2.error;
+}
+
+// Configure module-alias
+if (NODE_ENV === 'production') {
+  moduleAlias.addAlias('@src', __dirname + '/dist');
+}

package/lib/project-files-auth/{build.ts → scripts/build.ts}

@@ -14,9 +14,9 @@ import childProcess from 'child_process';
   try {
     // Remove current build
     await remove('./dist/');
-    // Copy back-end files
+    await exec('npx eslint --ext .ts src/', './');
     await exec('tsc --build tsconfig.prod.json', './');
-    // Copy front-end files
+    // Copy
     await copy('./src/public', './dist/public');
     await copy('./src/views', './dist/views');
   } catch (err) {

package/lib/project-files-auth/tsconfig.json

@@ -72,10 +72,13 @@
     },
     "useUnknownInCatchVariables": false
   },
+  "ts-node": {
+    "require": ["tsconfig-paths/register", "./preload.js"]
+  },
   "include": [
     "src/**/*.ts",
     "spec/**/*.ts",
-    "build.ts"
+    "scripts"
   ],
   "exclude": [
     "src/public/"

package/lib/project-files-auth/tsconfig.prod.json

@@ -7,6 +7,6 @@
   "exclude": [
     "spec",
     "src/public/",
-    "build.ts"
+    "scripts"
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.4.17",
+  "version": "2.4.19",
   "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/dotenv.config.js

@@ -1,16 +0,0 @@
-var dotenv = require('dotenv');
-var path = require('path');
-
-
-// Check the env
-var NODE_ENV = process.env.NODE_ENV || 'development';
-
-// Configure the file
-const result2 = dotenv.config({
-  path: path.join(__dirname, `./env/${NODE_ENV}.env`),
-});
-
-// Check for errors
-if (result2.error) {
-  throw result2.error;
-}

package/lib/project-files/nodemon.json

@@ -1,10 +0,0 @@
-{
-  "watch": [
-    "src"
-  ],
-  "ext": "ts, html",
-  "ignore": [
-    "src/public"
-  ],
-  "exec": "npm run dev"
-}

package/lib/project-files/nodemon.spec.json

@@ -1,6 +0,0 @@
-{
-  "watch": ["spec"],
-  "ext": "spec.ts",
-  "ignore": ["spec/support"],
-  "exec": "npm run test"
-}

package/lib/project-files-auth/dotenv.config.js

@@ -1,16 +0,0 @@
-var dotenv = require('dotenv');
-var path = require('path');
-
-
-// Check the env
-var NODE_ENV = process.env.NODE_ENV || 'development';
-
-// Configure the file
-const result2 = dotenv.config({
-  path: path.join(__dirname, `./env/${NODE_ENV}.env`),
-});
-
-// Check for errors
-if (result2.error) {
-  throw result2.error;
-}

package/lib/project-files-auth/nodemon.json

@@ -1,10 +0,0 @@
-{
-  "watch": [
-    "src"
-  ],
-  "ext": "ts, html",
-  "ignore": [
-    "src/public"
-  ],
-  "exec": "npm run dev"
-}

package/lib/project-files-auth/nodemon.spec.json

@@ -1,6 +0,0 @@
-{
-  "watch": ["spec"],
-  "ext": "spec.ts",
-  "ignore": ["spec/support"],
-  "exec": "npm run test"
-}

package/lib/project-files-auth/spec/nodemon.json

@@ -1,6 +0,0 @@
-{
-  "watch": ["spec"],
-  "ext": "spec.ts",
-  "ignore": ["spec/support"],
-  "exec": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register ./spec"
-}