feat(generators/app): refactor template & add types.ts that contains entity type def

Author: phatpham9

.lintstagedrc

@@ -1,4 +1,4 @@
 {
-  "*.{ts,js,json,md,yml}": "yarn format",
+  "**/*.{js,json,md,yml}": "yarn format",
   "!(**/templates/*).js": "yarn lint"
 }

generators/app/index.js

@@ -13,21 +13,21 @@ module.exports = class extends Generator {
     const prompts = [
       {
         type: 'input',
-        name: 'elementComponentName',
+        name: 'compName',
         message: 'Name of the new component (singular)?',
         default: 'thing',
       },
     ];
 
     return this.prompt(prompts).then((props) => {
-      const elementCompNameParamCase = changeCase.paramCase(
-        props.elementComponentName,
-      );
+      const compNameParamCase = changeCase.paramCase(props.compName);
+      const compNamePascalCase = changeCase.pascalCase(props.compName);
 
       this.props = {
         ...props,
-        elementCompNameSingular: elementCompNameParamCase,
-        elementCompNamePlural: pluralize(elementCompNameParamCase),
+        compNameParamCase,
+        compNamePascalCase,
+        compNameParamCasePlural: pluralize(compNameParamCase),
       };
     });
   }

generators/app/templates/<%= compNameParamCasePlural %>/constants.ts

@@ -0,0 +1,4 @@
+const ENTITY = '<%= compNameParamCase %>';
+const RESOURCE = '<%= compNameParamCasePlural %>';
+
+export { ENTITY, RESOURCE };

generators/app/templates/<%= elementCompNamePlural %>/controller.ts renamed to generators/app/templates/<%= compNameParamCasePlural %>/controller.ts

@@ -2,46 +2,47 @@ import { Request, Response, NextFunction } from 'express';
 import { StatusCodes } from 'http-status-codes';
 import { HttpError } from '@boringcodes/utils/error';
 
+import { <%= compNamePascalCase %> } from './types';
 import { ENTITY } from './constants';
 
 interface MyRequest extends Request {
-  readonly [ENTITY]: any;
+  readonly [ENTITY]: Required<<%= compNamePascalCase %>>;
 }
 
-const list = (_: Request, res: Response, next: NextFunction): void => {
+const getById = (req: Request, _: Response, next: NextFunction): void => {
   try {
-    // TODO: list objects
-    const objects: any[] = [];
+    const { id = '' } = req.params;
+    if (id === '') {
+      throw new HttpError(StatusCodes.BAD_REQUEST, 'Invalid resource Id');
+    }
 
-    res.send(objects);
+    // TODO: get object by id
+    const object = {};
+    Object.assign(req, { [ENTITY]: object });
+
+    next();
   } catch (err) {
     next(new HttpError(err.code ?? StatusCodes.INTERNAL_SERVER_ERROR, err));
   }
 };
 
-const create = (req: Request, res: Response, next: NextFunction): void => {
+const list = (_: Request, res: Response, next: NextFunction): void => {
   try {
-    // TODO: create object
-    const object = { ...req.body };
+    // TODO: list objects
+    const objects: <%= compNamePascalCase %>[] = [];
 
-    res.send(object);
+    res.send(objects);
   } catch (err) {
     next(new HttpError(err.code ?? StatusCodes.INTERNAL_SERVER_ERROR, err));
   }
 };
 
-const getById = (req: Request, _: Response, next: NextFunction): void => {
+const create = (req: Request, res: Response, next: NextFunction): void => {
   try {
-    const { id = '' } = req.params;
-    if (id === '') {
-      throw new HttpError(StatusCodes.BAD_REQUEST, 'Invalid resource Id');
-    }
-
-    // TODO: get object by id
-    const object = {};
-    Object.assign(req, { [ENTITY]: object });
+    // TODO: create object
+    const object = { ...req.body };
 
-    next();
+    res.send(object);
   } catch (err) {
     next(new HttpError(err.code ?? StatusCodes.INTERNAL_SERVER_ERROR, err));
   }
@@ -73,7 +74,7 @@ const updatePartial = (
 
 const update = (req: Request, res: Response, next: NextFunction): void => {
   try {
-    // TODO: replace object
+    // TODO: update object
     const object = { ...req.body };
 
     res.send(object);
@@ -91,4 +92,4 @@ const del = (req: Request, res: Response, next: NextFunction): void => {
   }
 };
 
-export { list, create, getById, get, updatePartial, update, del };
+export default { getById, list, create, get, updatePartial, update, del };

generators/app/templates/<%= compNameParamCasePlural %>/index.ts

@@ -0,0 +1,26 @@
+import { Router } from 'express';
+
+import { RouteOptions } from '../types';
+import { RESOURCE } from './constants';
+import controller from './controller';
+
+const path = `/${RESOURCE}`;
+
+const routes = (_: RouteOptions): Router => {
+  const router = Router();
+
+  router.param('id', controller.getById);
+
+  router.route('/').get(controller.list).post(controller.create);
+
+  router
+    .route('/:id')
+    .get(controller.get)
+    .patch(controller.updatePartial)
+    .put(controller.update)
+    .delete(controller.del);
+
+  return router;
+};
+
+export default { path, routes };

generators/app/templates/<%= compNameParamCasePlural %>/types.ts

@@ -0,0 +1,6 @@
+interface <%= compNamePascalCase %> {
+  readonly id?: string;
+  readonly name?: string;
+}
+
+export { <%= compNamePascalCase %> };

generators/app/templates/<%= elementCompNamePlural %>/constants.ts

@@ -13,8 +13,8 @@
   ],
   "scripts": {
     "purge": "rimraf node_modules",
-    "format": "prettier --write --ignore-path .gitignore .",
-    "format:check": "prettier --check --ignore-path .gitignore .",
+    "format": "prettier --write --ignore-path .gitignore **/*.{js,json,md,yml}",
+    "format:check": "prettier --check --ignore-path .gitignore **/*.{js,json,md,yml}",
     "lint": "eslint --quiet --ignore-path .gitignore --ignore-pattern templates .",
     "release": "standard-version",
     "release:major": "yarn release --release-as major",