npm - express-generator-typescript - Versions diffs - 2.7.1 → 2.7.3 - Mend

express-generator-typescript 2.7.1 → 2.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (36) hide show

package/LICENSE +21 -21
package/README-npm +20 -0
package/README.md +85 -20
package/lib/project-files/README.md +65 -65
package/lib/project-files/config.ts +22 -22
package/lib/project-files/eslint.config.ts +95 -95
package/lib/project-files/package.json +58 -58
package/lib/project-files/src/common/constants/ENV.ts +21 -21
package/lib/project-files/src/common/constants/HttpStatusCodes.ts +391 -391
package/lib/project-files/src/common/constants/Paths.ts +11 -11
package/lib/project-files/src/common/constants/index.ts +11 -11
package/lib/project-files/src/common/util/route-errors.ts +37 -37
package/lib/project-files/src/common/util/validators.ts +22 -22
package/lib/project-files/src/index.ts +17 -4
package/lib/project-files/src/models/User.ts +4 -4
package/lib/project-files/src/models/common/types/index.ts +5 -5
package/lib/project-files/src/public/scripts/http.js +26 -26
package/lib/project-files/src/public/scripts/users.js +141 -141
package/lib/project-files/src/public/stylesheets/users.css +48 -48
package/lib/project-files/src/repos/MockOrm.ts +62 -62
package/lib/project-files/src/repos/database.json +1 -1
package/lib/project-files/src/repos/database.test.json +1 -22
package/lib/project-files/src/routes/common/types/index.ts +11 -11
package/lib/project-files/src/routes/common/util/index.ts +18 -18
package/lib/project-files/src/routes/index.ts +33 -33
package/lib/project-files/src/services/UserService.ts +73 -73
package/lib/project-files/src/views/users.html +132 -132
package/lib/project-files/tests/common/Paths.ts +5 -5
package/lib/project-files/tests/common/types/index.ts +16 -16
package/lib/project-files/tests/common/util/index.ts +38 -38
package/lib/project-files/tests/support/setup.ts +26 -26
package/lib/project-files/tsconfig.json +1 -1
package/lib/project-files/tsconfig.prod.json +30 -30
package/lib/project-files/{vitest.config.ts → vitest.config.mts} +18 -18
package/package.json +1 -1
package/README-git +0 -95

package/lib/project-files/src/views/users.html CHANGED Viewed

