Merge pull request #46 from ljlm0402/development

ljlm0402 · web-flow · commit e4c24d1bd35b · 2020-11-27T12:41:17.000+09:00
Development
diff --git a/.github/ISSUE_TEMPLATE/bug-report---.md b/.github/ISSUE_TEMPLATE/bug-report---.md
@@ -1,8 +1,8 @@
 ---
-name: "Bug report \U0001F41B"
-about: Create a report to help us improve
+name: "Bug Report \U0001F41B"
+about: "Create a report to help us improve"
 title: ""
-labels: bug
+labels: "Bug"
 assignees: ""
 ---
 
diff --git a/.github/ISSUE_TEMPLATE/feature-request---.md b/.github/ISSUE_TEMPLATE/feature-request---.md
@@ -1,8 +1,8 @@
 ---
-name: "Feature request \U0001F4A1"
-about: Suggest an idea for this project
+name: "Feature Request \U0001F4A1"
+about: "Suggest an idea for this project"
 title: ""
-labels: enhancement
+labels: "Feature"
 assignees: ""
 ---
 
diff --git a/.github/ISSUE_TEMPLATE/question--.md b/.github/ISSUE_TEMPLATE/question--.md
@@ -1,8 +1,8 @@
 ---
-name: Question ❓
-about: Ask a question about this project
+name: "Question \U00002753"
+about: "Ask a question about this project"
 title: ""
-labels: question
+labels: "Question"
 assignees: ""
 ---
 
diff --git a/README.md b/README.md
@@ -67,6 +67,9 @@ $ cd "project name" && npm run start
 
 ```bash
 │
+├── /.vscode
+│   └── settings.json
+│
 ├── /src
 │   ├── /controllers
 │   │   ├── auth.controller.ts
@@ -123,6 +126,7 @@ $ cd "project name" && npm run start
 ├── .eslintignore
 ├── .eslintrc
 ├── .gitignore
+├── .huskyrc
 ├── .prettierrc
 ├── docker-compose.yml
 ├── Dockerfile
@@ -175,7 +179,7 @@ Simplify API development for users, teams, and enterprises with the Swagger open
 
 Find out how Swagger can help you design and document your APIs at scale.
 
-Start your typescript-express-starter app in development mode at `http://localhost:3000/swagger`
+Start your app in development mode at `http://localhost:3000/api-docs`
 
 Modify `swagger.yaml` file to your source code
 
diff --git a/lib/default/.huskyrc b/lib/default/.huskyrc
@@ -0,0 +1,5 @@
+{
+  "hooks": {
+    "pre-commit": "npm run lint"
+  }
+}
diff --git a/lib/default/package.json b/lib/default/package.json
@@ -11,10 +11,5 @@
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run lint"
-    }
   }
 }
