@itee/benchmarks-framework 1.0.0

package/.czrc

@@ -0,0 +1,6 @@
+{
+  "path": "./node_modules/cz-emoji",
+  "config": {
+    "cz-emoji": {}
+  }
+}

package/.github/workflows/node.js.yml

@@ -0,0 +1,28 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: json-reporter CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+    steps:
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: "lts/*"
+      - name: Checkout ${{ env.GITHUB_REPOSITORY }}
+        uses: actions/checkout@v2
+      - name: Install dependencies
+        run: npm ci
+      - name: Semantic Release
+        run: npx semantic-release

package/.releaserc.mjs

@@ -0,0 +1,94 @@
+import { execSync } from 'node:child_process'
+
+// Git utils
+
+function getLocalRepoUrl() {
+    const topLevelDir = execSync( 'git rev-parse --show-toplevel' )
+        .toString()
+        .trim()
+
+    return `file://${ topLevelDir }/.git`
+}
+
+function getCurrentBranch() {
+    return execSync( 'git rev-parse --abbrev-ref HEAD' )
+        .toString()
+        .trim()
+}
+
+// Plugins sub-configs
+
+function getGitmojiPlugin() {
+    return [
+        'semantic-release-gitmoji', {
+            'releaseRules': {
+                'major': [
+                    ':boom:'
+                ],
+                'minor': [
+                    ':sparkles:'
+                ],
+                'patch': [
+                    ':art:', ':zap:', ':fire:', ':bug:', ':ambulance:', ':pencil:', ':rocket:', ':lipstick:', ':white_check_mark:', ':lock:', ':apple:', ':penguin:', ':checkered_flag:', ':robot:',
+                    ':green_apple:', ':rotating_light:', ':green_heart:', ':arrow_down:', ':pushpin:', ':construction_worker:', ':chart_with_upwards_trend:', ':recycle:', ':whale:',
+                    ':heavy_plus_sign:', ':heavy_minus_sign:', ':wrench:', ':globe_with_meridians:', ':pencil2:', ':poop:', ':rewind:', ':package:', ':alien:', ':truck:', ':page_facing_up:',
+                    ':bento:', ':ok_hand:', ':wheelchair:', ':bulb:', ':beers:', ':speech_balloon:', ':card_file_box:', ':loud_sound:', ':mute:', ':busts_in_silhouette:', ':children_crossing:',
+                    ':building_construction:', ':iphone:', ':clown_face:', ':see_no_evil:', ':camera_flash:', ':alembic:', ':mag:', ':wheel_of_dharma:', ':label:', ':seedling:', ':dizzy:',
+                    ':wastebasket:', ':passport_control:', ':adhesive_bandage:', ':monocle_face:', ':coffin:', ':test_tube:', ':necktie:', ':stethoscope:', ':bricks:', ':technologist:'
+                ]
+            }
+        }
+    ]
+}
+
+function getChangelogPlugin() {
+    return '@semantic-release/changelog'
+}
+
+function getNpmPlugin() {
+    return '@semantic-release/npm'
+}
+
+function getGithubPlugin() {
+    return '@semantic-release/github'
+}
+
+function getGitPlugin() {
+    return [
+        '@semantic-release/git', {
+            'assets':  [
+                'builds/**', 'docs/**', 'package.json', 'CHANGELOG.md'
+            ],
+            'message': 'chore(release): v${nextRelease.version}'
+        }
+    ]
+}
+
+// Configuration selection
+
+function isDryRun() {
+    return process.argv.includes( '--dry-run' )
+}
+
+function getDryRunConfig() {
+    return {
+        repositoryUrl: getLocalRepoUrl(),
+        branches:      getCurrentBranch(),
+        plugins:       [
+            getGitmojiPlugin()
+        ],
+    }
+}
+
+function getCIConfig() {
+    return {
+        branch:  'master',
+        plugins: [
+            getGitmojiPlugin(), getChangelogPlugin(), getNpmPlugin(), getGithubPlugin(), getGitPlugin()
+        ]
+    }
+}
+
+// Module
+
+export default isDryRun() ? getDryRunConfig() : getCIConfig()

package/CHANGELOG.md

