express-generator-typescript 2.4.25 → 2.5.0

package/README.md

@@ -9,39 +9,29 @@
 
 ## What is it?
 
-Creates a new express application similar to the _express-generator_ module. Except this new
-application is configured to use TypeScript instead of plain JavaScript. 
+Creates a new express application similar to the _express-generator_ module. Except this new application is configured to use TypeScript instead of plain JavaScript. 
 
 This project complies with Typescript best practices listed <a href="https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md">here</a>.
 
 
 ## Why express-generator-typescript?
 
-NodeJS is great for the rapid development of web-projects, but is often neglected because of the lack of
-type safety. TypeScript solves this issue and (along with its linter file) can even make your code
-more robust than some other static languages like Java.
+NodeJS is great for the rapid development of web-projects, but is often neglected because of the lack of type safety. TypeScript solves this issue and (along with its linter file) can even make your code more robust than some other static languages like Java.
 
-There are some other tools out there to generate express apps with TypeScript such as 
-_express-generator-ts_, but these either haven't been updated in a while or install a lot of junk 
-in your project (such as an ORM). 
+There are some other tools out there to generate express apps with TypeScript such as _express-generator-ts_, but these either haven't been updated in a while or install a lot of junk in your project (such as an ORM). 
 
-Due to the heavy use of single-page-applications, no view-engine is configured by default. Express is 
-only setup with the minimal settings for calling APIs and serving an index.html file. All the tools you 
-need to run for development (while restarting on changes), building, testing, and running for production 
-are packaged with this library. 
+Due to the heavy use of single-page-applications, no view-engine is configured by default. Express is only setup with the minimal settings for calling APIs and serving an index.html file. All the tools you need to run for development (while restarting on changes), building, testing, and running for production 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 _preload.js_ if you want to add/edit the relative paths.
+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 _preload.js_ if you want to add/edit the relative paths.
 
 
 ## Sample-project
 
-When you run _express-generator-typescript_, it sets up a simple application with routes for
-adding, updating, deleting, and fetching user objects. This is just to demonstrate how routing is done
-with express. 
+When you run _express-generator-typescript_, it sets up a simple application with routes for adding, updating, deleting, and fetching user objects. This is just to demonstrate how routing is done with express. 
 
-If you want a fully-secure application, you can pass the `--with-auth` option and you will have an application which requires you to login before calling APIs on user objects. The app is configured with production quality client-side security and uses signed-cookies and jsonwebtokens to store user-session data. If you're new to web-development and still learning about securing websites, I highly encourage to use this option.
+### `--with-auth` option no longer available for version 2.5+
+
+For the command-line, you used to be able to pass the `--with-auth` option to generate an app which required a login before using the routes; however, maintaining two separate projects became quite cumbersome. If you want an example of how to do authentication in expressjs with json-web-tokens you can refer to this sample project <a href="https://github.com/seanpmaxwell/express-jsonwebtoken-demo">here</a>.
 
 
 ## Installation
@@ -55,9 +45,7 @@ $ npm install -g express-generator-typescript
 
 ## Quick Start
 
-The quickest way to get started is use npx and pass in the name of the project you want to create.
-If you don't specify a project name, the default _express-gen-ts_ will be used instead. If you
-want to use `yarn` instead of `npm`, pass the option `--use-yarn`.
+The quickest way to get started is use npx and pass in the name of the project you want to create. If you don't specify a project name, the default _express-gen-ts_ will be used instead. If you want to use `yarn` instead of `npm`, pass the option `--use-yarn`.
 
 Create the app:<br/>
 With no options: `$ npx express-generator-typescript`<br/>
@@ -73,28 +61,31 @@ $ cd "project name" && npm run dev
 
 ## Available commands for the server.
 
-- Run the server in development mode: `npm run dev`.
-- Run all unit-tests: `npm test`.
+- Run the server in development mode: `npm run dev` or `npm run dev:hot`.
+- Run all unit-tests: `npm run test` or `npm run test:hot`.
 - Run a single unit-test: `npm test -- --testFile="name of test file" (i.e. --testFile=Users)`.
 - Check for linting errors: `npm run lint`.
 - Build the project for production: `npm run build`.
 - Run the production build: `npm start`.
+- Check for typescript errors: `npm run type-check"`.
 
 
 ## Debugging
 
