Build: Use qunit/ during development instead of dist/

Use the same directory structure for the build artefact during
releases and during development.

Since the release file path is used by published npm and bower
packages, keep that as-is, and rename the internal development
target from dist/ to qunit/.

After this, contributors and maintainers will want to delete any
dist/ directory they might have, to avoid accidental linting or
publishing.

Author: Krinkle

.eslintrc.json

@@ -36,8 +36,8 @@
         "__codeorigin/**",
         "coverage/**",
         "docs/_site/**",
-        "dist/**",
         "lib/**",
+        "qunit/**",
         "temp/**"
     ],
     "overrides": [

.gitignore

@@ -1,8 +1,7 @@
 /.nyc_output
 /__codeorigin
 /coverage
-/dist
 /node_modules
-/browserstack-run.pid
+/qunit
 /temp
 /docs/_site/

Gruntfile.js

@@ -46,7 +46,7 @@ module.exports = function( grunt ) {
 
 			"src-css": {
 				src: "src/qunit.css",
-				dest: "dist/qunit.css"
+				dest: "qunit/qunit.css"
 			}
 		},
 		eslint: {

RELEASE.md

@@ -89,11 +89,6 @@ This guide walks you through the QUnit release.
    npm run build
    ```
 
-   * Rename `dist/` to `qunit/`:
-   ```
-   mv dist/ qunit/
-   ```
-
    * Review the changes to the package and library files, compared to the previous release.
    ```
    node build/review-package.js @LAST_VERSION

build/tasks/test-on-node.js

@@ -18,7 +18,7 @@ module.exports = function( grunt ) {
 		}
 
 		// Refresh the QUnit global to be used in other tests
-		global.QUnit = requireFresh( "../../dist/qunit" );
+		global.QUnit = requireFresh( "../../qunit/qunit.js" );
 
 		done( !totals.failed );
 	} );
@@ -33,7 +33,7 @@ module.exports = function( grunt ) {
 
 		// Resolve current QUnit path and remove it from the require cache
 		// to avoid stacking the QUnit logs.
-		var QUnit = requireFresh( "../../dist/qunit" );
+		var QUnit = requireFresh( "../../qunit/qunit.js" );
 
 		// Expose QUnit to the global scope to be seen on the other tests.
 		global.QUnit = QUnit;

package.json

@@ -91,13 +91,13 @@
     "authors": "grunt authors",
     "coverage": "npm run build:coverage && npm run coverage:_cli && npm run coverage:_main && nyc report",
     "coverage:_cli": "nyc --use-spawn-wrap --silent bin/qunit.js test/cli/*.js",
-    "coverage:_main": "nyc instrument --in-place dist/ && grunt connect:nolivereload qunit",
+    "coverage:_main": "nyc instrument --in-place qunit/ && grunt connect:nolivereload qunit",
     "coveralls": "npm run coverage && cat coverage/lcov.info | coveralls"
   },
   "nyc": {
     "include": [
       "bin/**",
-      "dist/**",
+      "qunit/**",
       "src/**"
     ],
     "reporter": [

rollup.config.js

@@ -12,7 +12,7 @@ const isCoverage = process.env.BUILD_TARGET === "coverage";
 module.exports = {
 	input: "src/qunit.js",
 	output: {
-		file: "dist/qunit.js",
+		file: "qunit/qunit.js",
 		sourcemap: isCoverage,
 		format: "iife",
 		exports: "none",

src/cli/require-qunit.js

@@ -3,7 +3,19 @@
 module.exports = function requireQUnit( resolve = require.resolve ) {
 	try {
 
-		// First we attempt to find QUnit relative to the current working directory.
+		// For:
+		//
+		// - QUnit is installed as local dependency and invoked normally
+		//   within the current project, e.g. via `npm test`, `npm run …`,
+		//   or `node_modules/.bin/qunit`.
+		//   The below will lead to the same package directory that
+		//   the CLI command belonged to.
+		//
+		// - QUnit is installed both as local dependency in the current project,
+		//   and also globally installed via npm by the end-user.
+		//   If the user (accidentally) ran the CLI command from their global
+		//   install, then we prefer to stil use the qunit library file from the
+		//   current project's dependency.
 		// eslint-disable-next-line node/no-missing-require
 		const localQUnitPath = resolve( "qunit", {
 
@@ -14,24 +26,25 @@ module.exports = function requireQUnit( resolve = require.resolve ) {
 		delete require.cache[ localQUnitPath ];
 		return require( localQUnitPath );
 	} catch ( e ) {
-		try {
+		if ( e.code === "MODULE_NOT_FOUND" ) {
 
-			// Second, we use the globally installed QUnit
-			// eslint-disable-next-line node/no-unpublished-require, node/no-missing-require
+			// For:
+			//
+			// - QUnit is installed globally via npm by the end-user, and the
+			//   the user ran this global CLI command in a project directory that
+			//   does not have a qunit dependency installed.
+			//   Use the library file relative to the global CLI command in that case.
+			//
+			// - We are running a local command from within the source directory
+			//   of the QUnit project itself (e.g. qunit Git repository).
+			//   Use the library file relative to this command, within the source directory.
+			//
+			// eslint-disable-next-line node/no-missing-require, node/no-unpublished-require
 			delete require.cache[ resolve( "../../qunit/qunit" ) ];
 			// eslint-disable-next-line node/no-missing-require, node/no-unpublished-require
 			return require( "../../qunit/qunit" );
-		} catch ( e ) {
-			if ( e.code === "MODULE_NOT_FOUND" ) {
-
-				// Finally, we use the local development version of QUnit
-				// eslint-disable-next-line node/no-unpublished-require, node/no-missing-require
-				delete require.cache[ resolve( "../../dist/qunit" ) ];
-				// eslint-disable-next-line node/no-missing-require, node/no-unpublished-require
-				return require( "../../dist/qunit" );
-			}
-
-			throw e;
 		}
+
+		throw e;
 	}
 };

test/amd.html

@@ -3,7 +3,7 @@
 <head>
 	<meta charset="UTF-8">
 	<title>QUnit AMD Test Suite</title>
-	<link rel="stylesheet" href="../dist/qunit.css">
+	<link rel="stylesheet" href="../qunit/qunit.css">
 	<script src="../node_modules/requirejs/require.js"></script>
 </head>
 <body>
@@ -13,7 +13,7 @@
 
 	require.config( {
 		paths: {
-			qunit: "../dist/qunit"
+			qunit: "../qunit/qunit"
 		}
 	} );
 

test/autostart.html

@@ -3,11 +3,11 @@
 <head>
 	<meta charset="UTF-8">
 	<title>QUnit Autostart Test Suite</title>
-	<link rel="stylesheet" href="../dist/qunit.css">
+	<link rel="stylesheet" href="../qunit/qunit.css">
 </head>
 <body>
 	<div id="qunit"></div>
-	<script src="../dist/qunit.js"></script>
+	<script src="../qunit/qunit.js"></script>
 	<script>
 	window.times = {};