Merge pull request #99 from rtfpessoa/misc-improvements

Add proper exit code on error, other fixes and bumps

Author: rtfpessoa

README.md

@@ -23,6 +23,7 @@ Diff to Html generates pretty HTML diffs from unified and git diff output in you
 - [Distributions](#distributions)
 - [Setup](#setup)
 - [Usage](#usage)
+  - [Exit Status Codes](#exit-status-codes)
   - [Custom HTML wrapper template](#custom-html-wrapper-template)
   - [Examples](#examples)
 - [Contribute](#contribute)
@@ -89,6 +90,13 @@ Usage: diff2html [ flags and/or options ] -- [git diff passthrough flags and opt
 | -v    | --version                | Show version number                                                        |                              |           |
 | -h    | --help                   | Show help                                                                  |                              |           |
 
+### Exit Status Codes
+
+- :tada: 0: Success
+- :dizzy_face: 1: Generic Error
+- :cold_sweat: 3: Input diff is empty
+- :cop: 4: Value of `--hwt | --htmlWrapperTemplate` is not a valid file
+
 ### Custom HTML wrapper template
 
 The template is a very based on a simple replace of several placeholders as coded

package.json

@@ -7,6 +7,10 @@
     "git",
     "diff",
     "pretty",
+    "parser",
+    "diffparser",
+    "gen",
+    "generator",
     "side",
     "line",
     "side-by-side",
@@ -52,7 +56,7 @@
     "test:watch": "jest --watch",
     "test:debug": "node --inspect-brk ./node_modules/jest/bin/jest.js --runInBand --watch",
     "coverage:open": "yarn run test:coverage && open ./coverage/index.html",
-    "coverage:push": "cat ./coverage/lcov.info | codacy-coverage",
+    "coverage:push": "curl -Ls https://coverage.codacy.com/get.sh | bash",
     "validate": "yarn run format:check && yarn run lint:check && yarn run build && yarn run test:coverage",
     "fix": "yarn run format:fix && yarn run lint:fix",
     "preversion": "yarn run validate",
@@ -81,42 +85,38 @@
     ]
   },
   "dependencies": {
-    "clipboardy": "^2.2.0",
+    "clipboardy": "^2.3.0",
     "diff2html": "3.1.6",
+    "node-fetch": "^2.6.0",
     "open": "^7.0.3",
-    "request": "^2.88.2",
-    "yargs": "^15.3.0"
+    "yargs": "^15.3.1"
   },
   "devDependencies": {
     "@types/hogan.js": "^3.0.0",
-    "@types/jest": "25.1.4",
-    "@types/node": "13.9.1",
+    "@types/jest": "25.2.1",
+    "@types/node": "13.11.1",
+    "@types/node-fetch": "^2.5.6",
     "@types/request": "2.48.4",
-    "@typescript-eslint/eslint-plugin": "2.23.0",
-    "@typescript-eslint/parser": "2.23.0",
-    "codacy-coverage": "3.4.0",
+    "@typescript-eslint/eslint-plugin": "2.28.0",
+    "@typescript-eslint/parser": "2.28.0",
     "eslint": "6.8.0",
-    "eslint-config-prettier": "6.10.0",
-    "eslint-plugin-import": "2.20.1",
+    "eslint-config-prettier": "6.10.1",
+    "eslint-plugin-import": "2.20.2",
     "eslint-plugin-jest": "23.8.2",
-    "eslint-plugin-json": "2.1.0",
-    "eslint-plugin-node": "11.0.0",
+    "eslint-plugin-json": "2.1.1",
+    "eslint-plugin-node": "11.1.0",
     "eslint-plugin-optimize-regex": "1.1.7",
     "eslint-plugin-promise": "4.2.1",
     "eslint-plugin-sonarjs": "0.5.0",
-    "husky": "4.2.3",
+    "husky": "4.2.5",
     "is-ci-cli": "2.0.0",
-    "jest": "25.1.0",
-    "lint-staged": "10.0.8",
+    "jest": "25.3.0",
+    "lint-staged": "10.1.4",
     "markdown-toc": "^1.2.0",
-    "prettier": "1.19.1",
-    "ts-jest": "25.2.1",
+    "prettier": "2.0.4",
+    "ts-jest": "25.4.0",
     "typescript": "3.8.3"
   },
-  "resolutions": {
-    "acorn": ">=7.1.1",
-    "autolinker": ">=3.0.0"
-  },
   "license": "MIT",
   "files": [
     "bin",

src/cli.ts

@@ -73,26 +73,28 @@ export async function getInput(inputType: InputType, inputArgs: string[], ignore
     case 'stdin':
       return utils.readStdin();
 
-    default:
+    case 'command':
       return runGitDiff(inputArgs, ignore);
   }
 }
 
 export function getOutput(options: Diff2HtmlConfig, config: Configuration, input: string): string {
   if (config.htmlWrapperTemplate && !fs.existsSync(config.htmlWrapperTemplate)) {
+    process.exitCode = 4;
     throw new Error(`Template ('${config.htmlWrapperTemplate}') not found!`);
   }
 
   const diffJson = parse(input, options);
 
-  if (config.formatType === 'html') {
-    const htmlContent = html(diffJson, { ...options });
-    return prepareHTML(htmlContent, config);
-  } else if (config.formatType === 'json') {
-    return JSON.stringify(diffJson);
+  switch (config.formatType) {
+    case 'html': {
+      const htmlContent = html(diffJson, { ...options });
+      return prepareHTML(htmlContent, config);
+    }
+    case 'json': {
+      return JSON.stringify(diffJson);
+    }
   }
-
-  throw new Error(`Wrong output format '${config.formatType}'!`);
 }
 
 export function preview(content: string, format: string): void {
@@ -102,8 +104,30 @@ export function preview(content: string, format: string): void {
   open(filePath, { wait: false });
 }
 
+type CreateDiffResponse = { id: string };
+
+type ApiError = { error: string };
+
+function isCreateDiffResponse(obj: unknown): obj is CreateDiffResponse {
+  return (obj as CreateDiffResponse).id !== undefined;
+}
+
+function isApiError(obj: unknown): obj is ApiError {
+  return (obj as ApiError).error !== undefined;
+}
+
 export async function postToDiffy(diff: string, diffyOutput: DiffyType): Promise<string> {
-  const response = await http.put<{ id: string }>('https://diffy.org/api/diff/', { diff: diff });
+  const response = await http.put('https://diffy.org/api/diff/', { diff: diff });
+
+  if (!isCreateDiffResponse(response)) {
+    if (isApiError(response)) {
+      throw new Error(response.error);
+    } else {
+      throw new Error(
+        `Could not find 'id' of created diff in the response json.\nBody:\n\n${JSON.stringify(response, null, 2)}`,
+      );
+    }
+  }
 
   const url = `https://diffy.org/diff/${response.id}`;
 

src/http-utils.ts

@@ -1,36 +1,23 @@
-import request from 'request';
+import fetch from 'node-fetch';
 
-export function put<T extends object>(url: string, payload: object): Promise<T> {
-  return new Promise<T>((resolve, reject): void => {
-    request({
-      url: url,
-      method: 'PUT',
-      headers: {},
-      body: payload,
-      json: true,
-    })
-      .on('response', response => {
-        response.on('data', body => {
-          try {
-            const jsonObj = JSON.parse(body.toString('utf8'));
-            if (jsonObj as T) {
-              return resolve(jsonObj);
-            } else if (jsonObj.error !== undefined && typeof jsonObj.error === 'string') {
-              return reject(new Error(jsonObj.error));
-            } else {
-              return reject(
-                new Error(
-                  `Failed to read response.
-                Body:
-                ${body.toString('utf8')}`,
-                ),
-              );
-            }
-          } catch (err) {
-            return reject(err);
-          }
-        });
-      })
-      .on('error', err => reject(err));
+export function put(url: string, payload: object): Promise<unknown> {
+  return fetch(url, {
+    method: 'PUT',
+    headers: {
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify(payload),
+  }).then(async response => {
+    const bodyText = await response.text();
+    try {
+      return JSON.parse(bodyText);
+    } catch (error) {
+      if (error instanceof SyntaxError) {
+        throw new Error(`Failed to parse response json.\nBody:\n\n${bodyText}`);
+      } else {
+        throw error;
+      }
+    }
   });
 }

src/main.ts

@@ -12,6 +12,7 @@ export async function main(): Promise<void> {
     const input = await cli.getInput(configuration.inputSource, argv.extraArguments, configuration.ignore);
 
     if (!input) {
+      process.exitCode = 3;
       log.error('The input is empty. Try again.');
       yargs.help();
       return;
@@ -26,12 +27,17 @@ export async function main(): Promise<void> {
 
     if (configuration.outputDestinationFile) utils.writeFile(configuration.outputDestinationFile, output);
 
-    if (configuration.outputDestinationType === 'preview') {
-      cli.preview(output, configuration.formatType);
-    } else if (configuration.outputDestinationType === 'stdout') {
-      log.print(output);
+    switch (configuration.outputDestinationType) {
+      case 'preview':
+        return cli.preview(output, configuration.formatType);
+
+      case 'stdout':
+        return log.print(output);
     }
   } catch (error) {
+    if (process.exitCode === undefined || process.exitCode === 0) {
+      process.exitCode = 1;
+    }
     log.error(error);
   }
 }

template.html

@@ -25,7 +25,7 @@
       });
     </script>
   </head>
-  <body style="text-align: center; font-family: 'Source Sans Pro',sans-serif;">
+  <body style="text-align: center; font-family: 'Source Sans Pro', sans-serif;">
     <h1>Diff to HTML by <a href="https://github.com/rtfpessoa">rtfpessoa</a></h1>
 
     <div id="diff">