wdio-monocart-service 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 cenfun
+
+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/README.md

@@ -0,0 +1,27 @@
+# wdio-monocart-service
+[![](https://img.shields.io/npm/v/wdio-monocart-service)](https://www.npmjs.com/package/wdio-monocart-service)
+[![](https://badgen.net/npm/dw/wdio-monocart-service)](https://www.npmjs.com/package/wdio-monocart-service)
+![](https://img.shields.io/github/license/cenfun/wdio-monocart-service)
+
+
+> A [WebdriverIO](https://github.com/webdriverio/webdriverio) service for [monocart coverage reports](https://github.com/cenfun/monocart-coverage-reports)
+
+## Install
+```sh
+npm i wdio-monocart-service
+```
+
+## Usage
+```js
+// wdio.conf.js
+{
+    services: [
+        ['monocart', {
+            name: 'My WebdriverIO Coverage Report',
+            outputDir: 'coverage-reports'
+        }]
+    ]
+}
+```
+
+Check repo [monocart coverage reports](https://github.com/cenfun/monocart-coverage-reports) for more options.

package/lib/index.d.ts

@@ -0,0 +1,29 @@
+import type {
+    CoverageReportOptions,
+    ReportDescription,
+    V8CoverageEntry,
+    Watermarks,
+    CoverageResults,
+    CoverageSummary,
+    MetricsSummary,
+    CoverageFile,
+    CoverageRange,
+    IgnoredRange,
+    AddedResults,
+    CoverageReport
+} from "monocart-coverage-reports";
+
+export type {
+    CoverageReportOptions,
+    ReportDescription,
+    V8CoverageEntry,
+    Watermarks,
+    CoverageResults,
+    CoverageSummary,
+    MetricsSummary,
+    CoverageFile,
+    CoverageRange,
+    IgnoredRange,
+    AddedResults,
+    CoverageReport
+}

package/lib/index.js

@@ -0,0 +1,78 @@
+import { CoverageReport } from 'monocart-coverage-reports';
+
+export default class CoverageReportService {
+
+    /**
+     * `serviceOptions` contains all options specific to the service
+     * e.g. if defined as follows:
+     *
+     * ```
+     * services: [['monocart', { outputDir: 'coverage-reports' }]]
+     * ```
+     *
+     * the `serviceOptions` parameter will be: `{ outputDir: 'coverage-reports' }`
+     */
+    constructor(serviceOptions, capabilities, config) {
+        this.coverageReport = new CoverageReport({
+            ... serviceOptions
+        });
+        this.coverageReport.cleanCache();
+    }
+
+    /**
+     * this browser object is passed in here for the first time
+     */
+    before(config, capabilities, browser) {
+        this.browser = browser;
+        // something before all tests are run, e.g.
+    }
+
+    async after(exitCode, config, capabilities) {
+        // something after all tests are run
+        if (this.coverageReport.hasCache()) {
+            await this.coverageReport.generate();
+        }
+    }
+
+    async beforeTest(test, context) {
+        // something before each Mocha/Jasmine test run
+        const puppeteer = await this.browser.getPuppeteer();
+        if (puppeteer) {
+            const page = (await puppeteer.pages())[0];
+            if (page) {
+                await Promise.all([
+                    page.coverage.startJSCoverage({
+                        resetOnNavigation: false,
+                        includeRawScriptCoverage: true
+                    }),
+                    page.coverage.startCSSCoverage({
+                        resetOnNavigation: false
+                    })
+                ]);
+            }
+        }
+
+    }
+
+    async afterTest(test, context) {
+        const puppeteer = await this.browser.getPuppeteer();
+        if (puppeteer) {
+            const page = (await puppeteer.pages())[0];
+            if (page) {
+                const [jsCoverage, cssCoverage] = await Promise.all([
+                    page.coverage.stopJSCoverage(),
+                    page.coverage.stopCSSCoverage()
+                ]);
+                // to raw V8 script coverage
+                const coverageList = [... jsCoverage.map((it) => {
+                    return {
+                        source: it.text,
+                        ... it.rawScriptCoverage
+                    };
+                }), ... cssCoverage];
+                await this.coverageReport.add(coverageList);
+            }
+        }
+    }
+
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+    "name": "wdio-monocart-service",
+    "version": "1.0.0",
+    "description": "WebdriverIO Monocart Coverage Reports",
+    "type": "module",
+    "main": "./lib/index.js",
+    "exports": {
+        ".": {
+            "types": "./lib/index.d.ts",
+            "default": "./lib/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "types": "./lib/index.d.ts",
+    "scripts": {
+        "test": "npx wdio run ./wdio.conf.js",
+        "link": "sf link ./ -f",
+        "patch": "npm run test && sf publish patch -r"
+    },
+    "files": [
+        "lib"
+    ],
+    "license": "MIT",
+    "dependencies": {
+        "monocart-coverage-reports": "^2.5.7"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.23.9",
+        "@babel/preset-env": "^7.23.9",
+        "@babel/register": "^7.23.7",
+        "@vitejs/plugin-react": "^4.2.1",
+        "@wdio/browser-runner": "^8.32.3",
+        "@wdio/cli": "^8.32.3",
+        "@wdio/mocha-framework": "^8.32.3",
+        "@wdio/spec-reporter": "^8.32.2",
+        "eslint": "^8.57.0",
+        "eslint-config-plus": "^1.0.6",
+        "eslint-plugin-html": "^8.0.0",
+        "eslint-plugin-react": "^7.33.2",
+        "eslint-plugin-wdio": "^8.24.12",
+        "react": "^18.2.0",
+        "react-dom": "^18.2.0"
+    }
+}