qunitx-cli 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+### Changelog
+
+All notable changes to this project will be documented in this file. Dates are displayed in UTC.
+
+Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
+
+#### 0.0.2
+
+- init [`4d2ac8f`](https://github.com/izelnakri/qunitx-cli/commit/4d2ac8fd98ce7a4c988f9036064a6ef592b55f8f)

package/README.md

@@ -0,0 +1,92 @@
+# QUnitX CLI
+
+CI browser runner for [qunitx](https://github.com/izelnakri/qunitx)
+
+![QunitX terminal output](https://raw.githubusercontent.com/izelnakri/qunitx/main/docs/qunitx-help-stdout.png)
+
+Default test output is TAP (_Test-Anything-Protocol_) thus you can use any tap reporter of your choice to display test
+output in anyway you like. Example:
+
+```zsh
+# using it with tap-difflet TAP reporter:
+qunitx tests/attachments tests/user | npx tap-difflet
+```
+
+#### Installation:
+
+```zsh
+npm install -g qunitx-cli
+
+qunitx
+```
+
+In order to use qunitx to execute existing qunit tests please change:
+
+```js
+import { module, test } from 'qunit';
+
+// to:
+import { module, test } from 'qunitx';
+```
+
+Example:
+
+```js
+// in some-test.js: (typescript is also supported for --browser mode and node.js with --loader flag)
+import { module, test } from 'qunitx';
+import $ from 'jquery';
+
+module('Basic sanity check', function (hooks) {
+  test('it works', function (assert) {
+    assert.equal(true, true);
+  });
+
+  module('More advanced cases', function (hooks) {
+    test('deepEqual works', function (assert) {
+      assert.deepEqual({ username: 'izelnakri' }, { username: 'izelnakri' });
+    });
+    test('can import ES & npm modules', function (assert) {
+      assert.ok(Object.keys($));
+    });
+  });
+});
+```
+
+```zsh
+# you can run the test in node with ES modules package.json{ "type": "module" }
+$ node --test some-test.js
+
+# Suggested mode: if you want to run it in CI/google chrome:
+
+$ qunitx some-test.js
+
+# with browser output enabled:
+
+$ qunitx some-test.js --debug
+
+# TypeScript also works, make sure on node.js mode, tsconfig.json exists with compilerOptions.module & compilerOptions.moduleResolution set to "NodeNext":
+
+$ node --loader=ts-node/esm/transpile-only --test some-test.ts
+
+$ qunitx some-test.ts --debug
+
+```
+
+### Code coverage
+
+Since QUnitX proxies to default node.js test runner in when executed with node, you can use any code coverage tool you like. When running the tests in `qunit`(the browser mode) code coverage support is limited.
+```
+c8 node test/attachments test/user
+```
+
+You can browse [c8 documentation](https://github.com/bcoe/c8) for all configuration options.
+
+Implementing code coverage for the browser mode is currently not possible because we use esbuild --bundle feature to
+create a JS bundles for testing in the browser, this could be instrumented with `puppeteer-to-istanbul` however
+instrumentation includes transpiled npm imports of `qunitx` and other potential npm imports developer
+includes in the code, this cannot be filtered since potential filtering can only occur after the `esbuild` bundling.
+When chrome browser and puppeteer fully supports ES asset maps we can remove esbuild from the browser mode, run
+everything in deno and make instrumentation for code coverage possible with the default v8 instrumentation.
+
+Esbuild plugin interface is an ongoing development, we might be able to figure out a way to generate this instrumentation
+with esbuild in the future, which could allow code coverage for --browser mode.

package/build.js

@@ -0,0 +1 @@
+console.log('TODO: build.js');

package/cli.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env -S TS_NODE_COMPILER_OPTIONS='{"module":"ES2020"}' node --loader ts-node/esm/transpile-only
+console.log('Future QUnitX CLI');

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "qunitx-cli",
+  "type": "module",
+  "version": "0.0.2",
+  "description": "Browser runner for QUnitx: run your qunitx tests in google-chrome",
+  "main": "index.js",
+  "author": "Izel Nakri",
+  "license": "MIT",
+  "keywords": [
+    "test runner",
+    "testing",
+    "browser",
+    "ci",
+    "qunit",
+    "qunitx"
+  ],
+  "scripts": {
+    "bin": "chmod +x cli.js && ./cli.js",
+    "build": "node build.js",
+    "changelog:unreleased": "node_modules/.bin/auto-changelog --stdout --commit-limit false --package --unreleased-only --hide-credit --sort-commits date-desc",
+    "changelog:preview": "node_modules/.bin/auto-changelog --stdout --commit-limit false --package -u --sort-commits date-desc",
+    "changelog:update": "node_modules/.bin/auto-changelog --commit-limit false --package --sort-commits date-desc",
+    "prepack": "npm run build",
+    "release:alpha": "node_modules/.bin/release-it --preRelease=alpha --no-git.requireUpstream",
+    "release:beta": "node_modules/.bin/release-it --preRelease=beta --no-git.requireUpstream",
+    "release": "node_modules/.bin/release-it"
+  },
+  "engines": {
+    "node": ">=20.3.0"
+  },
+  "bin": {
+    "qunitx": "cli.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/izelnakri/qunitx-cli.git"
+  },
+  "dependencies": {
+    "cheerio": "^1.0.0-rc.10",
+    "chokidar": "^3.5.3",
+    "esbuild": "^0.18.12",
+    "js-yaml": "^4.1.0",
+    "jsdom": "^22.0.0",
+    "kleur": "^4.1.5",
+    "picomatch": "^2.3.1",
+    "puppeteer": "20.8.2",
+    "recursive-lookup": "1.1.0",
+    "ws": "^8.13.0"
+  },
+  "devDependencies": {
+    "auto-changelog": "^2.4.0",
+    "cors": "^2.8.5",
+    "express": "^4.17.3",
+    "prettier": "^3.0.0",
+    "qunit": "^2.19.4",
+    "qunitx": "^0.6.0",
+    "release-it": "^16.1.0"
+  },
+  "volta": {
+    "node": "20.4.0"
+  },
+  "prettier": {
+    "printWidth": 100,
+    "singleQuote": true,
+    "arrowParens": "always"
+  },
+  "release-it": {
+    "git": {
+      "changelog": "npm run changelog:unreleased"
+    },
+    "github": {
+      "release": true
+    },
+    "hooks": {
+      "after:bump": "npm run changelog:update"
+    }
+  }
+}