doc-detective 4.0.1 → 4.0.2-dev.2

package/package.json

@@ -1,135 +1,144 @@
-{
-  "name": "doc-detective",
-  "version": "4.0.1",
-  "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
-  "workspaces": [
-    "src/common"
-  ],
-  "bin": {
-    "doc-detective": "bin/doc-detective.js"
-  },
-  "type": "module",
-  "main": "dist/index.cjs",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    },
-    "./cli": "./bin/doc-detective.js"
-  },
-  "scripts": {
-    "postinstall": "node --disable-warning=DEP0190 scripts/postinstall.js",
-    "build:common": "cd src/common && npm run build",
-    "compile": "tsc && node scripts/createCjsWrapper.js",
-    "copy:schemas": "node -e \"const fs=require('fs');const p=require('path');const s=p.join('src','common','src','schemas','schemas.json');const d=p.join('dist','common','src','schemas','schemas.json');fs.mkdirSync(p.dirname(d),{recursive:true});fs.copyFileSync(s,d);\"",
-    "build": "npm run build:common && npm run compile && npm run copy:schemas",
-    "mocha": "mocha",
-    "test": "mocha --exit test/*.test.js && npm run test:common",
-    "test:common": "cd src/common && npm test",
-    "prerunTests": "node ./dist/checkDependencies.js",
-    "runTests": "node ./bin/doc-detective.js runTests",
-    "start": "node ./bin/doc-detective.js",
-    "dev": "node ./dev",
-    "container:build": "node src/container/scripts/build.cjs",
-    "container:rebuild": "node src/container/scripts/build.cjs --no-cache",
-    "container:test": "mocha src/container/test/*.test.cjs --timeout 0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/hawkeyexl/doc-detective.git"
-  },
-  "keywords": [
-    "documentation",
-    "unit",
-    "test",
-    "doc",
-    "docs"
-  ],
-  "author": "Manny Silva",
-  "license": "AGPL-3.0-only",
-  "bugs": {
-    "url": "https://github.com/doc-detective/doc-detective/issues"
-  },
-  "homepage": "https://github.com/doc-detective/doc-detective#readme",
-  "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^15.3.1",
-    "@ffmpeg-installer/ffmpeg": "^1.1.0",
-    "@puppeteer/browsers": "^2.13.0",
-    "ajv": "^8.18.0",
-    "ajv-errors": "^3.0.0",
-    "ajv-formats": "^3.0.1",
-    "ajv-keywords": "^5.1.0",
-    "appium": "^3.2.2",
-    "appium-chromium-driver": "^2.1.6",
-    "appium-geckodriver": "^2.2.0",
-    "appium-safari-driver": "^4.1.9",
-    "axios": "^1.13.6",
-    "dotenv": "^17.3.1",
-    "geckodriver": "^6.1.0",
-    "jq-web": "^0.6.2",
-    "json-schema-faker": "^0.6.0",
-    "pixelmatch": "^7.1.0",
-    "pngjs": "^7.0.0",
-    "posthog-node": "^5.28.4",
-    "sharp": "^0.34.5",
-    "tree-kill": "^1.2.2",
-    "webdriverio": "^9.26.1",
-    "yaml": "^2.8.2",
-    "yargs": "^17.7.2"
-  },
-  "optionalDependencies": {
-    "@ffmpeg-installer/darwin-arm64": "4.1.5",
-    "@ffmpeg-installer/darwin-x64": "4.1.0",
-    "@ffmpeg-installer/linux-arm": "4.1.3",
-    "@ffmpeg-installer/linux-arm64": "4.1.4",
-    "@ffmpeg-installer/linux-ia32": "4.1.0",
-    "@ffmpeg-installer/linux-x64": "4.1.0",
-    "@ffmpeg-installer/win32-ia32": "4.1.0",
-    "@ffmpeg-installer/win32-x64": "4.1.0",
-    "@img/sharp-darwin-arm64": "^0.34.5",
-    "@img/sharp-darwin-x64": "^0.34.5",
-    "@img/sharp-libvips-darwin-arm64": "^1.2.4",
-    "@img/sharp-libvips-darwin-x64": "^1.2.4",
-    "@img/sharp-libvips-linux-arm": "^1.2.4",
-    "@img/sharp-libvips-linux-arm64": "^1.2.4",
-    "@img/sharp-libvips-linux-ppc64": "^1.2.4",
-    "@img/sharp-libvips-linux-riscv64": "^1.2.4",
-    "@img/sharp-libvips-linux-s390x": "^1.2.4",
-    "@img/sharp-libvips-linux-x64": "^1.2.4",
-    "@img/sharp-libvips-linuxmusl-arm64": "^1.2.4",
-    "@img/sharp-libvips-linuxmusl-x64": "^1.2.4",
-    "@img/sharp-linux-arm": "^0.34.5",
-    "@img/sharp-linux-arm64": "^0.34.5",
-    "@img/sharp-linux-ppc64": "^0.34.5",
-    "@img/sharp-linux-riscv64": "^0.34.5",
-    "@img/sharp-linux-s390x": "^0.34.5",
-    "@img/sharp-linux-x64": "^0.34.5",
-    "@img/sharp-linuxmusl-arm64": "^0.34.5",
-    "@img/sharp-linuxmusl-x64": "^0.34.5",
-    "@img/sharp-wasm32": "^0.34.5",
-    "@img/sharp-win32-arm64": "^0.34.5",
-    "@img/sharp-win32-ia32": "^0.34.5",
-    "@img/sharp-win32-x64": "^0.34.5"
-  },
-  "devDependencies": {
-    "@types/node": "^25.5.0",
-    "@types/yargs": "^17.0.35",
-    "body-parser": "^2.2.2",
-    "chai": "^6.2.2",
-    "depcheck": "^1.4.7",
-    "esbuild": "^0.27.4",
-    "express": "^5.2.1",
-    "json-schema-to-typescript": "^15.0.4",
-    "mocha": "^11.7.5",
-    "sinon": "^21.0.3",
-    "semver": "^7.7.4",
-    "typescript": "^5.9.3"
-  }
-}
+{
+  "name": "doc-detective",
+  "version": "4.0.2-dev.2",
+  "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
+  "bin": {
+    "doc-detective": "bin/doc-detective.js"
+  },
+  "type": "module",
+  "files": [
+    "dist/",
+    "bin/",
+    "scripts/postinstall.js"
+  ],
+  "main": "dist/index.cjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./cli": "./bin/doc-detective.js"
+  },
+  "scripts": {
+    "prepack": "node --disable-warning=DEP0190 scripts/prepack.js",
+    "postpack": "node --disable-warning=DEP0190 scripts/postpack.js",
+    "postinstall": "node --disable-warning=DEP0190 scripts/postinstall.js",
+    "build:common": "cd src/common && npm run build",
+    "compile": "tsc && node scripts/createCjsWrapper.js",
+    "watch": "nodemon --watch src --ext ts --exec \"npm run compile\"",
+    "copy:schemas": "node -e \"const fs=require('fs');const p=require('path');const s=p.join('src','common','src','schemas','schemas.json');const d=p.join('dist','common','src','schemas','schemas.json');fs.mkdirSync(p.dirname(d),{recursive:true});fs.copyFileSync(s,d);\"",
+    "build": "npm run build:common && npm run compile && npm run copy:schemas",
+    "mocha": "mocha",
+    "test": "mocha --exit test/*.test.js && npm run test:common",
+    "test:common": "cd src/common && npm test",
+    "prerunTests": "node ./dist/checkDependencies.js",
+    "runTests": "node ./bin/doc-detective.js runTests",
+    "start": "node ./bin/doc-detective.js",
+    "dev": "node ./dev",
+    "container:build": "node src/container/scripts/build.cjs",
+    "container:rebuild": "node src/container/scripts/build.cjs --no-cache",
+    "container:test": "mocha src/container/test/*.test.cjs --timeout 0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hawkeyexl/doc-detective.git"
+  },
+  "keywords": [
+    "documentation",
+    "unit",
+    "test",
+    "doc",
+    "docs"
+  ],
+  "author": "Manny Silva",
+  "license": "AGPL-3.0-only",
+  "bugs": {
+    "url": "https://github.com/doc-detective/doc-detective/issues"
+  },
+  "homepage": "https://github.com/doc-detective/doc-detective#readme",
+  "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^15.3.1",
+    "@ffmpeg-installer/ffmpeg": "^1.1.0",
+    "@puppeteer/browsers": "^2.13.0",
+    "adm-zip": "^0.5.16",
+    "ajv": "^8.18.0",
+    "ajv-errors": "^3.0.0",
+    "ajv-formats": "^3.0.1",
+    "ajv-keywords": "^5.1.0",
+    "appium": "^3.2.2",
+    "appium-chromium-driver": "^2.1.6",
+    "appium-geckodriver": "^2.2.0",
+    "appium-safari-driver": "^4.1.9",
+    "axios": "^1.13.6",
+    "dotenv": "^17.3.1",
+    "fast-xml-parser": "^5.3.3",
+    "geckodriver": "^6.1.0",
+    "jq-web": "^0.6.2",
+    "json-schema-faker": "^0.6.0",
+    "pixelmatch": "^7.1.0",
+    "pngjs": "^7.0.0",
+    "posthog-node": "^5.28.4",
+    "sharp": "^0.34.5",
+    "tree-kill": "^1.2.2",
+    "webdriverio": "^9.26.1",
+    "yaml": "^2.8.2",
+    "yargs": "^17.7.2"
+  },
+  "optionalDependencies": {
+    "@ffmpeg-installer/darwin-arm64": "4.1.5",
+    "@ffmpeg-installer/darwin-x64": "4.1.0",
+    "@ffmpeg-installer/linux-arm": "4.1.3",
+    "@ffmpeg-installer/linux-arm64": "4.1.4",
+    "@ffmpeg-installer/linux-ia32": "4.1.0",
+    "@ffmpeg-installer/linux-x64": "4.1.0",
+    "@ffmpeg-installer/win32-ia32": "4.1.0",
+    "@ffmpeg-installer/win32-x64": "4.1.0",
+    "@img/sharp-darwin-arm64": "^0.34.5",
+    "@img/sharp-darwin-x64": "^0.34.5",
+    "@img/sharp-libvips-darwin-arm64": "^1.2.4",
+    "@img/sharp-libvips-darwin-x64": "^1.2.4",
+    "@img/sharp-libvips-linux-arm": "^1.2.4",
+    "@img/sharp-libvips-linux-arm64": "^1.2.4",
+    "@img/sharp-libvips-linux-ppc64": "^1.2.4",
+    "@img/sharp-libvips-linux-riscv64": "^1.2.4",
+    "@img/sharp-libvips-linux-s390x": "^1.2.4",
+    "@img/sharp-libvips-linux-x64": "^1.2.4",
+    "@img/sharp-libvips-linuxmusl-arm64": "^1.2.4",
+    "@img/sharp-libvips-linuxmusl-x64": "^1.2.4",
+    "@img/sharp-linux-arm": "^0.34.5",
+    "@img/sharp-linux-arm64": "^0.34.5",
+    "@img/sharp-linux-ppc64": "^0.34.5",
+    "@img/sharp-linux-riscv64": "^0.34.5",
+    "@img/sharp-linux-s390x": "^0.34.5",
+    "@img/sharp-linux-x64": "^0.34.5",
+    "@img/sharp-linuxmusl-arm64": "^0.34.5",
+    "@img/sharp-linuxmusl-x64": "^0.34.5",
+    "@img/sharp-wasm32": "^0.34.5",
+    "@img/sharp-win32-arm64": "^0.34.5",
+    "@img/sharp-win32-ia32": "^0.34.5",
+    "@img/sharp-win32-x64": "^0.34.5"
+  },
+  "devDependencies": {
+    "@types/adm-zip": "^0.5.8",
+    "@types/node": "^25.5.0",
+    "@types/yargs": "^17.0.35",
+    "body-parser": "^2.2.2",
+    "chai": "^6.2.2",
+    "depcheck": "^1.4.7",
+    "esbuild": "^0.27.4",
+    "express": "^5.2.1",
+    "json-schema-to-typescript": "^15.0.4",
+    "mocha": "^11.7.5",
+    "nodemon": "^3.1.14",
+    "semver": "^7.7.4",
+    "sinon": "^21.0.3",
+    "typescript": "^5.9.3"
+  }
+}

