chore: switch from Mocha to Jest, use TypeScript for tests

Move tests to "src".
Add TypeScript configuration file.

Author: grushetsky

.gitignore

@@ -1,10 +1,10 @@
 .DS_Store
+.vscode
 
 node_modules
 npm-debug.log
 
-.nyc_output
-coverage
+.coverage
 *.lcov
 
 example/build

jest/config.json

@@ -0,0 +1,25 @@
+{
+  "collectCoverageFrom": [
+    "!**/*.d.ts",
+    "!**/node_modules/**",
+    "src/*.{ts,js}"
+  ],
+  "coverageDirectory": "<rootDir>/.coverage",
+  "coverageReporters": [
+    "lcov"
+  ],
+  "moduleFileExtensions": [
+    "js",
+    "ts"
+  ],
+  "modulePaths": [
+    "<rootDir>/src"
+  ],
+  "resetModules": true,
+  "rootDir": "../",
+  "testRegex": "/src/(.+\\.)?spec\\.ts$",
+  "transform": {
+    "^.+\\.(ts|js)$": "<rootDir>/jest/tsTransform.js"
+  },
+  "verbose": true
+}

jest/tsTransform.js

@@ -0,0 +1,17 @@
+const tsc = require('typescript');
+
+const tsconfig = require('../tsconfig.json');
+
+const compilerOptions = Object.assign({}, tsconfig.compilerOptions, {
+  module: 'commonjs',
+});
+
+module.exports = {
+  process(source, path) {
+    return (
+      path.endsWith('.ts') || path.endsWith('.js')
+        ? tsc.transpile(source, compilerOptions, path, [])
+        : source
+    );
+  },
+};

package.json

@@ -5,12 +5,11 @@
   "main": "dist/redux-logger.js",
   "scripts": {
     "lint": "eslint src",
-    "test": "npm run lint && npm run spec",
-    "spec": "nyc --all --silent --require babel-core/register mocha --plugins transform-inline-environment-variables --recursive spec/*.spec.js",
-    "spec:watch": "npm run spec -- --watch",
-    "coverage": "nyc report",
-    "coverage:html": "nyc report --reporter=html && http-server -p 8077 ./coverage -o",
-    "coverage:production": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
+    "test": "jest --config jest/config.json",
+    "test:coverage": "npm test -- --coverage",
+    "test:coverage:show": "http-server -o -p 1335 .coverage/lcov-report",
+    "test:production": "npm test:coverage -- --ci",
+    "test:watch": "npm test -- --watch",
     "clean": "rimraf dist",
     "build": "rollup -c",
     "precommit": "npm test && npm run lint",
@@ -22,21 +21,9 @@
       "no-console": "off"
     },
     "env": {
-      "browser": true,
-      "mocha": true
+      "browser": true
     }
   },