diff --git a/lib/default/src/tests/auth.test.ts b/lib/default/src/tests/auth.test.ts
@@ -4,7 +4,7 @@ import AuthRoute from '../routes/auth.route';
 import { CreateUserDto } from '../dtos/users.dto';
 
 afterAll(async () => {
-  await new Promise(resolve => setTimeout(() => resolve(), 500));
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
 });
 
 describe('Testing Auth', () => {
diff --git a/lib/default/src/tests/index.test.ts b/lib/default/src/tests/index.test.ts
@@ -3,7 +3,7 @@ import App from '../app';
 import IndexRoute from '../routes/index.route';
 
 afterAll(async () => {
-  await new Promise(resolve => setTimeout(() => resolve(), 500));
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
 });
 
 describe('Testing Index', () => {
diff --git a/lib/default/src/tests/users.test.ts b/lib/default/src/tests/users.test.ts
@@ -6,7 +6,7 @@ import UserRoute from '../routes/users.route';
 import { CreateUserDto } from '../dtos/users.dto';
 
 afterAll(async () => {
-  await new Promise(resolve => setTimeout(() => resolve(), 500));
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
 });
 
 describe('Testing Users', () => {
diff --git a/lib/default/tsconfig.json b/lib/default/tsconfig.json
@@ -2,7 +2,7 @@
   "compilerOptions": {
     "target": "es2017",
     "lib": ["es2017", "esnext.asynciterable"],
-    "typeRoots": ["./node_modules/@types", "./src/types"],
+    "typeRoots": ["./node_modules/@types"],
     "allowSyntheticDefaultImports": true,
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
diff --git a/lib/mongoose/.huskyrc b/lib/mongoose/.huskyrc
@@ -0,0 +1,5 @@
+{
+  "hooks": {
+    "pre-commit": "npm run lint"
+  }
+}
diff --git a/lib/mongoose/package.json b/lib/mongoose/package.json
@@ -11,10 +11,5 @@
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run lint"
-    }
   }
 }
diff --git a/lib/mongoose/src/tests/auth.test.ts b/lib/mongoose/src/tests/auth.test.ts
@@ -9,7 +9,7 @@ import { TokenData } from '../interfaces/auth.interface';
 import AuthService from '../services/auth.service';
 
 afterAll(async () => {
-  await new Promise(resolve => setTimeout(() => resolve(), 500));
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
 });
 
 describe('Testing AuthController', () => {
diff --git a/lib/mongoose/src/tests/index.test.ts b/lib/mongoose/src/tests/index.test.ts
@@ -3,7 +3,7 @@ import App from '../app';
 import IndexRoute from '../routes/index.route';
 
 afterAll(async () => {
-  await new Promise(resolve => setTimeout(() => resolve(), 500));
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
 });
 
 describe('Testing Index', () => {
diff --git a/lib/mongoose/src/tests/users.test.ts b/lib/mongoose/src/tests/users.test.ts
@@ -4,7 +4,7 @@ import App from '../app';
 import UsersRoute from '../routes/users.route';
 
 afterAll(async () => {
-  await new Promise(resolve => setTimeout(() => resolve(), 500));
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
 });
 
 describe('Testing Users', () => {
diff --git a/lib/mongoose/tsconfig.json b/lib/mongoose/tsconfig.json
@@ -2,7 +2,7 @@
   "compilerOptions": {
     "target": "es2017",
     "lib": ["es2017", "esnext.asynciterable"],
-    "typeRoots": ["./node_modules/@types", "./src/types"],
+    "typeRoots": ["./node_modules/@types"],
     "allowSyntheticDefaultImports": true,
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
diff --git a/lib/sequelize/.huskyrc b/lib/sequelize/.huskyrc
@@ -0,0 +1,5 @@
+{
+  "hooks": {
+    "pre-commit": "npm run lint"
+  }
+}
diff --git a/lib/sequelize/package.json b/lib/sequelize/package.json
@@ -11,10 +11,5 @@
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run lint"
-    }
   }
 }
diff --git a/lib/sequelize/src/app.ts b/lib/sequelize/src/app.ts
@@ -3,10 +3,12 @@ import cors from 'cors';
 import express from 'express';
 import helmet from 'helmet';
 import hpp from 'hpp';
+import sequelize from './models/index.model';
 import logger from 'morgan';
+import swaggerUi from 'swagger-ui-express';
+import swaggerJSDoc from 'swagger-jsdoc';
 import Routes from './interfaces/routes.interface';
 import errorMiddleware from './middlewares/error.middleware';
-import sequelize from './models/index.model';
 
 class App {
   public app: express.Application;
@@ -21,6 +23,7 @@ class App {
     this.connectToDatabase();
     this.initializeMiddlewares();
     this.initializeRoutes(routes);
+    this.initializeSwagger();
     this.initializeErrorHandling();
   }
 
@@ -34,6 +37,10 @@ class App {
     return this.app;
   }
 
+  private connectToDatabase() {
+    sequelize.sync({ force: false });
+  }
+
   private initializeMiddlewares() {
     if (this.env) {
       this.app.use(hpp());
@@ -55,12 +62,24 @@ class App {
     });
   }
 
-  private initializeErrorHandling() {
-    this.app.use(errorMiddleware);
+  private initializeSwagger() {
+    const options = {
+      swaggerDefinition: {
+        info: {
+          title: 'REST API',
+          version: '1.0.0',
+          description: 'Example docs',
+        },
+      },
+      apis: ['swagger.yaml'],
+    };
+
+    const specs = swaggerJSDoc(options);
+    this.app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
   }
 
-  private connectToDatabase() {
-    sequelize.sync({ force: false });
+  private initializeErrorHandling() {
+    this.app.use(errorMiddleware);
   }
 }
 
diff --git a/lib/sequelize/src/tests/auth.test.ts b/lib/sequelize/src/tests/auth.test.ts
@@ -4,7 +4,7 @@ import AuthRoute from '../routes/auth.route';
 import { CreateUserDto } from '../dtos/users.dto';
 
 afterAll(async () => {
-  await new Promise(resolve => setTimeout(() => resolve(), 500));
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
 });
 
 describe('Testing Auth', () => {
diff --git a/lib/sequelize/src/tests/index.test.ts b/lib/sequelize/src/tests/index.test.ts
@@ -3,7 +3,7 @@ import App from '../app';
 import IndexRoute from '../routes/index.route';
 
 afterAll(async () => {
-  await new Promise(resolve => setTimeout(() => resolve(), 500));
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
 });
 
 describe('Testing Index', () => {
diff --git a/lib/sequelize/src/tests/users.test.ts b/lib/sequelize/src/tests/users.test.ts
@@ -6,7 +6,7 @@ import UserRoute from '../routes/users.route';
 import { CreateUserDto } from '../dtos/users.dto';
 
 afterAll(async () => {
-  await new Promise(resolve => setTimeout(() => resolve(), 500));
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
 });
 
 describe('Testing Users', () => {
diff --git a/lib/sequelize/tsconfig.json b/lib/sequelize/tsconfig.json
@@ -2,7 +2,7 @@
   "compilerOptions": {
     "target": "es2017",
     "lib": ["es2017", "esnext.asynciterable"],
-    "typeRoots": ["./node_modules/@types", "./src/types"],
+    "typeRoots": ["./node_modules/@types"],
     "allowSyntheticDefaultImports": true,
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typescript-express-starter",
-  "version": "2.7.2",
+  "version": "2.7.3",
   "description": "Quick and Easy TypeScript Express Starter",
   "author": "AGUMON <ljlm0402@gmail.com>",
   "license": "MIT",
@@ -18,7 +18,8 @@
     "prettier",
     "docker",
     "docker-compose",
-    "nginx"
+    "nginx",
+    "huskyrc"
   ],
   "bin": {
     "typescript-express-starter": "bin/cli.js"

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "hooks": {
 +    "pre-commit": "npm run lint"
 +  }
 +}
Original file line number	Diff line number	Diff line change
`@@ -11,10 +11,5 @@`
`11`	`11`	`"test": "jest --forceExit --detectOpenHandles",`
`12`	`12`	`"lint": "eslint --ignore-path .gitignore --ext .ts src/",`
`13`	`13`	`"lint:fix": "npm run lint -- --fix"`
`14`		`- },`
`15`		`- "husky": {`
`16`		`- "hooks": {`
`17`		`- "pre-commit": "npm run lint"`
`18`		`- }`
`19`	`14`	`}`
`20`	`15`	`}`