Export version number (#115)

* Export version number

* Export version number

* Export version separately

* Extract documentation

.changeset/thick-guests-wonder.md

@@ -0,0 +1,5 @@
+---
+"@siteimprove/alfa-test-utils": patch
+---
+
+**Added:** The current version number is now exported.

docs/review/api/alfa-test-utils.api.md

@@ -89,6 +89,9 @@ export namespace Audit {
     export function run(page: Page, options?: Options): Promise<Audit>;
 }
 
+// @public (undocumented)
+export const codeCheckerVersion = "0.76.0";
+
 // @public
 export interface CommitInformation {
     Author?: string;
@@ -300,4 +303,6 @@ export namespace SIP {
     }): Promise<Result<string, string>>;
 }
 
+// (No @packageDocumentation comment for this package)
+
 ```

packages/alfa-test-utils/get-version.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+# This script relies on npm package.json variables and thus must be called
+# through npm, yarn or the like to correctly set them.
+
+set -eux
+
+echo "// Generated by yarn alfa-postversion
+const version = \"$(node -e "console.log(process.env.npm_package_version)")\";
+export default version;
+"

packages/alfa-test-utils/package.json

@@ -24,7 +24,9 @@
     "./git": "./dist/report/git.js",
     "./git.js": "./dist/report/git.js",
     "./report": "./dist/report/index.js",
-    "./report.js": "./dist/report/index.js"
+    "./report.js": "./dist/report/index.js",
+    "./version": "./dist/version.js",
+    "./version.js": "./dist/version.js"
   },
   "files": [
     "dist/**/*.js",
@@ -35,6 +37,17 @@
     "access": "public",
     "registry": "https://npm.pkg.github.com/"
   },
+  "//": [
+    "For scripts:",
+    "We need to update the version number after creating a new one.",
+    "We also need to update the documentation, which includes the version number; updating the documentation from a CI tool requires CI=false to allow changes.",
+    "Finally we need to stage the changed files that will be commited later in the release process."
+  ],
+  "scripts": {
+    "alfa-postversion": "./get-version.sh > src/version.ts && yarn self-extract && git add src/version.ts ../../docs/review/api/alfa-test-utils.api.md",
+    "self-extract": "CI=false yarn run --top-level extract packages/alfa-test-utils",
+    "packages/alfa-test-utils": "echo workaround https://github.com/webpro-nl/knip/issues/739"
+  },
   "dependencies": {
     "@siteimprove/alfa-act": "^0.96.0",
     "@siteimprove/alfa-aria": "^0.96.0",

packages/alfa-test-utils/src/index.ts

@@ -4,6 +4,12 @@
  *
  * @packageDocumentation
  */
+import version from "./version.js";
+/**
+ * @public
+ */
+export const codeCheckerVersion = version;
+
 export * from "./common.js";
 export * from "./audit/index.js";
 export * from "./report/index.js";

packages/alfa-test-utils/src/tsconfig.json

@@ -5,6 +5,7 @@
   "files": [
     "./common.ts",
     "./index.ts",
+    "./version.ts",
     "audit/audit.ts",
     "audit/index.ts",
     "audit/outcomes.ts",

packages/alfa-test-utils/src/version.ts

@@ -0,0 +1,4 @@
+// Generated by yarn alfa-postversion
+const version = "0.76.0";
+export default version;
+