feat(Close #1): Init source (#2)

khanghuynh92 · phatpham9 · web-flow · commit 5858a6e3d4ff · 2020-03-18T13:57:57.000+07:00
* feat(Close #1): Init source * refactor(Close #1): Refactor * refactor: Refactor * feat(Close #1): Add release scripts * refactor(Close #1): Refactor source codes * feat(Close #1): Add back tslint * feat: remove mongoose Co-authored-by: phatpham9 <phatpham9@gmail.com>
diff --git a/README.md b/README.md
@@ -26,3 +26,60 @@
     </a>
   </div>
 </div>
+
+## Install
+
+Make sure `yeoman` is installed:
+
+```sh
+$ yarn global add yo
+```
+
+Then install the generator
+
+```sh
+$ yarn global add @boringcodes/create-service
+```
+
+## Usage
+
+With [yo](https://github.com/yeoman/yo):
+
+```sh
+$ yo create-service
+```
+
+This scaffolds out:
+```
+├── Dockerfile
+├── README.md
+├── package.json
+└── src
+    ├── app.ts
+    ├── components
+    │   ├── things
+    │   │   ├── constants.ts
+    │   │   ├── controller.ts
+    │   │   ├── index.ts
+    │   │   ├── middleware.ts
+    │   │   ├── model.ts
+    │   │   ├── repository.ts
+    │   │   └── type.ts
+    │   └── types.ts
+    ├── index.ts
+    └── routes.ts
+```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## Authors
+
+[BoringCodes](https://github.com/boringcodes)
+
+## License
+
+[MIT](https://github.com/boringcodes/create-service/blob/master/LICENSE)
diff --git a/generators/app/index.js b/generators/app/index.js
@@ -0,0 +1,59 @@
+const Generator = require('yeoman-generator');
+const chalk = require("chalk");
+const yosay = require("yosay");
+const pkg = require('../../package.json');
+
+module.exports = class extends Generator {
+  async prompting() {
+    this.log(
+      yosay(
+        `Welcome to the astounding ${chalk.red(pkg.name)} generator!`
+      )
+    );
+    
+    const prompts = [
+      {
+        type: "input",
+        name: "elementName",
+        message: "What is the name of your service?",
+        default: "my-awesome-service"
+      },
+      {
+        type: "input",
+        name: "elementDescription",
+        message: "Give us some small description of your service",
+        default: ""
+      },
+      {
+        type: "input",
+        name: "elementAuthor",
+        message: "Who is the author of this service?",
+        default: ""
+      },
+    ];
+
+    return this.prompt(prompts).then(props => {
+      // To access props later use this.props.someAnswer;
+      this.props = props;
+    });
+  }
+
+  writing() {
+    this.fs.copyTpl(
+      [
+        this.templatePath('**'),
+      ],
+      this.destinationPath(),
+      this.props,
+    );
+
+    this.fs.copyTpl(
+      this.templatePath('.env.example'),
+      this.destinationPath('.env.example')
+    );
+  }
+
+  install () {
+    this.installDependencies();
+  }
+};
diff --git a/generators/app/templates/.env.example b/generators/app/templates/.env.example
@@ -0,0 +1,4 @@
+NODE_ENV=development
+
+HOST=localhost
+PORT=9000
diff --git a/generators/app/templates/.gitignore b/generators/app/templates/.gitignore
@@ -0,0 +1,25 @@
+# dependencies
+node_modules
+package-lock.json
+test/node_modules
+
+
+# testing
+.nyc_output
+coverage
+
+# build output
+build
+dist
+
+# misc
+.DS_Store
+.env
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# logs & pids
+*.log
+pids
+.idea
diff --git a/generators/app/templates/.huskyrc b/generators/app/templates/.huskyrc
@@ -0,0 +1,6 @@
+{
+  "hooks": {
+    "pre-commit": "yarn lint",
+    "pre-push": "yarn build"
+  }
+}
diff --git a/generators/app/templates/README.md b/generators/app/templates/README.md
@@ -0,0 +1,3 @@
+# <%= elementName %>
+
+API Service Starter Kit
diff --git a/generators/app/templates/package.json b/generators/app/templates/package.json
@@ -0,0 +1,44 @@
+{
+  "name": "<%= elementName %>",
+  "description": "<%= elementDescription %>",
+  "version": "0.0.0",
+  "private": true,
+  "license": "MIT",
+  "author": "<%= elementAuthor %>",
+  "repository": "",
+  "bugs": "",
+  "scripts": {
+    "clean": "rm -rf build",
+    "purge": "rm -rf node_modules",
+    "dev": "backpack dev",
+    "prebuild": "yarn clean",
+    "build": "backpack build",
+    "lint": "tslint --project ./node_modules/@boringcodes/backpack/config/tsconfig.json --config tslint.json",
+    "start": "NODE_ENV=production node build/index.js",
+    "release": "standard-version",
+    "release:major": "yarn release --release-as major",
+    "release:minor": "yarn release --release-as minor",
+    "release:patch": "yarn release --release-as patch"
+  },
+  "dependencies": {
+    "@boringcodes/utils": "*",
+    "body-parser": "^1.18.3",
+    "express": "^4.16.4",
+    "http-status-codes": "^1.3.0",
+    "morgan": "^1.9.1",
+    "yup": "^0.26.6"
+  },
+  "devDependencies": {
+    "@types/express": "^4.16.0",
+    "@types/morgan": "^1.7.35",
+    "@types/qs": "^6.5.1",
+    "@types/yup": "^0.26.3",
+    "husky": "^1.2.1",
+    "standard-version": "^4.4.0",
+    "@boringcodes/backpack": "*",
+    "tslint": "^5.11.0",
+    "tslint-config-airbnb": "^5.11.1",
+    "tslint-immutable": "^5.0.0",
+    "tslint-sonarts": "^1.8.0"
+  }
+}
diff --git a/generators/app/templates/src/app.ts b/generators/app/templates/src/app.ts
@@ -0,0 +1,26 @@
+import express from 'express';
+import morgan from 'morgan';
+import bodyParser from 'body-parser';
+import { isDev } from '@boringcodes/utils/dist';
+import { health, handleNotFound, handleErrors } from '@boringcodes/utils/dist/express';
+
+import routes from './routes';
+
+// initialize app
+const app = express();
+const dev = isDev();
+
+// plug middleware
+app.use(morgan(dev ? 'dev' : 'common'));
+app.use(bodyParser.urlencoded({ extended: true }));
+app.use(bodyParser.json());
+app.use(health());
+
+// plug routes
+app.use(routes({ dev }));
+
+// handle errors
+app.use(handleNotFound);
+app.use(handleErrors);
+
+export default app;
diff --git a/generators/app/templates/src/components/things/constants.ts b/generators/app/templates/src/components/things/constants.ts
@@ -0,0 +1,7 @@
+const NAME = 'thing';
+const PLURAL_NAME = 'things';
+
+export {
+  NAME,
+  PLURAL_NAME,
+};
diff --git a/generators/app/templates/src/components/things/controller.ts b/generators/app/templates/src/components/things/controller.ts
@@ -0,0 +1,103 @@
+import { Request as ExpressRequest, Response, NextFunction } from 'express';
+import { BAD_REQUEST, NOT_FOUND, INTERNAL_SERVER_ERROR } from 'http-status-codes';
+import { HttpError } from '@boringcodes/utils/dist/error';
+
+import { NAME } from './constants';
+
+type Request = ExpressRequest & {
+  readonly [NAME]: any,
+};
+
+const list = async (_: Request, res: Response, next: NextFunction) => {
+  try {
+    // TODO: list things
+    const things = [];
+
+    res.send(things);
+  } catch (err) {
+    next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
+  }
+};
+
+const count = async (_: Request, res: Response, next: NextFunction) => {
+  try {
+    // TODO: count things
+    const count = 0;
+
+    res.send({ count });
+  } catch (err) {
+    next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
+  }
+};
+
+const create = async (_: Request, res: Response, next: NextFunction) => {
+  try {
+    // TODO: create thing
+    const thing = {};
+
+    res.send(thing);
+  } catch (err) {
+    next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
+  }
+};
+
+const getById = async (req: Request, _: Response, next: NextFunction) => {
+  if (!req.params.id) {
+    next(new HttpError(BAD_REQUEST, 'Invalid resource Id'));
+
+    return;
+  }
+
+  try {
+    // TODO: get thing
+    const thing = {};
+
+    if (!thing) {
+      next(new HttpError(NOT_FOUND, 'Resource not found'));
+
+      return;
+    }
+    // tslint:disable-next-line:no-object-mutation
+    Object.assign(req, { [NAME]: thing });
+
+    next();
+  } catch (err) {
+    next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
+  }
+};
+
+const get = (req: Request, res: Response) => {
+  res.send(req[NAME]);
+};
+
+const update = async (req: Request, res: Response, next: NextFunction) => {
+  try {
+    // TODO: update thing
+    const thing = req[NAME];
+
+    res.send(thing);
+  } catch (err) {
+    next(err);
+  }
+};
+
+const del = async (req: Request, res: Response, next: NextFunction) => {
+  try {
+    // TODO: delete thing
+    const thing = req[NAME];
+
+    res.send(thing);
+  } catch (err) {
+    next(new HttpError(err.code || INTERNAL_SERVER_ERROR, err));
+  }
+};
+
+export {
+  list,
+  create,
+  count,
+  getById,
+  get,
+  update,
+  del,
+};
diff --git a/generators/app/templates/src/components/things/index.ts b/generators/app/templates/src/components/things/index.ts
@@ -0,0 +1,29 @@
+import { Router } from 'express';
+
+import { PLURAL_NAME } from './constants';
+import { list, count, create, getById, get, update, del } from './controller';
+import { Routes } from '../types';
+
+const path = `/${PLURAL_NAME}`;
+
+const routes = (_: Routes) => {
+  const router = Router();
+
+  router.param('id', getById);
+
+  router.route('/')
+    .get(list)
+    .post(create);
+
+  router.route('/count')
+    .get(count);
+
+  router.route('/:id')
+    .get(get)
+    .put(update)
+    .delete(del);
+
+  return router;
+};
+
+export default { path, routes };
diff --git a/generators/app/templates/src/components/types.ts b/generators/app/templates/src/components/types.ts
@@ -0,0 +1,5 @@
+type Routes = {
+  readonly dev: boolean,
+};
+
+export { Routes };
diff --git a/generators/app/templates/src/index.ts b/generators/app/templates/src/index.ts
diff --git a/generators/app/templates/src/routes.ts b/generators/app/templates/src/routes.ts
diff --git a/generators/app/templates/tslint.json b/generators/app/templates/tslint.json
diff --git a/package.json b/package.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# <%= elementName %>`
	`2`	`+`
	`3`	`+API Service Starter Kit`