@@ -1,132 +1,132 @@
-<!DOCTYPE html>
-<html lang="en">
-  <!-- Head -->
-  <head>
-    <meta charset="UTF-8">
-    <title>Users</title>
-    <link rel="stylesheet" type="text/css" href="/stylesheets/users.css" />
-    <!-- Handlebars -->
-    <script src="http://cdnjs.cloudflare.com/ajax/libs/handlebars.js/4.7.8/handlebars.min.js"></script>
-    <!-- Bootstrap -->
-    <link
-      href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css"
-      rel="stylesheet"
-      integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
-      crossorigin="anonymous"
-    />
-    <script
-      src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
-      integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
-      crossorigin="anonymous"
-    ></script>
-  </head>
-  <!-- Body -->
-  <body>
-    <!-- Add Users -->
-    <div class="users-column add-user-col">
-      <div class="column-header">
-        Add User:
-      </div>
-      <div>
-        <input
-          id="name-input"
-          type="text"
-          class="form-control"
-          placeholder="Name"
-        />
-      </div>
-      <div>
-        <input
-          id="email-input"
-          type="email"
-          class="form-control"
-          placeholder="Email"
-        />
-      </div>
-      <div>
-        <button
-          id="add-user-btn"
-          class="btn btn-success"
-        >
-          Add
-        </button>
-      </div>
-    </div>
-    <!-- Display Users -->
-    <div class="users-column">
-      <div class="column-header">
-        Users:
-      </div>
-      <div id="all-users-anchor"></div>
-      <script
-        id="all-users-template"
-        type="text/x-handlebars-template"
-      >
-        {{#each users}}
-          <div class="user-display-ele">
-            <div class="normal-view">
-              <div><b>Name:</b> {{name}}</div>
-              <div><b>Email:</b> {{email}}</div>
-              <div><b>Created:</b> {{createdFormatted}}</div>
-              <button
-                type="button"
-                class="btn btn-primary edit-user-btn"
-                data-user-id="{{id}}"
-              >
-                Edit
-              </button>
-              <button
-                class="btn btn-danger delete-user-btn"
-                data-user-id="{{id}}"
-              >
-                Delete
-              </button>
-            </div>
-            <div class="edit-view">
-              <div>
-                Name:&nbsp;
-                <input
-                  type="text"
-                  class="form-control name-edit-input"
-                  value="{{name}}"
-                />
-              </div>
-              <div class="email-edit">
-                Email:&nbsp;
-                <input
-                  type="email"
-                  class="form-control email-edit-input"
-                  value="{{email}}"
-                />
-              </div>
-              <button
-                class="btn btn-primary submit-edit-btn"
-                data-user-id="{{id}}"
-                data-user-created="{{created}}"
-              >
-                Submit
-              </button>
-              <button
-                class="btn btn-secondary cancel-edit-btn"
-                data-user-id="{{id}}"
-              >
-                Cancel
-              </button>
-            </div>
-          </div>
-        {{/each}}
-      </script>
-    </div>
-  </body>
-  <script src="scripts/http.js"></script>
-  <script src="scripts/users.js"></script>
-</html>
+<!DOCTYPE html>
+<html lang="en">
+  <!-- Head -->
+  <head>
+    <meta charset="UTF-8">
+    <title>Users</title>
+    <link rel="stylesheet" type="text/css" href="/stylesheets/users.css" />
+    <!-- Handlebars -->
+    <script src="http://cdnjs.cloudflare.com/ajax/libs/handlebars.js/4.7.8/handlebars.min.js"></script>
+    <!-- Bootstrap -->
+    <link
+      href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css"
+      rel="stylesheet"
+      integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
+      crossorigin="anonymous"
+    />
+    <script
+      src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
+      integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
+      crossorigin="anonymous"
+    ></script>
+  </head>
+  <!-- Body -->
+  <body>
+    <!-- Add Users -->
+    <div class="users-column add-user-col">
+      <div class="column-header">
+        Add User:
+      </div>
+      <div>
+        <input
+          id="name-input"
+          type="text"
+          class="form-control"
+          placeholder="Name"
+        />
+      </div>
+      <div>
+        <input
+          id="email-input"
+          type="email"
+          class="form-control"
+          placeholder="Email"
+        />
+      </div>
+      <div>
+        <button
+          id="add-user-btn"
+          class="btn btn-success"
+        >
+          Add
+        </button>
+      </div>
+    </div>
+    <!-- Display Users -->
+    <div class="users-column">
+      <div class="column-header">
+        Users:
+      </div>
+      <div id="all-users-anchor"></div>
+      <script
+        id="all-users-template"
+        type="text/x-handlebars-template"
+      >
+        {{#each users}}
+          <div class="user-display-ele">
+            <div class="normal-view">
+              <div><b>Name:</b> {{name}}</div>
+              <div><b>Email:</b> {{email}}</div>
+              <div><b>Created:</b> {{createdFormatted}}</div>
+              <button
+                type="button"
+                class="btn btn-primary edit-user-btn"
+                data-user-id="{{id}}"
+              >
+                Edit
+              </button>
+              <button
+                class="btn btn-danger delete-user-btn"
+                data-user-id="{{id}}"
+              >
+                Delete
+              </button>
+            </div>
+            <div class="edit-view">
+              <div>
+                Name:&nbsp;
+                <input
+                  type="text"
+                  class="form-control name-edit-input"
+                  value="{{name}}"
+                />
+              </div>
+              <div class="email-edit">
+                Email:&nbsp;
+                <input
+                  type="email"
+                  class="form-control email-edit-input"
+                  value="{{email}}"
+                />
+              </div>
+              <button
+                class="btn btn-primary submit-edit-btn"
+                data-user-id="{{id}}"
+                data-user-created="{{created}}"
+              >
+                Submit
+              </button>
+              <button
+                class="btn btn-secondary cancel-edit-btn"
+                data-user-id="{{id}}"
+              >
+                Cancel
+              </button>
+            </div>
+          </div>
+        {{/each}}
+      </script>
+    </div>
+  </body>
+  <script src="scripts/http.js"></script>
+  <script src="scripts/users.js"></script>
+</html>

package/lib/project-files/tests/common/Paths.ts CHANGED Viewed

@@ -1,5 +1,5 @@
-import jetPaths from 'jet-paths';
-import Paths from '@src/common/constants/Paths';
-export default jetPaths(Paths);
+import jetPaths from 'jet-paths';
+import Paths from '@src/common/constants/Paths';
+export default jetPaths(Paths);

package/lib/project-files/tests/common/types/index.ts CHANGED Viewed

@@ -1,16 +1,16 @@
-import { Response } from 'supertest';
-/******************************************************************************
-                                Types
-******************************************************************************/
-// Use generics to add properties to 'body'
-export type TRes<T = object> = Omit<Response, 'body'> & {
-  body: T & { error?: string | IErrObj },
-};
-interface IErrObj {
-  message: string;
-  [key: string]: unknown;
-}
+import { Response } from 'supertest';
+/******************************************************************************
+                                Types
+******************************************************************************/
+// Use generics to add properties to 'body'
+export type TRes<T = object> = Omit<Response, 'body'> & {
+  body: T & { error?: string | IErrObj },
+};
+interface IErrObj {
+  message: string;
+  [key: string]: unknown;
+}

package/lib/project-files/tests/common/util/index.ts CHANGED Viewed

@@ -1,38 +1,38 @@
-import { Response } from 'supertest';
-import { IParseObjectError, parseJson } from 'jet-validators/utils';
-import { isString } from 'jet-validators';
-/******************************************************************************
-                                Types
-******************************************************************************/
-// Use generics to add properties to 'body'
-export type TRes<T = object> = Omit<Response, 'body'> & {
-  body: T & { error?: string | IErrObj },
-};
-interface IErrObj {
-  message: string;
-  [key: string]: unknown;
-}
-interface IValidationErr {
-  message: string;
-  errors: IParseObjectError[];
-}
-/******************************************************************************
-                                Functions
-******************************************************************************/
-/**
- * JSON parse a validation error.
- */
-export function parseValidationErr(arg: unknown): IValidationErr {
-  if (!isString(arg)) {
-    throw new Error('Not a string');
-  }
-  return parseJson<IValidationErr>(arg);
-}
+import { Response } from 'supertest';
+import { IParseObjectError, parseJson } from 'jet-validators/utils';
+import { isString } from 'jet-validators';
+/******************************************************************************
+                                Types
+******************************************************************************/
+// Use generics to add properties to 'body'
+export type TRes<T = object> = Omit<Response, 'body'> & {
+  body: T & { error?: string | IErrObj },
+};
+interface IErrObj {
+  message: string;
+  [key: string]: unknown;
+}
+interface IValidationErr {
+  message: string;
+  errors: IParseObjectError[];
+}
+/******************************************************************************
+                                Functions
+******************************************************************************/
+/**
+ * JSON parse a validation error.
+ */
+export function parseValidationErr(arg: unknown): IValidationErr {
+  if (!isString(arg)) {
+    throw new Error('Not a string');
+  }
+  return parseJson<IValidationErr>(arg);
+}

package/lib/project-files/tests/support/setup.ts CHANGED Viewed

@@ -1,26 +1,26 @@
-import { beforeAll } from 'vitest';
-import supertest, { Test } from 'supertest';
-import TestAgent from 'supertest/lib/agent';
-import app from '@src/server';
-import MockOrm from '@src/repos/MockOrm';
-/******************************************************************************
-                                    Run
-******************************************************************************/
-let agent: TestAgent<Test>;
-beforeAll(async () => {
-  agent = supertest.agent(app);
-  await MockOrm.cleanDb();
-});
-/******************************************************************************
-                                    Export
-******************************************************************************/
-export { agent };
+import { beforeAll } from 'vitest';
+import supertest, { Test } from 'supertest';
+import TestAgent from 'supertest/lib/agent';
+import app from '@src/server';
+import MockOrm from '@src/repos/MockOrm';
+/******************************************************************************
+                                    Run
+******************************************************************************/
+let agent: TestAgent<Test>;
+beforeAll(async () => {
+  agent = supertest.agent(app);
+  await MockOrm.cleanDb();
+});
+/******************************************************************************
+                                    Export
+******************************************************************************/
+export { agent };

package/lib/project-files/tsconfig.json CHANGED Viewed

@@ -27,7 +27,7 @@
     "config.ts",
     "scripts",
     "eslint.config.ts",
-    "vitest.config.ts"
+    "vitest.config.mts"
   ],
   "exclude": [
     "src/public/*"

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

@@ -1,30 +1,30 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "CommonJS",
-    "lib": ["ES2020"],
-    "strict": true,
-    "baseUrl": "./",
-    "outDir": "temp",
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "paths": {
-      "@src/*": ["src/*"]
-    },
-    "useUnknownInCatchVariables": false,
-    "sourceMap": false,
-    "removeComments": true
-  },
-  "include": [
-    "src/**/*.ts",
-    "config.ts"
-  ],
-  "exclude": [
-    "tests",
-    "src/public/",
-    "scripts",
-    "eslint.config.ts",
-    "vitest.config.js"
-  ]
-}
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "lib": ["ES2020"],
+    "strict": true,
+    "baseUrl": "./",
+    "outDir": "temp",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "paths": {
+      "@src/*": ["src/*"]
+    },
+    "useUnknownInCatchVariables": false,
+    "sourceMap": false,
+    "removeComments": true
+  },
+  "include": [
+    "src/**/*.ts",
+    "config.ts"
+  ],
+  "exclude": [
+    "tests",
+    "src/public/",
+    "scripts",
+    "eslint.config.ts",
+    "vitest.config.js"
+  ]
+}