@@ -0,0 +1,4 @@
+# v1.0.0 (2025-12-09)
+
+## ✨ New Features
+- [`5d46e77`](https://github.com/Itee/benchmarks-framework/commit/5d46e77)  (global) add basic dev template and sources

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tristan VALCKE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/benchmarks-framework.js

@@ -0,0 +1,186 @@
+import {
+    getConfig,
+    sessionFailed,
+    sessionFinished,
+    sessionStarted,
+} from '@web/test-runner-core/browser/session.js'
+
+///////
+
+class TestResultError {
+
+    /**
+     * @param {string} message
+     * @param {string|null} name
+     * @param {string|null} stack
+     * @param {string|null} expected
+     * @param {string|null} actual
+     */
+    constructor(
+        message,
+        name     = null,
+        stack    = null,
+        expected = null,
+        actual   = null,
+    ) {
+        this.message  = message
+        this.name     = name
+        this.stack    = stack
+        this.expected = expected
+        this.actual   = actual
+    }
+
+}
+
+class TestSuiteResult {
+
+    /**
+     *
+     * @param {string} name
+     * @param {Array.<TestSuiteResult>} suites
+     * @param {Array.<TestResult>} tests
+     */
+    constructor( name, suites = [], tests = [] ) {
+        this.name   = name
+        this.suites = suites
+        this.tests  = tests
+    }
+
+}
+
+class TestResult {
+
+    /**
+     * @param {string} name
+     * @param {boolean} passed
+     * @param {boolean} skipped
+     * @param {number|null} duration
+     * @param {TestResultError|null} error
+     */
+    constructor( name, passed, skipped = false, duration = null, error = null, stats = null ) {
+        this.name     = name
+        this.passed   = passed
+        this.skipped  = skipped
+        this.duration = duration
+        this.error    = error
+        this.stats    = stats
+    }
+
+}
+
+class TestSession {
+
+    // BasicTestSession //
+    // id: string;
+    // group: TestSessionGroup;
+    // browser: BrowserLauncher;
+    // testFile: string;
+
+    // TestSession //
+    // debug: false;
+    // testRun: number;
+    // status: TestSessionStatus;
+    // passed?: boolean;
+    // errors: TestResultError[];
+    // testResults?: TestSuiteResult;
+    // logs: any[][];
+    // request404s: string[];
+    // testCoverage?: CoverageMapData;
+
+    /**
+     * @param {boolean|null} passed
+     * @param {Array.<TestResultError>} errors
+     * @param {TestSuiteResult|null} testResults
+     */
+    constructor( passed, errors = [], testResults = null ) {
+        this.passed      = passed
+        this.errors      = errors
+        this.testResults = testResults
+    }
+
+}
+
+///////
+
+async function runTests( testData ) {
+
+    let suiteResults = []
+    for ( const exportKey in testData ) {
+        const suite       = testData[ exportKey ]
+        const suiteResult = await new Promise( ( resolve ) => {
+
+            // suite.on( 'start', event => console.log )
+            // suite.on( 'cycle', event => console.log )
+
+            suite.on( 'complete', ( event ) => {
+                // console.log(event.currentTarget)
+                const testResults = event.currentTarget.map( target => new TestResult( target.name, true, false, target.hz, undefined, target.times ) )
+                const suiteResult = new TestSuiteResult( suite.name, undefined, testResults )
+
+                resolve( suiteResult )
+            } )
+
+            suite.run()
+
+        } )
+
+        suiteResults.push( suiteResult )
+    }
+
+    return {
+        name:   'Benchmark',
+        suites: suiteResults, // TestSuiteResult
+        tests:  [], // TestResult
+        passed: true
+    }
+
+}
+
+( async () => {
+    // notify the test runner that we're alive
+    await sessionStarted()
+
+    // fetch the config for this test run, this will tell you which file we're testing
+    const {
+              testFile,
+              watch,
+              debug,
+              testFrameworkConfig
+          } = await getConfig()
+
+    // load the test file as an es module
+    const failedImports = []
+    let testData        = null
+    try {
+        const testFileURL = new URL( testFile, document.baseURI )
+        testData          = await import(testFileURL.href)
+    } catch ( error ) {
+        failedImports.push( {
+            file:  testFile,
+            error: {
+                message: error.message,
+                stack:   error.stack
+            }
+        } )
+    }
+
+    try {
+        // run the actual tests, this is what you need to implement
+        const testResults   = await runTests( testData )
+        // console.log( 'After runTests, testResults:', testResults )
+        const passed        = failedImports.length === 0 && testResults.passed
+        const sessionResult = new TestSession( passed, failedImports, testResults )
+
+        // notify tests run finished
+        await sessionFinished( sessionResult )
+    } catch ( error ) {
+        // notify an error occurred
+        const sessionError = new TestResultError(
+            error.message,
+            error.name,
+            error.stack
+        )
+        await sessionFailed( sessionError )
+    }
+
+} )()

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@itee/benchmarks-framework",
+  "version": "1.0.0",
+  "description": "A dedicated web test runner framework for the Benchmarks.js library to allow to run benchmarks in front side",
+  "keywords": [
+    "itee",
+    "test-runner",
+    "framework"
+  ],
+  "author": {
+    "name": "Itee (Tristan Valcke)",
+    "url": "https://github.com/Itee"
+  },
+  "contributors": [],
+  "license": "MIT",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Itee/benchmarks-framework.git"
+  },
+  "type": "module",
+  "main": "benchmarks-framework.js",
+  "homepage": "",
+  "man": "",
+  "bugs": {
+    "url": "https://github.com/Itee/benchmarks-framework/issues"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "os": [
+    "win32",
+    "linux"
+  ],
+  "cpu": [
+    "x64",
+    "ia32"
+  ],
+  "scripts": {
+    "semantic-release": "semantic-release --dry-run --no-ci",
+    "semantic-release-force": "semantic-release --no-ci"
+  },
+  "dependencies": {
+    "@web/test-runner-core": "^0.13.4"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^11.0.6",
+    "@semantic-release/npm": "^12.0.2",
+    "cz-emoji": "^1.3.2-canary.2",
+    "semantic-release": "^24.2.9",
+    "semantic-release-gitmoji": "^1.6.8"
+  }
+}