feat(generators): simplify generator props using singular & plural comp name; replace NAME & PLURAL_NAME consts with ENTITY & RESOURCE; remove count api & rename patch api to updatePartial; refactor controller

Author: phatpham9

generators/app/index.js

@@ -20,18 +20,14 @@ module.exports = class extends Generator {
     ];
 
     return this.prompt(prompts).then((props) => {
-      const elementComponentNameParamCase = changeCase.paramCase(
-        props.elementComponentName,
-      );
-      const elementComponentNameCamelCase = changeCase.camelCase(
+      const elementCompNameParamCase = changeCase.paramCase(
         props.elementComponentName,
       );
 
       this.props = {
         ...props,
-        elementResourceName: elementComponentNameParamCase,
-        elementResourceNamePlural: pluralize(elementComponentNameParamCase),
-        elementDirName: pluralize(elementComponentNameCamelCase),
+        elementCompNameSingular: elementCompNameParamCase,
+        elementCompNamePlural: pluralize(elementCompNameParamCase),
       };
     });
   }

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

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

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

@@ -1,39 +1,28 @@
-import { Request as ExpressRequest, Response, NextFunction } from 'express';
+import { Request, Response, NextFunction } from 'express';
 import {
   BAD_REQUEST,
   NOT_FOUND,
   INTERNAL_SERVER_ERROR,
 } from 'http-status-codes';
 import { HttpError } from '@boringcodes/utils/error';
 
-import { NAME } from './constants';
+import { ENTITY } from './constants';
 
-interface Request extends ExpressRequest {
-  readonly [NAME]: any;
+interface MyRequest extends Request {
+  readonly [ENTITY]: any;
 }
 
 const list = async (_: Request, res: Response, next: NextFunction) => {
   try {
     // TODO: list objects
-    const objects = [];
+    const objects: any[] = [];
 
     res.send(objects);
   } catch (err) {
     next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
   }
 };
 
-const count = async (_: Request, res: Response, next: NextFunction) => {
-  try {
-    // TODO: count objects
-    const count = 0;
-
-    res.send({ count });
-  } catch (err) {
-    next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
-  }
-};
-
 const create = async (req: Request, res: Response, next: NextFunction) => {
   try {
     // TODO: create object
@@ -46,65 +35,68 @@ const create = async (req: Request, res: Response, next: NextFunction) => {
 };
 
 const getById = async (req: Request, _: Response, next: NextFunction) => {
-  if (!req.params.id) {
-    next(new HttpError(BAD_REQUEST, 'Invalid resource Id'));
-
-    return;
-  }
-
   try {
-    // TODO: get object
-    const object = {};
+    if (!req.params.id) {
+      throw new HttpError(BAD_REQUEST, 'Invalid resource Id');
+    }
 
+    // TODO: get object by id
+    const object = {};
     if (!object) {
-      next(new HttpError(NOT_FOUND, 'Resource not found'));
-
-      return;
+      return next(new HttpError(NOT_FOUND, 'Resource not found'));
     }
-    // tslint:disable-next-line:no-object-mutation
-    Object.assign(req, { [NAME]: object });
+    Object.assign(req, { [ENTITY]: object });
 
     next();
   } catch (err) {
     next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
   }
 };
 
-const get = (req: Request, res: Response) => {
-  res.send(req[NAME]);
+const get = (req: Request, res: Response, next: NextFunction) => {
+  try {
+    // TODO: get object
+    res.send((req as MyRequest)[ENTITY]);
+  } catch (err) {
+    next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
+  }
 };
 
-const patch = async (req: Request, res: Response, next: NextFunction) => {
+const updatePartial = async (
+  req: Request,
+  res: Response,
+  next: NextFunction,
+) => {
   try {
-    // TODO: patch object
-    const object = { ...req[NAME], ...req.body };
+    // TODO: update partial object
+    const object = { ...(req as MyRequest)[ENTITY], ...req.body };
 
     res.send(object);
   } catch (err) {
-    next(err);
+    next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
   }
 };
 
 const update = async (req: Request, res: Response, next: NextFunction) => {
   try {
-    // TODO: update object
+    // TODO: replace object
     const object = req.body;
 
     res.send(object);
   } catch (err) {
-    next(err);
+    next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
   }
 };
 
 const del = async (req: Request, res: Response, next: NextFunction) => {
   try {
     // TODO: delete object
-    const object = req[NAME];
+    const object = (req as MyRequest)[ENTITY];
 
     res.send(object);
   } catch (err) {
     next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
   }
 };
 
-export { list, create, count, getById, get, patch, update, del };
+export { list, create, getById, get, updatePartial, update, del };

generators/app/templates/<%= elementDirName %>/index.ts renamed to generators/app/templates/<%= elementCompNamePlural %>/index.ts

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