Update for 2020: Headless Firefox, Semistandard, NYC report, Coveralls

== Update to Karma 5 ==

* Introducing Headless Firefox.

  Use Headless Firefox by default instead of Headless Chrome.
  This tends to be more stable, especially in development environments
  that use Docker where Chrome has root/sandboxing requirements that
  allow non-trivial "last mile" configuration, causing things like
  karma, grunt and puppeteer to always fail by default and thus create
  a barrier to entry. Ref puppeteer/puppeteer#5505.

* karma-cli no longer needed.

== Update ESLint and use Semistandard ==

* Introducing Semistandard

  Remove custom ESLint configuration and use Semistandard wrapper.
  Less configuration to fiddle with. It just works. Set any overrides
  local to the individual JS files. No more opinionated or indirect per-repo
  or per-directory overrides. Follow the standard™!

* Switch excludes from package.json to .eslintignore file.

* Switch .eslintrc from YAML to JSON, and add a `.json` file extension.

* Update test files to use modern ES6 syntax.

== Combined code coverage reports! ==

* Introducing NYC.

  Use NYC to generate code coverage from the Node.js test run.

  And, more importantly, use NYC to generate a combined code coverage report
  from both the Node.js and web browser test runs. This is possible by
  configuring karma-coverage in karma.conf.js to save the internal JSON file,
  without a 'subdir'. (This matches what the `nyc` command does for Node.js)
  These two are then combined by the `nyc report` command.

* Introducing Coveralls.

  Switch from Codecov to Coveralls <https://coveralls.io/>.

Author: Krinkle

Diff for: .editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

Diff for: .eslintignore

@@ -0,0 +1,2 @@
+/.nyc_output
+/coverage

Diff for: .eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "root": true,
+  "extends": "semistandard"
+}

Diff for: .eslintrc.yml

@@ -1,3 +1,4 @@
+/.nyc_output
 /coverage
 /node_modules
 /npm-debug.log

Diff for: .gitignore

@@ -1,18 +1,15 @@
-sudo: false
-dist: trusty
 language: node_js
-
-node_js:
- - "8"
-
 addons:
-  chrome: stable
-
-after_success:
- - npm install -g [email protected]
- - codecov
-
-# notifications:
-#   irc:
-#     channels:
-#       - "chat.freenode.net#example"
+  firefox: latest
+node_js:
+ - "14"
+ - "12"
+ - "10"
+script: npm test
+
+jobs:
+  include:
+    - name: Coverage
+      os: linux
+      node_js: "14"
+      script: npm run coveralls

Diff for: .travis.yml

