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

khanghuynh92 · phatpham9 · web-flow · commit 879d1afdf343 · 2020-03-18T13:49:08.000+07:00
* feat: Init source

* refactor: Refactor

* feat: update utils

* feat: Update rollup.config.js

* feat: remove redis, mongoose and some express middleware

* ci: add github actions

Co-authored-by: phatpham9 &lt;phatpham9@gmail.com&gt;
diff --git a/.github/workflows/create-github-release.yml b/.github/workflows/create-github-release.yml
@@ -0,0 +1,19 @@
+name: create-github-release
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  create-github-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/create-release@v1
+        env:
+          # This token is provided by Actions, you do not need to create your own token
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        with:
+          tag_name: ${{github.ref}}
+          release_name: Release ${{github.ref}}
diff --git a/.github/workflows/publish-npm.yml b/.github/workflows/publish-npm.yml
@@ -0,0 +1,19 @@
+name: publish-npm
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
diff --git a/.huskyrc b/.huskyrc
@@ -0,0 +1,6 @@
+{
+  "hooks": {
+    "pre-commit": "yarn lint",
+    "pre-push": "yarn build"
+  }
+}
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+node_modules
+.github
+.rpt2_cache
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 <div align="center">
   <h1>utils</h1>
   <p>Boring Utilities</p>
-  
+
   <div>
     <a href="https://github.com/boringcodes/utils/commits" aria-label="Commitizen Friendly">
       <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square">
@@ -26,3 +26,72 @@
     </a>
   </div>
 </div>
