@axe-core/reporter-earl 4.8.2-e8094c1.0 → 4.8.3-854eeb3.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.8.2](https://github.com/dequelabs/axe-core-npm/compare/v4.8.1...v4.8.2) (2023-11-30)
+
+
+### Bug Fixes
+
+* allow cjs version of packages to export a default value ([#943](https://github.com/dequelabs/axe-core-npm/issues/943)) ([b5aee34](https://github.com/dequelabs/axe-core-npm/commit/b5aee3424fe4d0fbc0b2065e9c0bc56ce4032755))
+* **webdriverjs:** fix default commonJs export ([#927](https://github.com/dequelabs/axe-core-npm/issues/927)) ([b07d38c](https://github.com/dequelabs/axe-core-npm/commit/b07d38cc2d85c6127391686482abf762758dce34))
+
+
+
+
+
 ## [4.8.1](https://github.com/dequelabs/axe-core-npm/compare/v4.7.3...v4.8.1) (2023-10-11)
 
 

package/dist/axeReporterEarl.js

@@ -136,3 +136,16 @@ function axeReporterEarl(rawResults, {}, callback) {
 0 && (module.exports = {
   createEarlReport
 });
+
+if (module.exports.default) {
+  var ___default_export = module.exports.default;
+  var ___export_entries = Object.entries(module.exports);
+  module.exports = ___default_export;
+  ___export_entries.forEach(([key, value]) => {
+    if (module.exports[key]) {
+      throw new Error(`Export "${key}" already exists on default export`);
+    }
+
+    module.exports[key] = value;
+  });
+}

package/jest.config.js

@@ -4,7 +4,7 @@ module.exports = {
   transform: {
     '\\.(ts|tsx)$': 'ts-jest'
   },
-  testRegex: '/tests/.*\\.(ts|tsx|js)$',
+  testPathDirs: 'tests',
   testPathIgnorePatterns: ['/node_modules/', '/dist/', '/tests/utils.ts'],
   silent: false,
   coverageThreshold: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axe-core/reporter-earl",
-  "version": "4.8.2-e8094c1.0+e8094c1",
+  "version": "4.8.3-854eeb3.0+854eeb3",
   "description": "A EARL+JSON-LD reporter for axe-core",
   "main": "dist/axeReporterEarl.js",
   "module": "./dist/axeReporterEarl.mjs",
@@ -15,7 +15,10 @@
   "scripts": {
     "start": "NODE_OPTIONS=--experimental-vm-modules jest --watch --env=jsdom",
     "test": "npm run build && npm run test:unit",
-    "test:esm": "node esmTest.mjs",
+    "test:export": "npm run test:esm && npm run test:commonjs && npm run test:ts",
+    "test:esm": "node tests/esmTest.mjs",
+    "test:commonjs": "node tests/commonjsTest.js",
+    "test:ts": "tsc tests/tsTest.ts --noEmit --skipLibCheck --esModuleInterop",
     "test:unit": "NODE_OPTIONS=--experimental-vm-modules jest --collectCoverage",
     "build": "tsup src/axeReporterEarl.ts --dts --format esm,cjs",
     "prepublishOnly": "npm run build"
@@ -54,5 +57,5 @@
     "tsup": "^7.2.0",
     "typescript": "^4.8.4"
   },
-  "gitHead": "e8094c18cde388c7c4b7218e1daa22151b8054f0"
+  "gitHead": "854eeb31d9b540ed30d602452c1d833600ecad20"
 }

package/tests/commonjsTest.js

@@ -0,0 +1,18 @@
+// ensure backwards compatibility of commonJs format
+const implicitDefaultExport = require('../dist/axeReporterEarl.js');
+const explicitDefaultExport = require('../dist/axeReporterEarl.js').default;
+const assert = require('assert');
+
+assert(
+  typeof implicitDefaultExport === 'function',
+  'implicit default export is not a function'
+);
+
+assert(
+  typeof explicitDefaultExport === 'function',
+  'explicit default export is not a function'
+);
+assert(
+  explicitDefaultExport === implicitDefaultExport,
+  'explicit default and named export are not the same'
+);

package/{esmTest.mjs → tests/esmTest.mjs}

@@ -1,4 +1,5 @@
-import defaultExport from './dist/axeReporterEarl.mjs';
+// ensure compatibility of ESM format
+import defaultExport from '../dist/axeReporterEarl.mjs';
 import assert from 'assert';
 
 const exportIsFunction = typeof defaultExport === 'function';

package/tests/tsTest.ts

@@ -0,0 +1,18 @@
+// This file isn't executed; we only care that typescript can successfully
+// build/typecheck. It is a smoke test that our build process is producing a
+// basically-reasonable index.d.ts.
+
+// Detailed tests of individual types should instead be covered by unit tests.
+
+import DefaultImportReporter from '../dist/axeReporterEarl.js';
+// import axe from 'axe-core';
+
+// See https://stackoverflow.com/a/55541672
+type IsAny<T> = 0 extends 1 & T ? true : false;
+
+// If the imports don't have typings assigned, these will fail
+// with "ts(2322): Type 'false' is not assignable to type 'true'."
+(x: IsAny<typeof DefaultImportReporter>): false => x;
+
+// TODO: this doesn't work as our types are broken
+// axe.configure({ reporter: DefaultImportReporter });

package/tsup.config.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from 'tsup';
+import { esbuildPluginCJSInterop } from '../../utils/esbuild-plugin-cjs-interop.js';
+
+export default defineConfig({
+  esbuildPlugins: [esbuildPluginCJSInterop]
+});