feat(generators): create new app with-postgres

phatpham9 · phatpham9 · commit 08ed491eb896 · 2021-02-13T11:13:22.000+07:00
diff --git a/generators/with-postgres/index.js b/generators/with-postgres/index.js
@@ -0,0 +1,85 @@
+const Generator = require('yeoman-generator');
+const chalk = require('chalk');
+const yosay = require('yosay');
+const changeCase = require('change-case');
+
+const pkg = require('../../package.json');
+
+module.exports = class extends Generator {
+  async prompting() {
+    this.log(yosay(`Welcome to the ${chalk.red(pkg.name)} generator!`));
+
+    const appName = changeCase.paramCase(this.appname);
+    const organizationName = await (async () => {
+      try {
+        const username = await this.user.github.username();
+
+        return username;
+      } catch (err) {
+        return 'organization-name';
+      }
+    })();
+    const gitName = this.user.git.name() || organizationName;
+    const gitEmail =
+      this.user.git.email() || `my-email@${organizationName}.com`;
+    const prompts = [
+      {
+        type: 'input',
+        name: 'elementName',
+        message: 'Name of this service?',
+        default: appName,
+      },
+      {
+        type: 'input',
+        name: 'elementDescription',
+        message: 'Description?',
+        default: 'My awesome service',
+      },
+      {
+        type: 'input',
+        name: 'elementOrganizationName',
+        message: 'GitHub organization name?',
+        default: organizationName,
+      },
+      {
+        type: 'input',
+        name: 'elementAuthor',
+        message: 'Author?',
+        default: `${gitName} <${gitEmail}>`,
+      },
+      {
+        type: 'input',
+        name: 'elementNodeVersion',
+        message: 'Supported Node version?',
+        default: 15,
+      },
+    ];
+
+    const props = await this.prompt(prompts);
+
+    this.props = {
+      ...props,
+      elementName: changeCase.paramCase(props.elementName),
+      elementOrganizationName: changeCase.paramCase(
+        props.elementOrganizationName,
+      ),
+    };
+  }
+
+  writing() {
+    this.fs.copyTpl(
+      [this.templatePath('**/*'), this.templatePath('**/.*')],
+      this.destinationPath(),
+      this.props,
+    );
+
+    this.fs.copy(
+      this.destinationPath('.env.example'),
+      this.destinationPath('.env'),
+    );
+  }
+
+  install() {
+    this.yarnInstall();
+  }
+};
diff --git a/generators/with-postgres/templates/.dockerignore b/generators/with-postgres/templates/.dockerignore
@@ -0,0 +1,3 @@
+build
+node_modules
+Dockerfile
diff --git a/generators/with-postgres/templates/.env.example b/generators/with-postgres/templates/.env.example
@@ -0,0 +1,10 @@
+NODE_ENV=development
+
+HOST=localhost
+PORT=9000
+
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+POSTGRES_DB_NAME=<%= elementName %>
+POSTGRES_USER=
+POSTGRES_PASSWORD=
diff --git a/generators/with-postgres/templates/.eslintrc.js b/generators/with-postgres/templates/.eslintrc.js
@@ -0,0 +1 @@
+module.exports = require('@boringcodes/eslint-config-typescript');
diff --git a/generators/with-postgres/templates/.huskyrc b/generators/with-postgres/templates/.huskyrc
@@ -0,0 +1,6 @@
+{
+  "hooks": {
+    "pre-commit": "lint-staged",
+    "pre-push": "yarn build"
+  }
+}
diff --git a/generators/with-postgres/templates/.lintstagedrc b/generators/with-postgres/templates/.lintstagedrc
@@ -0,0 +1,4 @@
+{
+  "*.{ts,js,json,md,yml}": "yarn format",
+  "*.ts": "yarn lint"
+}
diff --git a/generators/with-postgres/templates/.nvmrc b/generators/with-postgres/templates/.nvmrc
@@ -0,0 +1 @@
+<%= elementNodeVersion %>
diff --git a/generators/with-postgres/templates/.prettierrc.js b/generators/with-postgres/templates/.prettierrc.js
@@ -0,0 +1 @@
+module.exports = require('@boringcodes/prettier-config');
diff --git a/generators/with-postgres/templates/Dockerfile b/generators/with-postgres/templates/Dockerfile
@@ -0,0 +1,14 @@
+# Base Image GitHub https://github.com/boringcodes/dev-runner
+# Default WORKDIR /app
+# Default CMD yarn dev
+
+# builder stage
+FROM boringcodes/dev-runner:node-<%= elementNodeVersion %>-alpine as builder
+COPY . .
+RUN yarn && yarn build && yarn purge && yarn --production
+
+# runner stage
+FROM boringcodes/dev-runner:node-<%= elementNodeVersion %>-alpine
+COPY --from=builder /app/build build
+COPY --from=builder /app/node_modules node_modules
+CMD node build/index.js
diff --git a/generators/with-postgres/templates/package.json b/generators/with-postgres/templates/package.json
@@ -0,0 +1,63 @@
+{
+  "name": "<%= elementName %>",
+  "version": "0.0.0",
+  "description": "<%= elementDescription %>",
+  "homepage": "https://github.com/<%= elementOrganizationName %>/<%= elementName %>",
+  "bugs": "https://github.com/<%= elementOrganizationName %>/<%= elementName %>/issues",
+  "license": "MIT",
+  "author": "<%- elementAuthor %>",
+  "repository": "https://github.com/<%= elementOrganizationName %>/<%= elementName %>.git",
+  "engines": {
+    "node": ">=<%= elementNodeVersion %>"
+  },
+  "scripts": {
+    "dev": "backpack dev",
+    "prebuild": "yarn clean",
+    "build": "backpack build",
+    "start": "cross-env NODE_ENV=production node build/index.js",
+    "purge": "rimraf node_modules",
+    "clean": "rimraf build",
+    "format": "prettier --write --ignore-path .gitignore .",
+    "format:check": "prettier --check --ignore-path .gitignore .",
+    "lint": "eslint --quiet --ignore-path .gitignore --ext .ts .",
+    "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": "*",
+    "cross-env": "*",
+    "express": "*",
+    "http-status-codes": "*",
+    "morgan": "*",
+    "pg": "*",
+    "sequelize": "*",
+    "source-map-support": "*",
+    "yup": "*"
+  },
+  "devDependencies": {
+    "@boringcodes/backpack": "*",
+    "@boringcodes/eslint-config-typescript": "*",
+    "@boringcodes/prettier-config": "*",
+    "@types/express": "*",
+    "@types/morgan": "*",
+    "@types/yup": "*",
+    "@typescript-eslint/eslint-plugin": "*",
+    "@typescript-eslint/parser": "*",
+    "eslint": "*",
+    "eslint-config-prettier": "*",
+    "eslint-config-standard-with-typescript": "*",
+    "eslint-plugin-import": "*",
+    "eslint-plugin-node": "*",
+    "eslint-plugin-promise": "*",
+    "eslint-plugin-standard": "*",
+    "husky": "*",
+    "lint-staged": "*",
+    "prettier": "*",
+    "rimraf": "*",
+    "standard-version": "*",
+    "typescript": "*"
+  }
+}
diff --git a/generators/with-postgres/templates/src/app.ts b/generators/with-postgres/templates/src/app.ts
@@ -0,0 +1,31 @@
+import express from 'express';
+import morgan from 'morgan';
+import bodyParser from 'body-parser';
+import { isDev } from '@boringcodes/utils';
+import {
+  health,
+  handleNotFound,
+  handleErrors,
+} from '@boringcodes/utils/express';
+
+import components from './components';
+
+const dev = isDev();
+
+// create app
+const app = express();
+
+// plug middleware
+app.use(morgan(dev ? 'dev' : 'common'));
+app.use(health());
+app.use(bodyParser.urlencoded({ extended: true }));
+app.use(bodyParser.json());
+
+// plug components
+app.use(components.path, components.routes({ dev }));
+
+// handle errors
+app.use(handleNotFound);
+app.use(handleErrors);
+
+export default app;
diff --git a/generators/with-postgres/templates/src/components/index.ts b/generators/with-postgres/templates/src/components/index.ts
@@ -0,0 +1,18 @@
+import { Router } from 'express';
+
+import { RouteOptions } from './types';
+// TODO: import components
+// import things from './things';
+
+const path = '/';
+
+const routes = (_: RouteOptions): Router => {
+  const router = Router();
+
+  // TODO: plug components to router
+  // router.use(things.path, things.routes(_));
+
+  return router;
+};
+
+export default { path, routes };
diff --git a/generators/with-postgres/templates/src/components/types.ts b/generators/with-postgres/templates/src/components/types.ts
@@ -0,0 +1,5 @@
+interface RouteOptions {
+  readonly dev: boolean;
+}
+
+export { RouteOptions };
diff --git a/generators/with-postgres/templates/src/config/index.ts b/generators/with-postgres/templates/src/config/index.ts
@@ -0,0 +1,6 @@
+const config = {
+  host: process.env.HOST ?? 'localhost',
+  port: +(process.env.PORT ?? '9000'),
+};
+
+export default config;
diff --git a/generators/with-postgres/templates/src/config/postgres.ts b/generators/with-postgres/templates/src/config/postgres.ts
@@ -0,0 +1,13 @@
+const host = process.env.POSTGRES_HOST ?? 'localhost';
+const port = +(process.env.POSTGRES_PORT ?? '5432');
+const dbName = process.env.POSTGRES_DB_NAME ?? '<%= elementName %>';
+const user = process.env.POSTGRES_USER;
+const password = process.env.POSTGRES_PASSWORD;
+
+const config = {
+  uri: `postgres://${host}:${port}/${dbName}`,
+  user,
+  password,
+};
+
+export default config;
diff --git a/generators/with-postgres/templates/src/db/postgres.ts b/generators/with-postgres/templates/src/db/postgres.ts
@@ -0,0 +1,43 @@
+import {
+  Sequelize,
+  Model,
+  ModelAttributes,
+  ModelOptions,
+  ModelCtor,
+} from 'sequelize';
+import logger from '@boringcodes/utils/logger';
+
+import config from '../config/postgres';
+
+// create sequelize
+const sequelize = new Sequelize(config.uri, {
+  username: config.user,
+  password: config.password,
+});
+
+// connect postgres
+const connect = async (): Promise<void> => {
+  try {
+    await sequelize.authenticate();
+
+    // sync all models
+    await sequelize.sync({ force: true });
+
+    logger.info('> Postgres connected');
+  } catch (err) {
+    logger.error('> Postgres failed to connect');
+
+    throw err;
+  }
+};
+
+// create postgres model
+const createModel = <T extends Model, M extends ModelCtor<T>>(
+  name: string,
+  schema: ModelAttributes<T>,
+  options?: ModelOptions,
+): M => {
+  return sequelize.define<T>(name, schema, options) as M;
+};
+
+export default { connect, createModel };
diff --git a/generators/with-postgres/templates/src/index.ts b/generators/with-postgres/templates/src/index.ts
@@ -0,0 +1,29 @@
+import http from 'http';
+import { MyError } from '@boringcodes/utils/error';
+import errorHandler from '@boringcodes/utils/errorHandler';
+import logger from '@boringcodes/utils/logger';
+
+import postgres from './db/postgres';
+import app from './app';
+import config from './config';
+
+// connect postgres
+postgres.connect(); // eslint-disable-line @typescript-eslint/no-floating-promises
+
+// create server
+const server = http.createServer(app);
+
+// start server
+server.listen(config.port, config.host, () => {
+  logger.info(`> Server started at http://${config.host}:${config.port}`);
+});
+
+// handle unhandled promise
+process.on('unhandledRejection', (err: MyError) => {
+  throw err;
+});
+
+// handle uncaught error and gracefully shutdown
+process.on('uncaughtException', (err: MyError) => {
+  errorHandler.handle(err);
+});
diff --git a/generators/with-postgres/templates/tsconfig.json b/generators/with-postgres/templates/tsconfig.json
@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "target": "es6",
+    "rootDir": "src",
+    "outDir": "build",
+    "esModuleInterop": true,
+    "preserveConstEnums": true,
+    "removeComments": true,
+    "sourceMap": true,
+    "strict": true
+  },
+  "include": ["**/*.ts"]
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+build`
	`2`	`+node_modules`
	`3`	`+Dockerfile`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+module.exports = require('@boringcodes/eslint-config-typescript');`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "*.{ts,js,json,md,yml}": "yarn format",
 +  "*.ts": "yarn lint"
 +}