package/.doc-detective.json

@@ -1 +0,0 @@
-{}

package/CONTRIBUTIONS.md

@@ -1,27 +0,0 @@
-# How to contribute
-
-`doc-detective` welcomes contributions of all sorts (as do all Doc Detective projects). If you can't contribute code, you can still help by reporting issues, suggesting new features, improving the documentation, or sponsoring the project. Please follow the guidelines below.
-
-## Reporting issues
-
-If you find a bug, report it on the [GitHub issue tracker](https://github.com/doc-detective/doc-detective/issues).
-
-## Contributing code
-
-To contribute code,
-
-1. Fork the project.
-2. Create a new branch.
-3. Make your changes.
-4. Submit a pull request to the `rc` (release candidate) branch.
-5. Wait for your pull request to be reviewed.
-6. Make any necessary changes to your pull request.
-7. Your pull request will be merged once it has been reviewed and approved.
-
-## License
-
-By contributing to `doc-detective`, you agree that your contributions will be licensed under the [AGPL license](https://github.com/doc-detective/doc-detective/blob/main/LICENCE).
-
-## Thank you
-
-Thank you for your contributions! We appreciate your help in making the project better.

package/scripts/createCjsWrapper.js

@@ -1,31 +0,0 @@
-import { build } from "esbuild";
-import { copyFile } from "fs/promises";
-import { fileURLToPath } from "url";
-import path from "path";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const distDir = path.join(__dirname, "..", "dist");
-
-await build({
-  entryPoints: [path.join(distDir, "index.js")],
-  outfile: path.join(distDir, "index.cjs"),
-  bundle: true,
-  format: "cjs",
-  platform: "node",
-  packages: "external",
-  define: {
-    "import.meta.url": "importMetaUrl",
-  },
-  banner: {
-    js: "const importMetaUrl = require('url').pathToFileURL(__filename).href;",
-  },
-});
-
-await copyFile(
-  path.join(distDir, "index.d.ts"),
-  path.join(distDir, "index.d.cts")
-);
-
-console.log("Created CJS bundle at dist/index.cjs");
-console.log("Copied type definitions to dist/index.d.cts");