@@ -1,14 +1,15 @@
-[![Build Status](https://travis-ci.org/Krinkle/travis-ci-node-and-browser-qunit.svg?branch=master)](https://travis-ci.org/Krinkle/travis-ci-node-and-browser-qunit) [![Code coverage](https://img.shields.io/codecov/c/github/Krinkle/travis-ci-node-and-browser-qunit.svg)](https://codecov.io/gh/Krinkle/travis-ci-node-and-browser-qunit)
+[![Build Status](https://travis-ci.com/Krinkle/travis-ci-node-and-browser-qunit.svg?branch=master)](https://travis-ci.com/github/Krinkle/travis-ci-node-and-browser-qunit) [![Coverage Status](https://coveralls.io/repos/github/Krinkle/travis-ci-node-and-browser-qunit/badge.svg?branch=master)](https://coveralls.io/github/Krinkle/travis-ci-node-and-browser-qunit?branch=master)
 
-# Run QUnit in Node.js and Chrome! (using Travis CI)
+# Run QUnit on the web and in Node.js!
 
-This project is an example of how to approach continuous integration
-by running QUnit tests inside a headless browser (Chrome) and/or inside Node.js.
+This is an example project showing an approach running QUnit in continuous integration
+with the same application and test suite run both in a web browser (Headless Firefox) and
+on Node.js, plus (combined) code coverage reports.
 
 ## Get started
 
 Clone or fork this repository and be sure to run the following two commands to
-install the dependencies and start the first test run:
+install the development dependencies and kick off your first test run:
 
 <pre lang="bash">
 npm install
@@ -17,29 +18,12 @@ npm test
 
 ## Tell me more
 
-[Travis CI](https://travis-ci.org/) provides cloud-based [Continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) for open source projects on GitHub. After you enable it, Travis CI will automatically run the tests and report back whenever you `git push`,
-or submit a pull-request.
+[Travis CI](https://travis-ci.com/) provides cloud-based [Continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) for open source projects on GitHub. After you enable it, Travis automatically runs the tests and reports back whenever you `git push`, or submit a pull-request.
 
-This boilerplate repository has Travis enabled ([view build history](https://travis-ci.org/Krinkle/travis-ci-node-and-browser-qunit)).
+This boilerplate repository has Travis enabled ([view build history](https://travis-ci.com/github/Krinkle/travis-ci-node-and-browser-qunit)).
 
-Just get into it, have a look at it all, you'll get the hang of it, it's easy!
-If you've got any problems, feel free to ask on Twitter or [file an issue](https://github.com/Krinkle/travis-ci-node-and-browser-qunit/issues).
+Take a look around, you'll get the hang of it, it's easy!
+If you've got any questions or problems, feel free to [file an issue](https://github.com/Krinkle/travis-ci-node-and-browser-qunit/issues).
 
 * [@Krinkle](https://github.com/Krinkle) ([Twitter](https://twitter.com/TimoTijhof))
 * [@keithamus](https://github.com/keithamus) ([Twitter](https://twitter.com/keithamus))
-
-By default, Travis-CI will execute the `npm test` command, which in this example
-repository runs `grunt test` and `node test/node-index.js`. The Gruntfile takes care
-of running ESLint and running the QUnit tests in Headless Chrome.
-The second script runs the unit tests in Node.js (without a browser environment).
-
-Depending on the kind of project you have you may want to keep only one of these.
-
-If your application only runs in a browser:
-* Remove `test/node-test.js`
-* Remove the `qunit test/node-index.js` command from `scripts.test` in `package.json`
-
-If your app is written specifically for Node.js only, then:
-* Remove `karma.conf.js`
-* Remove the `karma-debug` run script from `package.json`
-* Remove `karma` and `karma-*` from the `devDependencies` in `package.json`

Diff for: README.md

@@ -1,31 +1,28 @@
 /* eslint-env node */
+
 module.exports = function (config) {
-	config.set({
-		// To debug, run `npm run karma-debug` and press the "Debug" button in the browser window
-		browsers: [ 'ChromeHeadless' ],
-		frameworks: [ 'qunit' ],
-		files: [
-			'src/MyLib.js',
-			'test/MyLib.test.js'
-		],
-		autoWatch: false,
-		singleRun: true,
-		preprocessors: {
-			'src/*.js': [ 'coverage' ]
-		},
-		reporters: [ 'dots', 'coverage' ],
-		coverageReporter: {
-			reporters: [
-				{ type: 'text-summary' },
-				{ type: 'html', dir:'coverage/' },
-				{ type: 'lcovonly', dir: 'coverage/' },
-			],
-			check: { global: {
-				functions: 90,
-				statements: 50,
-				branches: 50,
-				lines: 50
-			} }
-		}
-	});
+  config.set({
+    browsers: ['FirefoxHeadless'],
+    frameworks: ['qunit'],
+    files: [
+      'src/MyLib.js',
+      'test/*.test.js'
+    ],
+    autoWatch: false,
+    singleRun: true,
+    preprocessors: {
+      'src/*.js': ['coverage']
+    },
+    reporters: ['dots', 'coverage'],
+    coverageReporter: {
+      reporters: [
+        { type: 'lcov', dir: '.nyc_output/' },
+        // Karma uses subdirs by default to account for multiple browsers.
+        // For the JSON file, it's important we disable 'subdir' so that
+        // the 'nyc report' command can pick this up when combining code
+        // coverage with the Node.js test run.
+        { type: 'json', dir: '.nyc_output/', subdir: '.' }
+      ]
+    }
+  });
 };

Diff for: karma.conf.js

@@ -1,20 +1,31 @@
 {
   "private": true,
   "scripts": {
-    "test": "eslint . && qunit test/node-index.js && karma start",
-    "karma-debug": "karma start --no-single-run --browsers Chrome --logLevel DEBUG"
+    "lint": "semistandard",
+    "test-node": "qunit --require ./test/setup test/",
+    "test-node-cover": "nyc qunit --require ./test/setup test/",
+    "test-node-watch": "qunit --watch --require ./test/setup test/",
+    "test-browser": "karma start",
+    "test-browser-watch": "karma start --auto-watch --no-single-mode",
+    "test": "npm run lint && npm run test-node && npm run test-browser",
+    "cover": "npm run test-node-cover && npm run test-browser && nyc report",
+    "coveralls": "npm run cover && cat coverage/lcov.info | coveralls"
   },
-  "eslintIgnore": [
-    "/coverage"
-  ],
   "dependencies": {},
   "devDependencies": {
-    "eslint": "4.3.0",
-    "karma": "1.7.0",
-    "karma-chrome-launcher": "2.2.0",
-    "karma-cli": "^1.0.1",
-    "karma-coverage": "1.1.1",
-    "karma-qunit": "1.2.1",
-    "qunitjs": "2.4.0"
+    "coveralls": "^3.1.0",
+    "karma": "^5.2.3",
+    "karma-chrome-launcher": "^3.1.0",
+    "karma-coverage": "^2.0.3",
+    "karma-firefox-launcher": "^2.1.0",
+    "karma-qunit": "^4.1.1",
+    "nyc": "^15.1.0",
+    "qunit": "^2.12.0",
+    "semistandard": "^14.0.0"
+  },
+  "nyc": {
+    "temp-dir": ".nyc_output/",
+    "report-dir": "coverage/",
+    "reporter": ["text", "lcov"]
   }
 }

Diff for: package.json

@@ -1,47 +1,34 @@
 (function (global) {
-	var originalMyLib = global.MyLib;
-
-	function MyLib(a, b) {
-		this.a = a;
-		this.b = b;
-	}
-
-	/* Static members */
-
-	/**
-	 * We love everything that isn't undefined.
-	 * If it is defined, it is cool in our book.
-	 *
-	 * @param {mixed} o
-	 * @return {boolean}
-	 */
-	MyLib.isAwesome = function isAwesome(o) {
-		return o !== undefined;
-	};
-
-	/* Instance members */
-
-	MyLib.prototype.a = 'a';
-
-	MyLib.prototype.b = 'b';
-
-	if (typeof module !== 'undefined' && module.exports) {
-		module.exports = MyLib;
-	} else {
-		global.MyLib = MyLib;
-
-		/**
-		 * For browsers, also implement a noConflict that restores
-		 * the orignal value of the used global (if any).
-		 * @example
-		 * <code>
-		 *     var someLib = MyLib.noConflict();
-		 * </code>
-		 */
-		MyLib.noConflict = function () {
-			global.MyLib = originalMyLib;
-			return MyLib;
-		};
-	}
-
+  /**
+   * @class
+   * @constructor
+   * @param {string} a
+   * @param {string} b
+   */
+  function MyLib (a, b) {
+    this.a = a;
+    this.b = b;
+  }
+
+  /**
+   * @static
+   * @param {Mixed} o
+   * @return {boolean}
+   */
+  MyLib.isAwesome = function (value) {
+    return value !== undefined;
+  };
+
+  /**
+   * @return {string}
+   */
+  MyLib.prototype.getAye = function () {
+    return this.a;
+  };
+
+  if (typeof module !== 'undefined' && module.exports) {
+    module.exports = MyLib;
+  } else {
+    global.MyLib = MyLib;
+  }
 }(this));

Diff for: src/MyLib.js

@@ -0,0 +1,26 @@
+/* global QUnit */
+
+QUnit.module('General');
+
+QUnit.test('foo', assert => {
+  assert.equal('Foo', 'Foo', 'similar strings');
+  assert.equal(true, 1, 'true and one');
+  assert.strictEqual(true, true, 'just true');
+});
+
+QUnit.test('bar', assert => {
+  const x = { one: 1, two: 2 };
+  const y = x;
+
+  assert.strictEqual(
+    x,
+    y,
+    'same object by reference'
+  );
+
+  assert.deepEqual(
+    { one: 1, two: 2 },
+    { one: 1, two: 2 },
+    'distinct objects with similar keys and values'
+  );
+});