refactor: Move all code to typescript

Author: rtfpessoa

.circleci/config.yml

@@ -15,8 +15,6 @@ jobs:
             - ./node_modules
       - run: npm run build
       - run: npm run coverage
-      - run: npm run check-coverage
-      - run: npm run report
 
   build-latest: &latest-build
     docker:
@@ -33,7 +31,7 @@ jobs:
             - ./node_modules
       - run: yarn run test
       - run: yarn run lint
-      - run: yarn run coverage-lcov
+      - run: npm run coverage
       - run: yarn run codacy
 
   build-node_8:
@@ -52,10 +50,15 @@ jobs:
       - image: node:10
 
   build-node_11:
-    <<: *latest-build
+    <<: *common-build
     docker:
       - image: node:11
 
+  build-node_12:
+    <<: *latest-build
+    docker:
+      - image: node:12
+
 workflows:
   version: 2
   build:
@@ -64,3 +67,4 @@ workflows:
       - build-node_9
       - build-node_10
       - build-node_11
+      - build-node_12

.eslintignore

@@ -1,4 +1,4 @@
 # Skip bin and coverage folders
 bin/**
 coverage/**
-built/**
+build/**

.eslintrc.json

@@ -1,4 +1,5 @@
 {
+  "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 6,
     "ecmaFeatures": {
@@ -22,13 +23,17 @@
   },
   "plugins": [
     "standard",
-    "promise"
+    "promise",
+    "@typescript-eslint"
   ],
   "globals": {
     "document": false,
     "navigator": false,
     "window": false
   },
+  "extends": [
+    "plugin:@typescript-eslint/recommended"
+  ],
   "rules": {
     "accessor-pairs": 2,
     "arrow-spacing": [
@@ -341,4 +346,4 @@
       "unix"
     ]
   }
-}
+}

.gitignore

@@ -28,4 +28,4 @@ coverage/
 bower_components/
 
 # TypeScript
-built/
+build/

CONTRIBUTING.md

@@ -17,8 +17,6 @@
 * After creating your pull request make sure the build is passing on [CircleCI](https://circleci.com/gh/rtfpessoa/diff2html-cli)
 and that [Codacy](https://www.codacy.com/app/Codacy/diff2html-cli) is also confident in the code quality.
 
-* In your pull request, do not commit the `dist` or `build` folder if you needed to build the release files.
-
 ### Commit Style
 
 Writing good commit logs is important. A commit log should describe what changed and why.

bin/diff2html

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-require("../src/main.js");
+require("../build/main.js");

jest.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+  'verbose': true,
+  'preset': 'ts-jest',
+  'testEnvironment': 'node',
+  'coverageDirectory': './coverage',
+  'coverageReporters': ['lcov', 'text', 'html'],
+  'coverageThreshold': {
+    'global': {
+      'statements': 40,
+      'branches': 15,
+      'functions': 33,
+      'lines': 40
+    }
+  }
+};

package.json

@@ -36,23 +36,21 @@
   },
   "preferGlobal": true,
   "scripts": {
+    "prepare": "yarn run build",
     "build": "tsc",
     "lint": "eslint .",
     "style": "yarn run lint",
-    "test": "yarn build && yarn run coverage",
-    "coverage": "nyc mocha",
-    "coverage-html": "nyc report --reporter=html && open ./coverage/index.html",
-    "check-coverage": "nyc check-coverage --statements 35 --functions 35 --branches 0 --lines 35",
-    "report": "nyc report",
-    "coverage-lcov": "nyc report --reporter=lcov",
+    "test": "jest",
+    "coverage": "jest --collectCoverage",
+    "coverage-html": "yarn run coverage && open ./coverage/index.html",
     "codacy": "cat ./coverage/lcov.info | codacy-coverage",
     "preversion": "yarn run test",
     "postversion": "git push && git push --tags"
   },
   "bin": {
     "diff2html": "./bin/diff2html"
   },
-  "main": "./src/main.js",
+  "main": "./build/main.js",
   "dependencies": {
     "clipboardy": "^2.1.0",
     "diff2html": "^2.11.2",
@@ -62,20 +60,24 @@
     "yargs": "^14.0.0"
   },
   "devDependencies": {
+    "@types/diff2html": "0.0.5",
+    "@types/jest": "24.0.18",
+    "@types/node": "^11.9.4",
+    "@types/request": "2.48.2",
+    "@typescript-eslint/eslint-plugin": "2.0.0",
+    "@typescript-eslint/parser": "2.0.0",
     "codacy-coverage": "^3.4.0",
-    "eslint": "^6.2.1",
+    "eslint": "6.2.1",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
-    "mocha": "^6.2.0",
-    "nyc": "^14.1.1",
-    "sinon": "^7.4.1",
-    "@types/node": "^11.9.4",
+    "jest": "24.9.0",
+    "ts-jest": "24.0.2",
     "typescript": "^3.3.3"
   },
   "license": "MIT",
   "files": [
     "bin",
-    "src",
-    "dist"
+    "build",
+    "template.html"
   ]
-}
+}

src/__tests__/cli-tests.ts

@@ -0,0 +1,57 @@
+import * as cli from '../cli';
+import * as http from '../http-utils';
+import * as utils from '../utils';
+
+beforeEach(() => jest.clearAllMocks());
+
+describe('cli', () => {
+  describe('getInput', () => {
+    test('should readFile when inputType is `file`', () => {
+      jest.spyOn(utils, 'readFile').mockImplementationOnce(() => { });
+
+      cli.getInput('file', ['lol', 'foo'], [], 'callback');
+
+      expect(utils.readFile).toBeCalledTimes(1);
+      expect(utils.readFile).toBeCalledWith('lol', 'callback');
+    });
+
+    test('should readStdin when inputType is `stdin`', () => {
+      jest.spyOn(utils, 'readStdin').mockImplementationOnce(() => { });
+
+      cli.getInput('stdin', ['lol'], [], 'callback');
+
+      expect(utils.readStdin).toBeCalledTimes(1);
+      expect(utils.readStdin).toBeCalledWith('callback');
+    });
+
+    test('should readStdin when inputType is `command`', () => {
+      jest.spyOn(cli, 'runGitDiff').mockImplementationOnce(() => { });
+
+      cli.getInput('command', ['lol', 'foo'], [], 'callback');
+
+      expect(cli.runGitDiff).toBeCalledTimes(1);
+      expect(cli.runGitDiff).toBeCalledWith(['lol', 'foo'], [], 'callback');
+    });
+  });
+
+  describe('preview', () => {
+    test('should call `utils.writeFile`', () => {
+      jest.spyOn(utils, 'writeFile').mockImplementationOnce(() => { });
+
+      cli.preview('a', 'b');
+
+      expect(utils.writeFile).toBeCalledTimes(1);
+    });
+  });
+
+  describe('postToDiffy', () => {
+    test('should call `http.put`', () => {
+      jest.spyOn(http, 'put').mockImplementationOnce(() => Promise.resolve('http://example.com'));
+
+      cli.postToDiffy('a', 'print');
+
+      expect(http.put).toBeCalledTimes(1);
+      expect(http.put).toBeCalledWith('https://diffy.org/api/diff/', { diff: 'a' });
+    });
+  });
+});

src/__tests__/utils-tests.ts

@@ -0,0 +1,27 @@
+import * as utils from '../utils';
+
+beforeEach(() => jest.clearAllMocks());
+
+describe('utils', () => {
+  describe('io', () => {
+    var stringToCompare = 'This is a rand0m preTTy string to write and read a file';
+
+    test('should write and read file synchronously', () => {
+      utils.writeFile('/tmp/file.test', stringToCompare);
+
+      var contentRead = utils.readFileSync('/tmp/file.test');
+
+      expect(stringToCompare).toBe(contentRead);
+    });
+
+    test('should write synchronously and read file asynchronously', (done) => {
+      utils.writeFile('/tmp/file.test', stringToCompare);
+
+      utils.readFile('/tmp/file.test', function (err, content) {
+        expect(err).toBe(null);
+        expect(stringToCompare).toBe(content);
+        done();
+      });
+    });
+  });
+});