-During development, _express-generator-typescript_ uses `nodemon` to restart the server when changes
-are detected. If you want to enable debugging for node, you'll need to modify the nodemon configurations.
-This is located under `nodemonConfig:` in `package.json` for the server and `./spec/nodemon.json` for
-unit-testing. For the `exec` property, replace `ts-node` with `node --inspect -r ts-node/register`.
+During development, _express-generator-typescript_ uses `nodemon` to restart the server when changes are detected. If you want to enable debugging for node, you'll need to modify the nodemon configurations. This is located under `nodemonConfig:` in `package.json` for the server and `./spec/nodemon.json` for unit-testing. For the `exec` property, replace `ts-node` with `node --inspect -r ts-node/register`.
+
 
+## Note for VSCode users
 
-## Note for windows users
+In order to use eslint as a typescript file with VSCode, you need to add a setting to your eslint options. At the root of your project, add a `.vscode/settings.json` file (if you don't have one already) and add the option `unstable_ts_config`:
+
+```typescript
+  "eslint.options": {
+    "flags": ["unstable_ts_config"]
+  }
+```
+<br/>
 
-If you are on Windows, the `bcrypt` module tends to be fussy. To use this module on Windows you 
-need to make sure you have the node Windows build tools installed. I don't want to post instructions 
-because they might change frequently. I would search the Microsoft docs on how to setup Node for Windows. 
-To be able to debug in VSCODE on windows I also had to install the `node-gyp` module globally as well.
 
 Happy web deving :)
 

package/lib/cli.js

@@ -1,22 +1,13 @@
 #!/usr/bin/env node
 
-/**
- * Create new express-generator-typescript project.
- *
- * created by Sean Maxwell, 5/31/2019
- */
+const path = require('path'),
+  expressGenTs = require('../lib/express-generator-typescript');
 
-const path = require('path');
-const expressGenTs = require('../lib/express-generator-typescript');
 
+//  **** Run Script **** //
 
-//  **** Start **** //
-
+// Init
 console.log('Setting up new Express/TypeScript project...');
-
-
-// **** Process Options **** //
-
 const args = process.argv.slice(2);
 
 // Setup use yarn
@@ -27,14 +18,6 @@ if (useYarnIdx > -1) {
   args.splice(useYarnIdx, 1);
 }
 
