qunitx-cli 0.0.3 → 0.1.0

package/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

package/.github/workflows/push.yml

@@ -0,0 +1,36 @@
+name: docker-based-ci
+on: push
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set ENV variables
+        run: |
+          echo "REGISTRY=ghcr.io" >> $GITHUB_ENV
+          echo "REPO_OWNER=$(echo ${GITHUB_REPOSITORY%/*})" >> $GITHUB_ENV
+          echo "REPO_NAME=$(echo ${GITHUB_REPOSITORY#*/})" >> $GITHUB_ENV
+          echo "BRANCH_NAME=$(echo ${GITHUB_REF#refs/heads/} | tr / -)" >> $GITHUB_ENV
+          echo "DOCKER_TAG=$(echo ${GITHUB_REPOSITORY#*/}):$(echo ${GITHUB_REF#refs/heads/} | tr / -)" >> $GITHUB_ENV
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2.9.0
+        with:
+          install: true
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2.2.0
+        with:
+          registry: ${{env.REGISTRY}}
+          username: ${{env.REPO_OWNER}}
+          password: ${{secrets.CR_PAT}}
+      - name: Build and push
+        uses: docker/build-push-action@v4.1.1
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{env.REGISTRY}}/${{env.REPO_OWNER}}/${{env.DOCKER_TAG}}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      - name: Execute tests
+        run: docker run -t --entrypoint="npm" ${REGISTRY}/${REPO_OWNER}/${DOCKER_TAG} run test

package/CHANGELOG.md