package/lib/project-files/{vitest.config.ts → vitest.config.mts} RENAMED Viewed

@@ -1,18 +1,18 @@
-import { defineConfig } from 'vitest/config';
-import path from 'path';
-const config = defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-    setupFiles: ['config.ts', './tests/support/setup.ts'],
-    isolate: true,
-  },
-  resolve: {
-    alias: {
-      '@src': path.resolve(__dirname, './src'),
-    },
-  },
-});
-export default config;
+import { defineConfig } from 'vitest/config';
+import path from 'path';
+const config = defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    setupFiles: ['config.ts', './tests/support/setup.ts'],
+    isolate: true,
+  },
+  resolve: {
+    alias: {
+      '@src': path.resolve(__dirname, './src'),
+    },
+  },
+});
+export default config;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.7.1",
+  "version": "2.7.3",
   "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/README-git DELETED Viewed

@@ -1,95 +0,0 @@
-<img alt='overnightjs' src='https://github.com/seanpmaxwell/express-generator-typescript/raw/master/express-typescript.png' border='0'>
-[Express](https://www.npmjs.com/package/express) with [TypeScript's](https://www.npmjs.com/package/typescript) application generator.
-<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/v/express-generator-typescript.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/l/express-generator-typescript.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/dm/express-generator-typescript.svg" alt="NPM Downloads" /></a>
-## 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.
-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.
-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.
-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.
-### `--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
-```sh
-$ Just use 'npx'
-  Or
-$ 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`.
-Create the app:<br/>
-With no options: `$ npx express-generator-typescript`<br/>
-With all options (order doesn't matter): `$ npx express-generator-typescript --use-yarn "project name"`
-Start your express-generator-typescript app in development mode at `http://localhost:3000/`:
-```bash
-$ cd "project name" && npm run dev
-```
-## Available commands for the server.
-- 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`.
-## Note for VSCode 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/>
-Happy web deving :)
-## License
-[MIT](LICENSE)