Remove Grunt (#587)

* Delete Gruntfile.js

* Remove all Grunt-related dependencies

* Remove reference to Gruntfile from .npmignore

* Rename undocumented `build:node` script to just `build`

I intend to make it the build script in due course. Needs more steps currently.

* Reimplement build command (I think? Need to compare output carefully) and stub test commands

* Get tests running again, but without coverage

* Bump to latest istanbul and get it working by roughly following https://istanbul.js.org/docs/tutorials/es2015/

* Restore mandatory 100% coverage

* Replace a reference to grunt

* Remove another grunt reference from the docs

* Restore uglifyjs

* Make yarn test always check coverage

* oops

* Restore support for in-browser testing

* Remove unneeded stuff

* Remove unnecessary noInfo option

* Run yarn upgrade

Author: ExplodingCabbage

.babelrc

@@ -1,6 +1,11 @@
 {
   "sourceMaps": "inline",
   "presets": ["@babel/preset-env"],
-  "auxiliaryCommentBefore": "istanbul ignore start",
-  "auxiliaryCommentAfter": "istanbul ignore end"
+  "env": {
+    "test": {
+      "plugins": [
+        "istanbul"
+      ]
+    }
+  }
 }

.gitignore

@@ -5,3 +5,4 @@ lib
 dist
 yarn-error.log
 .vscode
+.nyc_output

.npmignore

@@ -3,10 +3,10 @@
 .gitignore
 .npmignore
 .vscode
+.nyc_output
 components
 coverage
 examples
-Gruntfile.js
 images
 index.html
 karma.conf.js

CONTRIBUTING.md

@@ -12,25 +12,27 @@ Generally we like to see pull requests that
 - Have tests
 - Don't decrease the current code coverage (see coverage/lcov-report/index.html)
 
-## Building
+## Building and testing
 
 ```
 yarn
 yarn test
 ```
 
-Running `yarn test -- dev` will watch for tests within Node and `karma start` may be used for manual testing in browsers.
+To run tests in a *browser* (for instance to test compatibility with Firefox, with Safari, or with old browser versions), run `yarn karma start`, then open http://localhost:9876/ in the browser you want to test in. Results of the test run will appear in the terminal where `yarn karma start` is running.
 
 If you notice any problems, please report them to the GitHub issue tracker at
 [http://github.com/kpdecker/jsdiff/issues](http://github.com/kpdecker/jsdiff/issues).
 
 ## Releasing
 
+Run a test in Firefox via the procedure above before releasing.
+
 A full release may be completed by first updating the `"version"` property in package.json, then running the following:
 
 ```
 yarn clean
-yarn grunt release
+yarn build
 yarn publish
 ```
 

Gruntfile.js

@@ -1,5 +1,5 @@
 <!-- If you want to try this example from within the jsdiff repo, run
-     `yarn grunt` first to build ../dist/diff.js then open this HTML file in
+     `yarn build` first to build ../dist/diff.js then open this HTML file in
      a browser. -->
 <pre id="display"></pre>
 <script src="../dist/diff.js"></script>

examples/web_example.html

@@ -1,13 +1,6 @@
 /* eslint-env node */
 /* eslint-disable no-var, camelcase */
 module.exports = function(config) {
-  var customLaunchers = {
-    HeadlessChrome: {
-      base: 'ChromeHeadless',
-      flags: ['--no-sandbox']
-    }
-  };
-
   config.set({
     basePath: '',
 
@@ -32,19 +25,13 @@ module.exports = function(config) {
         ]
       }
     },
-    webpackMiddleware: {
-      noInfo: true
-    },
 
     reporters: ['mocha'],
 
-    customLaunchers: customLaunchers,
     port: 9876,
     colors: true,
     logLevel: config.LOG_INFO,
     autoWatch: true,
     singleRun: false,
-
-    browsers: ['HeadlessChrome']
   });
 };

karma.conf.js

@@ -42,9 +42,15 @@
     "./*": "./*"
   },
   "scripts": {
-    "clean": "rm -rf lib/ dist/",
-    "build:node": "yarn babel --out-dir lib  --source-maps=inline src",
-    "test": "grunt"
+    "clean": "rm -rf lib/ dist/ coverage/ .nyc_output/",
+    "lint": "yarn eslint 'src/**/*.js' 'test/**/*.js'",
+    "build": "yarn lint && yarn run-babel && yarn run-rollup && yarn run-uglify",
+    "test": "nyc yarn _test",
+    "_test": "yarn build && cross-env NODE_ENV=test yarn run-mocha",
+    "run-babel": "babel --out-dir lib  --source-maps=inline src",
+    "run-rollup": "rollup -c rollup.config.mjs",
+    "run-uglify": "uglifyjs dist/diff.js -c -o dist/diff.min.js",
+    "run-mocha": "mocha --require ./runtime 'test/**/*.js'"
   },
   "devDependencies": {
     "@babel/cli": "^7.24.1",
@@ -55,33 +61,39 @@
     "@colors/colors": "^1.6.0",
     "babel-eslint": "^10.0.1",
     "babel-loader": "^9.1.3",
+    "babel-plugin-istanbul": "^7.0.0",
     "chai": "^4.2.0",
+    "cross-env": "^7.0.3",
     "eslint": "^5.12.0",
-    "grunt": "^1.6.1",
-    "grunt-babel": "^8.0.0",
-    "grunt-cli": "^1.4.3",
-    "grunt-contrib-clean": "^2.0.1",
-    "grunt-contrib-copy": "^1.0.0",
-    "grunt-contrib-uglify": "^5.2.2",
-    "grunt-contrib-watch": "^1.1.0",
-    "grunt-eslint": "^24.3.0",
-    "grunt-exec": "^3.0.0",
-    "grunt-karma": "^4.0.2",
-    "grunt-mocha-istanbul": "^5.0.2",
-    "grunt-mocha-test": "^0.13.3",
-    "grunt-webpack": "^6.0.0",
-    "istanbul": "github:kpdecker/istanbul",
     "karma": "^6.4.3",
-    "karma-chrome-launcher": "^3.2.0",
     "karma-mocha": "^2.0.1",
     "karma-mocha-reporter": "^2.2.5",
     "karma-sourcemap-loader": "^0.4.0",
     "karma-webpack": "^5.0.1",
     "mocha": "^7.0.0",
+    "nyc": "^17.1.0",
     "rollup": "^4.13.0",
     "rollup-plugin-babel": "^4.2.0",
+    "uglify-js": "^3.19.3",
     "webpack": "^5.90.3",
     "webpack-dev-server": "^5.0.3"
   },
-  "optionalDependencies": {}
+  "optionalDependencies": {},
+  "dependencies": {},
+  "nyc": {
+    "require": [
+      "@babel/register"
+    ],
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "sourceMap": false,
+    "instrument": false,
+    "check-coverage": true,
+    "branches": 100,
+    "lines": 100,
+    "functions": 100,
+    "statements": 100
+  }
 }