@@ -4,8 +4,17 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [0.1.0](https://github.com/izelnakri/qunitx-cli/compare/0.0.3...0.1.0)
+
+- pkg upgrades & github CI [`7a33c07`](https://github.com/izelnakri/qunitx-cli/commit/7a33c07ef9c7b404458ac8b46f97c11009fe32fa)
+- remove --browser flag from help [`011c5ae`](https://github.com/izelnakri/qunitx-cli/commit/011c5aecb1e293bb57aa396d7ceac0fca349298f)
+- add TODO [`35a5121`](https://github.com/izelnakri/qunitx-cli/commit/35a512135d9b5abab740bfde9ae6ecb1781ab26b)
+
 #### [0.0.3](https://github.com/izelnakri/qunitx-cli/compare/0.0.2...0.0.3)
 
+> 13 July 2023
+
+- Release 0.0.3 [`0379477`](https://github.com/izelnakri/qunitx-cli/commit/037947750cc372bdd5c45389d78131bd0b8fa51e)
 - built the foundation for development [`569d860`](https://github.com/izelnakri/qunitx-cli/commit/569d8606b75287aceeaaf0b711139650182cd6c4)
 
 #### 0.0.2

package/TODO

@@ -0,0 +1,90 @@
+- "$ qunitx sanity-test.ts" made redundant due to (node --test mode) this should impact dependencies and internal modules
+- Implement other test cases in deno
+
+Shim dir structure should be: shims/nodejs/ shims/deno shims/browser
+Make package.json point to them correctly
+Make the package so esbuild build so esbuild builds when qunitx is vendored(if it needs to)
+
+Turn import { module, test } from '../../shims/nodejs.js' to import { module, test } from 'qunitx'; For this to happen browser bundler should pick up actual qunit
+
+Combine nix with Docker for faster container builds
+
+- also watch subdependencies on browser mode (-- how? investigate esbuild watch)
+- maybe make browser tests per file loading <script>, also could add asset maps maybe if puppeteer supports, this could fix initial "qf" bug
+
+implement and test require and timeout flags
+implement concurrency
+
+fix watcher for file removals make the logic smarter
+
+allow passing absolutePaths(maybe)
+
+- globs: test dynamically added file is watched on global input configuration | also check added files on watch gets put to config.fileOrFolderInputs
+currently parse-fs-inputs might be less performant on big folders(?) dependending on how watch is implemented
+- coverage
+watch parsed files from html(?)
+
+
+$ qunitx some-test --browser | default html doesnt match with $ qunitx init and also no html mode should be there
+
+try this: $ npx ava --tap | npx tap-difflet
+or this: $ npx ava --tap | npx faucet
+
+research mocha reporter(TAP > reporters | json stream metada then it consumes this metadata(how?))
+example good reporters: spec(reporter), dot, tap, landing strip(interesting instead put percentage), jest
+
+esbuild ./tmp/test/passing-tests.js  --bundle > test.js
+parse qunitx in the package.json for config
+
+failFast and babelOptions?
+files(and to ignore), require, timeout
+concurrencyStrategies
+
+add node and browser options
+add functionality to execute only one test
+add reporters
+
+pass timezone: https://stackoverflow.com/questions/16448754/how-to-use-a-custom-time-in-browser-to-test-for-client-vs-server-time-difference/39533934#39533934
+= qunitx --timezone="US/Pacific"
+
+QUnit regex filters
+
+Jest Notes
+==========
+TestSequencer
+- this failed in the past? run first
+- when file changed latest
+- this test run in the past and was long? long tests run first
+- file size
+
+TestScheduler
+- schedule across threads
+- reporters
+- dont spawn many threads if total test count is small
+jest-runner/jest-puppeteer(check this)
+
+read jest-worker/worker_thread implementation
+
+
+check if jest-qunit exists
+
+jest-runtime(creates VM context)
+allows module mocking, custom require implementation, also does transforms
+runs the tests
+transform is sync in jest(dep tracking problem)
+
+TestResult / Repoter
+- all data has to be json serializable for threads
+- stack trace of errors
+- how many assertions
+
+AggregatedRestResult[]
+- finished test case, how long, each assertion
+- check jest runners
+
+qunitx init
+
+
+write test metadata(each test) if flag is provided
+
+markdown reporter(interesting: https://mochajs.org/#markdown)

package/lib/commands/help.js

@@ -20,7 +20,6 @@ ${highlight("Input options:")}
 - Combination: $ ${color('qunitx test/foo.js test/bar.js test/*-test.js test/logout')}
 
 ${highlight("Optional flags:")}
-${color('--browser')} : run qunit tests in chromium with puppeteer instead of node.js(which is the default)
 ${color('--debug')} : print console output when tests run in browser
 ${color('--watch')} : run the target file or folders, watch them for continuous run and expose http server under localhost
 ${color('--timeout')} : change default timeout per test case
@@ -29,7 +28,7 @@ ${color('--failFast')} : run the target file or folders with immediate abort if
 ${color('--before')} : run a script before the tests(i.e start a new web server before tests)
 ${color('--after')} : run a script after the tests(i.e save test results to a file)
 
-${highlight("Example:")} $ ${color('qunitx test/foo.ts app/e2e --browser --debug --watch --before=scripts/start-new-webserver.js --after=scripts/write-test-results.js')}
+${highlight("Example:")} $ ${color('qunitx test/foo.ts app/e2e --debug --watch --before=scripts/start-new-webserver.js --after=scripts/write-test-results.js')}
 
 ${highlight("Commands:")}
 ${color('$ qunitx init')}               # Bootstraps qunitx base html and add qunitx config to package.json if needed

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qunitx-cli",
   "type": "module",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "Browser runner for QUnitx: run your qunitx tests in google-chrome",
   "main": "index.js",
   "author": "Izel Nakri",
@@ -23,7 +23,10 @@
     "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"
+    "release": "node_modules/.bin/release-it",
+    "test": "node --test test/index.js",
+    "test:sanity-first": "./cli.js test/helpers/failing-tests.js test/helpers/failing-tests.ts",
+    "test:sanity-second": "./cli.js test/helpers/passing-tests.js test/helpers/passing-tests.ts"
   },
   "engines": {
     "node": ">=20.3.0"
@@ -38,12 +41,12 @@
   "dependencies": {
     "cheerio": "^1.0.0-rc.10",
     "chokidar": "^3.5.3",
-    "esbuild": "^0.18.12",
+    "esbuild": "^0.18.14",
     "js-yaml": "^4.1.0",
     "jsdom": "^22.0.0",
     "kleur": "^4.1.5",
     "picomatch": "^2.3.1",
-    "puppeteer": "20.8.2",
+    "puppeteer": "20.8.3",
     "recursive-lookup": "1.1.0",
     "ws": "^8.13.0"
   },
@@ -54,7 +57,7 @@
     "prettier": "^3.0.0",
     "qunit": "^2.19.4",
     "qunitx": "^0.6.0",
-    "release-it": "^16.1.0"
+    "release-it": "^16.1.2"
   },
   "volta": {
     "node": "20.4.0"

package/test/commands/help-test.js

@@ -24,7 +24,6 @@ Input options:
 - Combination: $ qunitx test/foo.js test/bar.js test/*-test.js test/logout
 
 Optional flags:
---browser : run qunit tests in chromium with puppeteer instead of node.js(which is the default)
 --debug : print console output when tests run in browser
 --watch : run the target file or folders, watch them for continuous run and expose http server under localhost
 --timeout : change default timeout per test case
@@ -33,7 +32,7 @@ Optional flags:
 --before : run a script before the tests(i.e start a new web server before tests)
 --after : run a script after the tests(i.e save test results to a file)
 
-Example: $ qunitx test/foo.ts app/e2e --browser --debug --watch --before=scripts/start-new-webserver.js --after=scripts/write-test-results.js
+Example: $ qunitx test/foo.ts app/e2e --debug --watch --before=scripts/start-new-webserver.js --after=scripts/write-test-results.js
 
 Commands:
 $ qunitx init               # Bootstraps qunitx base html and add qunitx config to package.json if needed

package/test/helpers/before-script-async.js

@@ -3,7 +3,7 @@ import cors from "cors";
 import kleur from 'kleur';
 import bindServerToPort from '../../lib/setup/bind-server-to-port.js';
 import './before-script-basic.js';
-import QUnit from '../../index.js';
+import QUnit from 'qunitx';
 
 export default async function(config) {
   console.log('Starting before script with:');

package/test/helpers/before-script-web-server-tests.js

@@ -1,4 +1,4 @@
-import { module, test } from '../../index.js';
+import { module, test } from 'qunitx';
 
 module('{{moduleName}} Before script web server tests', function(hooks) {
   test('assert true works', async function (assert) {