-// Setup include authentication
-let withAuth = false;
-const withAuthIdx = args.indexOf('--with-auth');
-if (withAuthIdx > -1) {
-  withAuth = true;
-  args.splice(withAuthIdx, 1);
-}
-
 // Setup destination
 let destination = 'express-gen-ts';
 if (args.length > 0) {
@@ -42,10 +25,7 @@ if (args.length > 0) {
 }
 destination = path.join(process.cwd(), destination);
 
-
-// **** Call the generator script **** //
-
 // Creating new project finished
-expressGenTs(destination, useYarn, withAuth).then(() => {
+expressGenTs(destination, useYarn).then(() => {
   console.log('Project setup complete!');
 });

package/lib/express-generator-typescript.js

@@ -8,20 +8,17 @@ const path = require('path'),
 // **** Variables **** //
 
 // Project folder paths
-const PROJECT_FOLDER_PATH = './project-files',
-  PROJECT_FOLDER_PATH_AUTH = './project-files-auth';
+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 ' + 
-  'jet-paths moment ',
-  DEPENDENCIES_AUTH = ' bcrypt jsonwebtoken',
+  'jet-paths dayjs jet-schema jet-env ',
   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 @types/fs-extra ' +
-    'eslint @eslint/js @types/eslint__js typescript-eslint eslint-plugin-n @stylistic/eslint-plugin-ts',
-  DEV_DEPENDENCIES_AUTH = ' @types/bcrypt @types/jsonwebtoken';
+    '@types/cookie-parser @types/supertest fs-extra tsconfig-paths jiti @swc/core ' +
+    '@types/jsonfile @types/fs-extra @types/module-alias @stylistic/eslint-plugin-js ' +
+    'eslint @eslint/js @types/eslint__js typescript-eslint eslint-plugin-n @stylistic/eslint-plugin-ts';
 
 // "ncp" options
 const ncpOpts = {
@@ -36,12 +33,12 @@ const ncpOpts = {
 /**
  * Entry point
  */
-async function expressGenTs(destination, useYarn, withAuth) {
+async function expressGenTs(destination, useYarn) {
   try {
-    await copyProjectFiles(destination, withAuth);
+    await copyProjectFiles(destination);
     updatePackageJson(destination);
     await renameGitigoreFile(destination);
-    downloadNodeModules(destination, useYarn, withAuth);
+    downloadNodeModules(destination, useYarn);
   } catch (err) {
     console.error(err);
   }
@@ -50,9 +47,8 @@ async function expressGenTs(destination, useYarn, withAuth) {
 /**
  * Copy project files
  */
-function copyProjectFiles(destination, withAuth) {
-  const folder = (withAuth ? PROJECT_FOLDER_PATH_AUTH : PROJECT_FOLDER_PATH),
-    source = path.join(__dirname, folder);
+function copyProjectFiles(destination) {
+  const source = path.join(__dirname, PROJECT_FOLDER_PATH);
   return /** @type {Promise<void>} */(new Promise((res, rej) => {
     return ncp(source, destination, ncpOpts, (err) => {
       return (!!err ? rej(err) : res());
@@ -88,15 +84,11 @@ function renameGitigoreFile(destination) {
 /**
  * Download the dependencies.
  */
-function downloadNodeModules(destination, useYarn, withAuth) {
+function downloadNodeModules(destination, useYarn) {
   const options = { cwd: destination };
   // Setup dependencies string
   let depStr = DEPENDENCIES,
     devDepStr = DEV_DEPENDENCIES;
-  if (withAuth) {
-    depStr += DEPENDENCIES_AUTH;
-    devDepStr += DEV_DEPENDENCIES_AUTH;
-  }
   // Setup download command
   let downloadLibCmd,
     downloadDepCmd;

package/lib/project-files/README.md

@@ -5,31 +5,48 @@ This project was created with [express-generator-typescript](https://github.com/
 
 ## 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.
+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-auth/env/development.env → project-files/config/.env.development}

@@ -13,12 +13,3 @@ JET_LOGGER_FILEPATH=jet-logger.log
 JET_LOGGER_TIMESTAMP=TRUE
 JET_LOGGER_FORMAT=LINE
 
-
-## Authentication ##
-COOKIE_DOMAIN=localhost
-COOKIE_PATH=/
-SECURE_COOKIE=false
-JWT_SECRET=xxxxxxxxxxxxxx
-COOKIE_SECRET=xxxxxxxxxxxxxx
-# expires in 3 days
-COOKIE_EXP=259200000

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

@@ -0,0 +1,14 @@
+## Environment ##
+NODE_ENV=production
+
+
+## Server ##
+PORT=8081
+HOST=localhost
+
+
+## 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/{env/test.env → config/.env.test}

@@ -12,13 +12,3 @@ JET_LOGGER_MODE=CONSOLE
 JET_LOGGER_FILEPATH=jet-logger.log
 JET_LOGGER_TIMESTAMP=TRUE
 JET_LOGGER_FORMAT=LINE
-
-
-## Authentication ##
-COOKIE_DOMAIN=localhost
-COOKIE_PATH=/
-SECURE_COOKIE=false
-JWT_SECRET=xxxxxxxxxxxxxx
-COOKIE_SECRET=xxxxxxxxxxxxxx
-# expires in 3 days
-COOKIE_EXP=259200000

package/lib/project-files/config.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const dotenv_1 = __importDefault(require("dotenv"));
+const module_alias_1 = __importDefault(require("module-alias"));
+const NODE_ENV = (process.env.NODE_ENV ?? 'development');
+const result2 = dotenv_1.default.config({
+    path: path_1.default.join(__dirname, `./config/.env.${NODE_ENV}`),
+});
+if (result2.error) {
+    throw result2.error;
+}
+if (__filename.endsWith('js')) {
+    module_alias_1.default.addAlias('@src', __dirname + '/dist');
+}

package/lib/project-files/config.ts

@@ -0,0 +1,22 @@
+/* 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

@@ -0,0 +1,96 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import stylisticJs from '@stylistic/eslint-plugin-js';
+import stylisticTs from '@stylistic/eslint-plugin-ts';
+import nodePlugin from 'eslint-plugin-n';
+
+
+export default tseslint.config(
+  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/js': stylisticJs,
+      '@stylistic/ts': stylisticTs,
+    },
+  },
+  {
+    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',
+      '@typescript-eslint/no-unsafe-enum-comparison': 0,
+      '@typescript-eslint/no-unnecessary-type-parameters': 0,
+      '@stylistic/js/no-extra-semi': 'warn',
+      'max-len': [
+        'warn',
+        {
+          'code': 80,
+        },
+      ],
+      '@stylistic/ts/semi': ['warn', 'always'],
+      '@stylistic/ts/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,3 +1,5 @@
 **/node_modules
 dist/
+temp/
 **/**/*.log
+config.js

package/lib/project-files/package.json

@@ -2,35 +2,40 @@
   "name": "express-typescript-example",
   "version": "0.0.0",
   "scripts": {
-    "build": "npx ts-node ./scripts/build.ts",
-    "dev": "NODE_ENV=development npx ts-node ./src",
-    "dev:hot": "nodemon --exec \"npm run dev\" --watch ./src -e ts",
-    "lint": "npx eslint ./src",
-    "lint:tests": "npx eslint ./spec",
-    "start": "NODE_ENV=production node -r ./preload.js ./dist",
-    "test": "NODE_ENV=test npx ts-node ./spec",
-    "test:hot": "nodemon --exec \"npm run test\" --watch ./src --watch ./spec -e ts"
+    "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 --flag unstable_ts_config",
+    "start": "NODE_ENV=production node -r ./config.js ./dist",
+    "test": "NODE_ENV=test ts-node ./spec",
+    "test:hot": "nodemon --exec \"npm run test\" --watch ./src --watch ./spec --ext .ts",
+    "type-check": "tsc --noEmit"
   },
   "engines": {
     "node": ">=16.0.0"
   },
   "dependencies": {
     "cookie-parser": "^1.4.6",
+    "dayjs": "^1.11.13",
     "dotenv": "^16.0.2",
     "express": "^4.18.1",
     "express-async-errors": "^3.1.1",
     "helmet": "^6.0.0",
     "inserturlparams": "^1.0.1",
+    "jet-env": "^1.1.4",
     "jet-logger": "^1.3.1",
     "jet-paths": "^1.0.5",
+    "jet-schema": "^1.4.2",
     "jsonfile": "^6.1.0",
     "module-alias": "^2.2.2",
-    "moment": "^2.30.1",
     "morgan": "^1.10.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.11.1",
+    "@stylistic/eslint-plugin-js": "^2.11.0",
     "@stylistic/eslint-plugin-ts": "^2.8.0",
+    "@swc/core": "^1.9.3",
     "@types/cookie-parser": "^1.4.3",
     "@types/eslint__js": "^8.42.3",
     "@types/express": "^4.17.13",
@@ -38,6 +43,7 @@
     "@types/fs-extra": "^9.0.13",
     "@types/jasmine": "^4.3.0",
     "@types/jsonfile": "^6.1.0",
+    "@types/module-alias": "^2.0.4",
     "@types/morgan": "^1.9.3",
     "@types/node": "^18.7.14",
     "@types/supertest": "^6.0.2",
@@ -46,6 +52,7 @@
     "find": "^0.3.0",
     "fs-extra": "^10.1.0",
     "jasmine": "^4.3.0",
+    "jiti": "^2.4.1",
     "nodemon": "^2.0.19",
     "supertest": "^6.3.4",
     "ts-node": "^10.9.1",

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

@@ -15,6 +15,10 @@ import childProcess from 'child_process';
     // Copy
     await copy('./src/public', './dist/public');
     await copy('./src/views', './dist/views');
+    await copy('./src/repos/database.json', './dist/repos/database.json');
+    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

package/lib/project-files/spec/support/Paths.ts

@@ -1,10 +1,5 @@
-/**
- * Convert paths to full for testing.
- */
-
 import jetPaths from 'jet-paths';
-
-import Paths from '@src/common/Paths';
+import Paths from '@src/routes/common/Paths';
 
 
 export default jetPaths(Paths);

package/lib/project-files/spec/support/apiCb.ts

@@ -1,5 +1,5 @@
 import { CallbackHandler } from 'supertest';
-import moment from 'moment';
+import dayjs, { Dayjs } from 'dayjs';
 import logger from 'jet-logger';
 
 import { TApiCb, TRes } from 'spec/types/misc';
@@ -51,11 +51,7 @@ function _iterate(param: unknown, prop: string): void {
   }
   // Check valid string or Date object. If undefined just skip
   const val = paramF[prop];
-  if (
-    (typeof val !== 'undefined') && 
-    !((typeof val === 'string') || (val instanceof Date)) && 
-    !moment(val as string | Date).isValid()
-  ) {
+  if (val !== undefined && !_isValidDate(val)) {
     throw new Error('Property must be a valid date-string or Date() object');
   }
   // Convert and iterate
@@ -70,6 +66,22 @@ function _iterate(param: unknown, prop: string): void {
   }
 }
 
+/**
+ * Is date a valid date.
+ */
+function _isValidDate(date: unknown): boolean {
+  if (
+    typeof date === 'string' || 
+    (date instanceof Date) || 
+    (date instanceof Dayjs) || 
+    typeof date === 'number'
+  ) {
+    return dayjs(date).isValid();
+  } else {
+    return false;
+  }
+}
+
 
 // **** Export default **** //