+
+## About
+This package implements a number of common `Boring Utilities`.
+
+
+## Installation
+This is a [Node.js](https://nodejs.org/en/) module available through the
+[npm registry](https://www.npmjs.com/).
+
+Before installing, [download and install Node.js](https://nodejs.org/en/download/).
+Node.js 10.0 or higher is required.
+
+Installation is done using the
+[`yarn add` command](https://classic.yarnpkg.com/en/docs/install/):
+
+```bash
+$ yarn add @boringcodes/utils
+```
+
+
+## Features
+
+The following modules are included:
+- [x] Node env detector
+- [x] Custom logger
+- [x] Custom errors classes
+- [x] Error handler
+- [x] Express middleware
+
+## Usage
+
+Then run the build command
+```bash
+yarn build
+```
+
+## Directories
+
+``` tree
+.
+├── CHANGELOG.md
+├── LICENSE
+├── README.md
+├── dist
+├── package.json
+├── rollup.config.js
+├── src
+│   ├── errorHandler.ts
+│   ├── error.ts
+│   ├── express.ts
+│   ├── index.ts
+│   ├── logger.ts
+├── tsconfig.json
+├── tslint.json
+```
+
+## 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/utils/blob/master/LICENSE)
diff --git a/package.json b/package.json
@@ -0,0 +1,48 @@
+{
+  "name": "@boringcodes/utils",
+  "version": "0.0.0",
+  "description": "Boring Utilities",
+  "homepage": "https://github.com/boringcodes/utils",
+  "bugs": "https://github.com/boringcodes/utils/issues",
+  "license": "MIT",
+  "author": "BoringCodes <hi@boringcodes.com> (https://boringcodes.com)",
+  "repository": "https://github.com/boringcodes/utils.git",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "purge": "rm -rf node_modules",
+    "dev": "rollup -cw",
+    "prebuild": "yarn clean",
+    "build": "rollup -c",
+    "lint": "tslint --project tsconfig.json --config tslint.json",
+    "release": "standard-version",
+    "release:major": "yarn release --release-as major",
+    "release:minor": "yarn release --release-as minor",
+    "release:patch": "yarn release --release-as patch"
+  },
+  "devDependencies": {
+    "@types/express": "^4.16.1",
+    "@types/http-status-codes": "^1.2.0",
+    "husky": "^2.3.0",
+    "rollup": "^1.12.3",
+    "rollup-plugin-async": "^1.2.0",
+    "rollup-plugin-commonjs": "^10.0.0",
+    "rollup-plugin-node-resolve": "^5.0.0",
+    "rollup-plugin-sourcemaps": "^0.4.2",
+    "rollup-plugin-typescript2": "^0.21.1",
+    "standard-version": "^6.0.1",
+    "tslint": "^5.16.0",
+    "tslint-config-airbnb": "^5.11.1",
+    "tslint-immutable": "^5.5.2",
+    "tslint-sonarts": "^1.9.0",
+    "typescript": "^3.4.5"
+  },
+  "dependencies": {
+    "express": "^4.17.1",
+    "http-status-codes": "^1.3.2"
+  }
+}
diff --git a/rollup.config.js b/rollup.config.js
@@ -0,0 +1,79 @@
+import resolve from 'rollup-plugin-node-resolve';
+import commonjs from 'rollup-plugin-commonjs';
+import typescript from 'rollup-plugin-typescript2';
+import async from 'rollup-plugin-async';
+import sourceMaps from 'rollup-plugin-sourcemaps';
+
+import pkg from './package.json';
+
+const common = {
+  external: [
+    ...Object.keys(pkg.dependencies || {}),
+    ...Object.keys(pkg.peerDependencies || {}),
+  ],
+  plugins: [
+    resolve(),
+    commonjs(),
+    typescript({ useTsconfigDeclarationDir: true, rollupCommonJSResolveHack: true }),
+    async(),
+    sourceMaps(),
+  ],
+};
+
+export default [
+  {
+    ...common,
+    input: 'src/error.ts',
+    output: [
+      {
+        dir: 'dist',
+        format: 'cjs',
+        sourcemap: true,
+      },
+    ],
+  },
+  {
+    ...common,
+    input: 'src/errorHandler.ts',
+    output: [
+      {
+        dir: 'dist',
+        format: 'cjs',
+        sourcemap: true,
+      },
+    ],
+  },
+  {
+    ...common,
+    input: 'src/express.ts',
+    output: [
+      {
+        dir: 'dist',
+        format: 'cjs',
+        sourcemap: true,
+      },
+    ],
+  },
+  {
+    ...common,
+    input: 'src/index.ts',
+    output: [
+      {
+        dir: 'dist',
+        format: 'cjs',
+        sourcemap: true,
+      },
+    ],
+  },
+  {
+    ...common,
+    input: 'src/logger.ts',
+    output: [
+      {
+        dir: 'dist',
+        format: 'cjs',
+        sourcemap: true,
+      },
+    ],
+  },
+];
diff --git a/src/error.ts b/src/error.ts
@@ -0,0 +1,46 @@
+import { isDev } from '.';
+
+class MyError extends Error {
+  readonly operational?: boolean;
+
+  constructor(err: any, operational = false) {
+    super();
+
+    this.name = err instanceof Error || typeof err === 'object' ? err.name : 'Error';
+    this.message = err instanceof Error || typeof err === 'object' ? err.message : err;
+    this.operational = operational;
+
+    // restore prototype chain
+    Object.setPrototypeOf(this, new.target.prototype);
+
+    // Maintains proper stack trace for where our error was thrown (only available on V8)
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, MyError);
+    }
+  }
+}
+
+/**
+ * HttpError that takes the first parameter as an Http Status Code
+ */
+class HttpError extends MyError {
+  readonly code: number;
+
+  constructor(code: number, err: any) {
+    super(err, true);
+
+    this.code = code;
+    this.name = 'HttpError';
+  }
+
+  toJSON() {
+    const content = {
+      code: this.code,
+      message: this.message,
+    };
+
+    return !isDev() ? content : { ...content, error: this.stack };
+  }
+}
+
+export { MyError, HttpError };
diff --git a/src/errorHandler.ts b/src/errorHandler.ts
@@ -0,0 +1,21 @@
+import { MyError } from './error';
+import logger from './logger';
+
+/**
+ * Log error to destination then exit the process if programmer error
+ * @param err error to be handled
+ */
+const handle = (err: MyError) => {
+  // E.g. log to sentry
+  // E.g. log to console
+  logger.error(err);
+
+  if (!err.operational) {
+    logger.info('> App exited!');
+
+    process.exit(1);
+  }
+};
+
+export { handle };
+export default { handle };
diff --git a/src/express.ts b/src/express.ts
@@ -0,0 +1,67 @@
+import { Request, Response, NextFunction, Router } from 'express';
+import { NOT_FOUND, OK, INTERNAL_SERVER_ERROR, getStatusText } from 'http-status-codes';
+
+import { HttpError } from './error';
+import errorHandler from './errorHandler';
+
+// ---------------------------------------------------
+// -----------------Express Middleware----------------
+// ---------------------------------------------------
+
+/**
+ * An Express RequestHandler that handles the 404 Not Found error
+ * @param _ Express Request object
+ * @param __ Express Response object
+ * @param next Express Next function
+ */
+const handleNotFound = (_: Request, __: Response, next: NextFunction) => {
+  next(new HttpError(NOT_FOUND, 'Resource not found'));
+};
+
+/**
+ * An Express RequestHandler that responses error info to the client
+ * @param err Http Error object
+ * @param _ Express Request object
+ * @param res Express Response object
+ * @param __ Express Next function
+ */
+const handleErrors = (err: HttpError, _: Request, res: Response, __: NextFunction) => {
+  errorHandler.handle(err);
+
+  try {
+    // check if status code exists
+    getStatusText(err.code);
+
+    res.status(err.code).send(err);
+  } catch (error) {
+    res.status(INTERNAL_SERVER_ERROR).send(err);
+  }
+};
+
+/**
+ * An Express RequestHandler that responses OK for health checking
+ * @param _ Express Request object
+ * @param res Express Response object
+ */
+const handleHealthCheck = (_: Request, res: Response) => {
+  res.status(OK).send('OK');
+};
+
+/**
+ * An Express Middleware mounted /health endpoint for health checking
+ */
+const health = () => {
+  const router = Router();
+
+  router.get('/health', handleHealthCheck);
+
+  return router;
+};
+
+export {
+  handleNotFound,
+  handleErrors,
+  handleHealthCheck,
+
+  health,
+};
diff --git a/src/index.ts b/src/index.ts
diff --git a/src/logger.ts b/src/logger.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/tslint.json b/tslint.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+node_modules`
	`2`	`+.github`
	`3`	`+.rpt2_cache`