compat with cjs (#11)

Ma11hewThomas · web-flow · commit 904bfcc2879c · 2025-11-02T14:01:07.000Z
* compat with cjs
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -3,11 +3,12 @@ name: Release
 on:
   push:
     tags:
-      - 'v*.*.*' 
+      - 'v*.*.*'
+      - 'v*.*.*-*'
 permissions:
-  contents: write      
-  id-token: write      
-  packages: write       
+  contents: write
+  id-token: write
+  packages: write
 
 jobs:
   release:
@@ -34,10 +35,23 @@ jobs:
       - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
         run: npm audit signatures
 
+      - name: Determine npm tag and release type
+        id: release-info
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          if [[ "$VERSION" =~ -.*$ ]]; then
+            echo "npm_tag=next" >> $GITHUB_OUTPUT
+            echo "is_prerelease=true" >> $GITHUB_OUTPUT
+          else
+            echo "npm_tag=latest" >> $GITHUB_OUTPUT
+            echo "is_prerelease=false" >> $GITHUB_OUTPUT
+          fi
+
       - name: Publish to npm
-        run: npm publish --provenance --access public
+        run: npm publish --provenance --access public --tag ${{ steps.release-info.outputs.npm_tag }}
 
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2
         with:
-          generate_release_notes: true
+          generate_release_notes: true
+          prerelease: ${{ steps.release-info.outputs.is_prerelease == 'true' }}
diff --git a/docs/README.md b/docs/README.md
@@ -1,8 +1,8 @@
-**CTRF v0.0.16**
+**CTRF v0.0.17**
 
 ***
 
-# CTRF v0.0.16
+# CTRF v0.0.17
 
 ## Schema
 
diff --git a/docs/enumerations/SortOrder.md b/docs/enumerations/SortOrder.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/enrichReportWithInsights.md b/docs/functions/enrichReportWithInsights.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/findSuiteByName.md b/docs/functions/findSuiteByName.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/findTestById.md b/docs/functions/findTestById.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/findTestByName.md b/docs/functions/findTestByName.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/flattenTree.md b/docs/functions/flattenTree.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/generateTestIdFromProperties.md b/docs/functions/generateTestIdFromProperties.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/getAllTests.md b/docs/functions/getAllTests.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/getSuiteStats.md b/docs/functions/getSuiteStats.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/getTestId.md b/docs/functions/getTestId.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/isValidCtrfReport.md b/docs/functions/isValidCtrfReport.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/mergeReports.md b/docs/functions/mergeReports.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/organizeTestsBySuite.md b/docs/functions/organizeTestsBySuite.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/readReportFromFile.md b/docs/functions/readReportFromFile.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/readReportsFromDirectory.md b/docs/functions/readReportsFromDirectory.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/readReportsFromGlobPattern.md b/docs/functions/readReportsFromGlobPattern.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/setTestId.md b/docs/functions/setTestId.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/setTestIdsForReport.md b/docs/functions/setTestIdsForReport.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/sortReportsByTimestamp.md b/docs/functions/sortReportsByTimestamp.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/storePreviousResults.md b/docs/functions/storePreviousResults.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/traverseTree.md b/docs/functions/traverseTree.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/validateReport.md b/docs/functions/validateReport.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/functions/validateReportStrict.md b/docs/functions/validateReportStrict.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/Attachment.md b/docs/interfaces/Attachment.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/Baseline.md b/docs/interfaces/Baseline.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/Environment.md b/docs/interfaces/Environment.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/InsightsMetric.md b/docs/interfaces/InsightsMetric.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/Report.md b/docs/interfaces/Report.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/Results.md b/docs/interfaces/Results.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/RetryAttempt.md b/docs/interfaces/RetryAttempt.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/RootInsights.md b/docs/interfaces/RootInsights.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/Step.md b/docs/interfaces/Step.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/Summary.md b/docs/interfaces/Summary.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/Test.md b/docs/interfaces/Test.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/TestInsights.md b/docs/interfaces/TestInsights.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/TestTree.md b/docs/interfaces/TestTree.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/Tool.md b/docs/interfaces/Tool.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/TreeNode.md b/docs/interfaces/TreeNode.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/TreeOptions.md b/docs/interfaces/TreeOptions.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/interfaces/ValidationResult.md b/docs/interfaces/ValidationResult.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/type-aliases/TestStatus.md b/docs/type-aliases/TestStatus.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/type-aliases/TreeTest.md b/docs/type-aliases/TreeTest.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/docs/variables/CTRF_NAMESPACE.md b/docs/variables/CTRF_NAMESPACE.md
@@ -1,4 +1,4 @@
-[**CTRF v0.0.16**](../README.md)
+[**CTRF v0.0.17**](../README.md)
 
 ***
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/methods/read-reports.test.ts b/src/methods/read-reports.test.ts
diff --git a/src/methods/run-insights.test.ts b/src/methods/run-insights.test.ts
diff --git a/src/methods/utilities/sort-reports.ts b/src/methods/utilities/sort-reports.ts
diff --git a/src/methods/validate-schema.test.ts b/src/methods/validate-schema.test.ts
diff --git a/src/test-utils/report-enrichment-helper.ts b/src/test-utils/report-enrichment-helper.ts