-  "nyc": {
-    "exclude": [
-      "node_modules",
-      "spec",
-      "example",
-      "lib",
-      "dist",
-      "coverage",
-      "rollup.config.js"
-    ]
-  },
   "files": [
     "dist",
     "src"
@@ -58,11 +45,11 @@
   },
   "homepage": "https://github.com/theaqua/redux-logger#readme",
   "devDependencies": {
+    "@types/jest": "^22.2.0",
     "babel-core": "^6.24.0",
     "babel-plugin-external-helpers": "^6.22.0",
     "babel-plugin-transform-inline-environment-variables": "6.8.0",
     "babel-preset-es2015": "^6.24.0",
-    "chai": "3.5.0",
     "codecov": "1.0.1",
     "eslint": "^3.19.0",
     "eslint-config-airbnb": "^14.1.0",
@@ -71,16 +58,16 @@
     "eslint-plugin-react": "^6.10.3",
     "http-server": "0.9.0",
     "husky": "^0.13.2",
-    "mocha": "3.1.2",
-    "nyc": "9.0.1",
+    "jest": "^22.4.2",
     "redux": "^3.6.0",
     "rimraf": "^2.6.1",
     "rollup": "^0.41.6",
     "rollup-plugin-babel": "^2.7.1",
     "rollup-plugin-commonjs": "^8.0.2",
     "rollup-plugin-node-resolve": "^3.0.0",
     "rollup-plugin-uglify": "^1.0.2",
-    "sinon": "^1.17.7"
+    "tslib": "^1.9.0",
+    "typescript": "^2.8.0-rc"
   },
   "dependencies": {
     "deep-diff": "^0.3.5"

spec/diff.spec.js

@@ -0,0 +1,111 @@
+import diffLogger, { style, render } from './diff';
+
+describe('Diff', () => {
+  describe('style', () => {
+    it('return css rules for the given kind of diff changes', () => {
+      expect(style('E')).toEqual('color: #2196F3; font-weight: bold');
+      expect(style('N')).toEqual('color: #4CAF50; font-weight: bold');
+      expect(style('D')).toEqual('color: #F44336; font-weight: bold');
+      expect(style('A')).toEqual('color: #2196F3; font-weight: bold');
+    });
+  });
+
+  describe('render', () => {
+    it('should return an array indicating the changes', () => {
+      expect(render({
+        kind: 'E',
+        path: ['capitain', 'name'],
+        lhs: 'kirk',
+        rhs: 'picard',
+      })).toEqual(['capitain.name', 'kirk', '→', 'picard']);
+    });
+
+    it('should return an array indicating an added property/element', () => {
+      expect(render({
+        kind: 'N',
+        path: ['crew', 'engineer'],
+        rhs: 'geordi',
+      })).toEqual(['crew.engineer', 'geordi']);
+    });
+
+    it('should return an array indicating a removed property/element', () => {
+      expect(render({
+        kind: 'D',
+        path: ['crew', 'security'],
+      })).toEqual(['crew.security']);
+    });
+
+    it('should return an array indicating a changed index', () => {
+      expect(render({
+        kind: 'A',
+        path: ['crew'],
+        index: 2,
+        item: {
+          kind: 'N',
+          rhs: 'after',
+        },
+      })).toEqual(['crew[2]', {
+        kind: 'N',
+        rhs: 'after',
+      }]);
+    });
+
+    it('should return an empty array', () => {
+      expect(render({})).toEqual([]);
+    });
+  });
+
+  describe('diffLogger', () => {
+    let logger: any;
+
+    beforeEach(() => {
+      logger = {
+        log: jest.fn(),
+        groupCollapsed: jest.fn(),
+        groupEnd: jest.fn(),
+        group: jest.fn(),
+      };
+    });
+
+    it('should show no diff with group collapsed', () => {
+      diffLogger({}, {}, logger, true);
+
+      expect(logger.group).not.toHaveBeenCalled();
+      expect(logger.groupCollapsed).toHaveBeenCalled();
+      expect(logger.groupEnd).toHaveBeenCalled();
+      expect(logger.log).toHaveBeenCalledWith('—— no diff ——');
+    });
+
+    it('should show no diff with group not collapsed', () => {
+      diffLogger({}, {}, logger, false);
+
+      expect(logger.group).toHaveBeenCalled();
+      expect(logger.groupCollapsed).not.toHaveBeenCalled();
+      expect(logger.groupEnd).toHaveBeenCalled();
+      expect(logger.log).toHaveBeenCalledWith('—— no diff ——');
+    });
+
+    it('should log no diff without group', () => {
+      const loggerWithNoGroupCollapsed = Object.assign({}, logger, {
+        groupCollapsed: () => {
+          throw new Error()
+        },
+        groupEnd: () => {
+          throw new Error()
+        },
+      });
+
+      diffLogger({}, {}, loggerWithNoGroupCollapsed, true);
+
+      expect(loggerWithNoGroupCollapsed.log).toHaveBeenCalledWith('diff');
+      expect(loggerWithNoGroupCollapsed.log).toHaveBeenCalledWith('—— no diff ——');
+      expect(loggerWithNoGroupCollapsed.log).toHaveBeenCalledWith('—— diff end —— ');
+    });
+
+    it('should log the diffs', () => {
+      diffLogger({ name: 'kirk' }, { name: 'picard' }, logger, false);
+
+      expect(logger.log).toHaveBeenCalledWith('%c CHANGED:', 'color: #2196F3; font-weight: bold', 'name', 'kirk', '→', 'picard');
+    });
+  });
+});

src/diff.spec.ts

@@ -1,23 +1,22 @@
-import { expect } from 'chai';
-import { repeat, pad, formatTime } from '../src/helpers';
+import { repeat, pad, formatTime } from './helpers';
 
-context('Helpers', () => {
+describe('Helpers', () => {
   describe('repeat', () => {
     it('should repeat a string the number of indicated times', () => {
-      expect(repeat('teacher', 3)).to.equal('teacherteacherteacher');
+      expect(repeat('teacher', 3)).toEqual('teacherteacherteacher');
     });
   });
 
   describe('pad', () => {
     it('should add leading zeros to a number given a maximun length', () => {
-      expect(pad(56, 4)).to.equal('0056');
+      expect(pad(56, 4)).toEqual('0056');
     });
   });
 
   describe('formatTime', () => {
     it('should format a time given a Date object', () => {
       const time = new Date('December 25, 1995 23:15:30');
-      expect(formatTime(time)).to.equal('23:15:30.000');
+      expect(formatTime(time)).toEqual('23:15:30.000');
     });
   });
 });