doc-detective 3.4.1-dev.1 → 3.5.0-dev.0

package/.github/FUNDING.yml

@@ -1,14 +1,14 @@
-# These are supported funding model platforms
-
-github: [doc-detective] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: doc-detective # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-polar: # Replace with a single Polar username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+# These are supported funding model platforms
+
+github: [doc-detective] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: doc-detective # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.github/dependabot.yml

@@ -1,11 +1,11 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/.github/workflows/auto-dev-release.yml

@@ -1,174 +1,174 @@
-name: Auto Dev Release
-
-on:
-  push:
-    branches:
-      - main
-    # Don't trigger on release events to avoid conflicts with main release workflow
-  workflow_dispatch:
-    # Allow manual triggering for testing
-
-jobs:
-  auto-dev-release:
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-    # Skip if this is a release commit or docs-only changes
-    if: |
-      !contains(github.event.head_commit.message, '[skip ci]') &&
-      !contains(github.event.head_commit.message, 'Release') &&
-      github.event_name != 'release'
-    
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          # Need full history for proper version bumping
-          fetch-depth: 0
-          # Use a token that can push back to the repo
-          token: ${{ secrets.DD_DEP_UPDATE_TOKEN }}
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-          cache: 'npm'
-          cache-dependency-path: package-lock.json
-          registry-url: 'https://registry.npmjs.org/'
-
-      - name: Check for documentation-only changes
-        id: check_changes
-        run: |
-          # Always release on workflow_dispatch
-          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
-            echo "skip_release=false" >> $GITHUB_OUTPUT
-            echo "Manual trigger: proceeding with release"
-            exit 0
-          fi
-
-          # Get list of changed files
-          CHANGED_FILES=$(git diff --name-only ${{ github.event.before }}..${{ github.event.after }})
-          
-          echo "Changed files:"
-          echo "$CHANGED_FILES"
-          
-          # Check if only documentation files changed
-          if echo "$CHANGED_FILES" | grep -v -E '\.(md|txt|yml|yaml)$|^\.github/' | grep -q .; then
-            echo "skip_release=false" >> $GITHUB_OUTPUT
-            echo "Code changes detected, proceeding with release"
-          else
-            echo "skip_release=true" >> $GITHUB_OUTPUT
-            echo "Only documentation changes detected, skipping release"
-          fi
-
-      - name: Validate package.json
-        if: steps.check_changes.outputs.skip_release == 'false'
-        run: |
-          # Validate package.json exists and is valid JSON
-          if [ ! -f "package.json" ]; then
-            echo "❌ package.json not found"
-            exit 1
-          fi
-          
-          # Validate JSON syntax
-          if ! node -p "JSON.parse(require('fs').readFileSync('package.json', 'utf8'))" > /dev/null 2>&1; then
-            echo "❌ package.json is not valid JSON"
-            exit 1
-          fi
-          
-          # Check for required fields
-          if ! node -p "require('./package.json').name" > /dev/null 2>&1; then
-            echo "❌ package.json missing 'name' field"
-            exit 1
-          fi
-          
-          if ! node -p "require('./package.json').version" > /dev/null 2>&1; then
-            echo "❌ package.json missing 'version' field"
-            exit 1
-          fi
-          
-          echo "✅ package.json validation passed"
-
-      - name: Install dependencies
-        if: steps.check_changes.outputs.skip_release == 'false'
-        run: npm ci
-
-      - name: Run tests
-        if: steps.check_changes.outputs.skip_release == 'false'
-        run: npm test
-
-      - name: Configure Git
-        run: |
-          git config --global user.name 'github-actions[bot]'
-          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
-
-      - name: Generate dev version
-        if: steps.check_changes.outputs.skip_release == 'false'
-        id: version
-        run: |
-          # Get current version from package.json
-          CURRENT_VERSION=$(node -p "require('./package.json').version")
-          echo "Current version: $CURRENT_VERSION"
-          
-          # Extract base version (remove existing -dev.X suffix if present)
-          BASE_VERSION=$(echo $CURRENT_VERSION | sed 's/-dev\.[0-9]*$//')
-          echo "Base version: $BASE_VERSION"
-          
-          # Check if we need to get the latest dev version from npm
-          LATEST_DEV=$(npm view doc-detective@dev version 2>/dev/null || echo "")
-          
-          if [ -n "$LATEST_DEV" ] && [[ $LATEST_DEV == $BASE_VERSION-dev.* ]]; then
-            # Extract the dev number and increment it
-            DEV_NUM=$(echo $LATEST_DEV | grep -o 'dev\.[0-9]*$' | grep -o '[0-9]*$')
-            NEW_DEV_NUM=$((DEV_NUM + 1))
-          else
-            # Start with dev.1
-            NEW_DEV_NUM=1
-          fi
-          
-          NEW_VERSION="$BASE_VERSION-dev.$NEW_DEV_NUM"
-          echo "New version: $NEW_VERSION"
-          
-          # Update package.json
-          npm version $NEW_VERSION --no-git-tag-version
-          
-          # Set outputs
-          echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT
-          echo "base_version=$BASE_VERSION" >> $GITHUB_OUTPUT
-
-      - name: Commit version change
-        if: steps.check_changes.outputs.skip_release == 'false'
-        run: |
-          git add package.json package-lock.json
-          git commit -m "Auto dev release: v${{ steps.version.outputs.version }} [skip ci]"
-
-      - name: Create and push git tag
-        if: steps.check_changes.outputs.skip_release == 'false'
-        run: |
-          git tag "v${{ steps.version.outputs.version }}"
-          git push origin "v${{ steps.version.outputs.version }}"
-          git push origin main
-
-      - name: Publish to npm
-        if: steps.check_changes.outputs.skip_release == 'false'
-        run: |
-          # Add error handling for npm publish
-          set -e
-          echo "📦 Publishing to npm with 'dev' tag..."
-          npm publish --tag dev
-          echo "✅ Successfully published to npm"
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      - name: Summary
-        if: steps.check_changes.outputs.skip_release == 'false'
-        run: |
-          echo "✅ Auto dev release completed successfully!"
-          echo "📦 Version: v${{ steps.version.outputs.version }}"
-          echo "🏷️ NPM Tag: dev"
-          echo "📋 Install with: npm install doc-detective@dev"
-          
-      - name: Skip summary  
-        if: steps.check_changes.outputs.skip_release == 'true'
-        run: |
-          echo "⏭️ Auto dev release skipped"
+name: Auto Dev Release
+
+on:
+  push:
+    branches:
+      - main
+    # Don't trigger on release events to avoid conflicts with main release workflow
+  workflow_dispatch:
+    # Allow manual triggering for testing
+
+jobs:
+  auto-dev-release:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    # Skip if this is a release commit or docs-only changes
+    if: |
+      !contains(github.event.head_commit.message, '[skip ci]') &&
+      !contains(github.event.head_commit.message, 'Release') &&
+      github.event_name != 'release'
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          # Need full history for proper version bumping
+          fetch-depth: 0
+          # Use a token that can push back to the repo
+          token: ${{ secrets.DD_DEP_UPDATE_TOKEN }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+          cache-dependency-path: package-lock.json
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: Check for documentation-only changes
+        id: check_changes
+        run: |
+          # Always release on workflow_dispatch
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            echo "skip_release=false" >> $GITHUB_OUTPUT
+            echo "Manual trigger: proceeding with release"
+            exit 0
+          fi
+
+          # Get list of changed files
+          CHANGED_FILES=$(git diff --name-only ${{ github.event.before }}..${{ github.event.after }})
+          
+          echo "Changed files:"
+          echo "$CHANGED_FILES"
+          
+          # Check if only documentation files changed
+          if echo "$CHANGED_FILES" | grep -v -E '\.(md|txt|yml|yaml)$|^\.github/' | grep -q .; then
+            echo "skip_release=false" >> $GITHUB_OUTPUT
+            echo "Code changes detected, proceeding with release"
+          else
+            echo "skip_release=true" >> $GITHUB_OUTPUT
+            echo "Only documentation changes detected, skipping release"
+          fi
+
+      - name: Validate package.json
+        if: steps.check_changes.outputs.skip_release == 'false'
+        run: |
+          # Validate package.json exists and is valid JSON
+          if [ ! -f "package.json" ]; then
+            echo "❌ package.json not found"
+            exit 1
+          fi
+          
+          # Validate JSON syntax
+          if ! node -p "JSON.parse(require('fs').readFileSync('package.json', 'utf8'))" > /dev/null 2>&1; then
+            echo "❌ package.json is not valid JSON"
+            exit 1
+          fi
+          
+          # Check for required fields
+          if ! node -p "require('./package.json').name" > /dev/null 2>&1; then
+            echo "❌ package.json missing 'name' field"
+            exit 1
+          fi
+          
+          if ! node -p "require('./package.json').version" > /dev/null 2>&1; then
+            echo "❌ package.json missing 'version' field"
+            exit 1
+          fi
+          
+          echo "✅ package.json validation passed"
+
+      - name: Install dependencies
+        if: steps.check_changes.outputs.skip_release == 'false'
+        run: npm ci
+
+      - name: Run tests
+        if: steps.check_changes.outputs.skip_release == 'false'
+        run: npm test
+
+      - name: Configure Git
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+
+      - name: Generate dev version
+        if: steps.check_changes.outputs.skip_release == 'false'
+        id: version
+        run: |
+          # Get current version from package.json
+          CURRENT_VERSION=$(node -p "require('./package.json').version")
+          echo "Current version: $CURRENT_VERSION"
+          
+          # Extract base version (remove existing -dev.X suffix if present)
+          BASE_VERSION=$(echo $CURRENT_VERSION | sed 's/-dev\.[0-9]*$//')
+          echo "Base version: $BASE_VERSION"
+          
+          # Check if we need to get the latest dev version from npm
+          LATEST_DEV=$(npm view doc-detective@dev version 2>/dev/null || echo "")
+          
+          if [ -n "$LATEST_DEV" ] && [[ $LATEST_DEV == $BASE_VERSION-dev.* ]]; then
+            # Extract the dev number and increment it
+            DEV_NUM=$(echo $LATEST_DEV | grep -o 'dev\.[0-9]*$' | grep -o '[0-9]*$')
+            NEW_DEV_NUM=$((DEV_NUM + 1))
+          else
+            # Start with dev.1
+            NEW_DEV_NUM=1
+          fi
+          
+          NEW_VERSION="$BASE_VERSION-dev.$NEW_DEV_NUM"
+          echo "New version: $NEW_VERSION"
+          
+          # Update package.json
+          npm version $NEW_VERSION --no-git-tag-version
+          
+          # Set outputs
+          echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT
+          echo "base_version=$BASE_VERSION" >> $GITHUB_OUTPUT
+
+      - name: Commit version change
+        if: steps.check_changes.outputs.skip_release == 'false'
+        run: |
+          git add package.json package-lock.json
+          git commit -m "Auto dev release: v${{ steps.version.outputs.version }} [skip ci]"
+
+      - name: Create and push git tag
+        if: steps.check_changes.outputs.skip_release == 'false'
+        run: |
+          git tag "v${{ steps.version.outputs.version }}"
+          git push origin "v${{ steps.version.outputs.version }}"
+          git push origin main
+
+      - name: Publish to npm
+        if: steps.check_changes.outputs.skip_release == 'false'
+        run: |
+          # Add error handling for npm publish
+          set -e
+          echo "📦 Publishing to npm with 'dev' tag..."
+          npm publish --tag dev
+          echo "✅ Successfully published to npm"
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Summary
+        if: steps.check_changes.outputs.skip_release == 'false'
+        run: |
+          echo "✅ Auto dev release completed successfully!"
+          echo "📦 Version: v${{ steps.version.outputs.version }}"
+          echo "🏷️ NPM Tag: dev"
+          echo "📋 Install with: npm install doc-detective@dev"
+          
+      - name: Skip summary  
+        if: steps.check_changes.outputs.skip_release == 'true'
+        run: |
+          echo "⏭️ Auto dev release skipped"
           echo "📝 Only documentation changes detected"

package/.github/workflows/npm-test.yaml

@@ -1,96 +1,96 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Test (& Publish)
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    types: 
-      - opened
-      - reopened
-      - synchronize
-  release:
-    types:
-      - published
-  workflow_dispatch:
-
-jobs:
-  test:
-    runs-on: ${{ matrix.os }}
-    timeout-minutes: 10
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-          - windows-latest
-          - macos-latest
-        node: 
-          - 18
-          - 20
-          - 22
-          - 24
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node }}
-          cache: 'npm'
-          cache-dependency-path: package-lock.json
-      
-      - run: npm ci      
-      - run: npm test
-
-  publish-npm:
-    if: github.event_name == 'release' && github.event.action == 'published'
-    needs: test
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          cache: 'npm'
-          cache-dependency-path: package-lock.json
-          registry-url: https://registry.npmjs.org/
-
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
-
-  test-github-action:
-    name: Test GitHub Action
-    needs: publish-npm
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: doc-detective/github-action@latest
-        id: dd
-        with:
-          config: ./test/artifacts/config.json
-          input: ./test/artifacts/doc-content.md
-          exit_on_fail: "true"
-
-  build-docker-image:
-    name: Build Docker Image
-    needs: publish-npm
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Get package version
-        id: get_version
-        run: |
-          echo "VERSION=$(jq -r '.version' package.json)" >> $GITHUB_OUTPUT
-
-      - name: Trigger GitHub Action in docker-image repo
-        run: |
-          curl -X POST -H "Authorization: token ${{ secrets.DD_DEP_UPDATE_TOKEN }}" \
-               -H "Accept: application/vnd.github.everest-preview+json" \
-               "https://api.github.com/repos/doc-detective/docker-image/dispatches" \
-               -d '{ "event_type": "build-push", "client_payload": { "version": "${{ steps.get_version.outputs.version }}", "additional_info": "triggered from npm-publish workflow" } }'
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Test (& Publish)
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: 
+      - opened
+      - reopened
+      - synchronize
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+        node: 
+          - 18
+          - 20
+          - 22
+          - 24
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          cache: 'npm'
+          cache-dependency-path: package-lock.json
+      
+      - run: npm ci      
+      - run: npm test
+
+  publish-npm:
+    if: github.event_name == 'release' && github.event.action == 'published'
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          cache: 'npm'
+          cache-dependency-path: package-lock.json
+          registry-url: https://registry.npmjs.org/
+
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+
+  test-github-action:
+    name: Test GitHub Action
+    needs: publish-npm
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: doc-detective/github-action@latest
+        id: dd
+        with:
+          config: ./test/artifacts/config.json
+          input: ./test/artifacts/doc-content.md
+          exit_on_fail: "true"
+
+  build-docker-image:
+    name: Build Docker Image
+    needs: publish-npm
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get package version
+        id: get_version
+        run: |
+          echo "VERSION=$(jq -r '.version' package.json)" >> $GITHUB_OUTPUT
+
+      - name: Trigger GitHub Action in docker-image repo
+        run: |
+          curl -X POST -H "Authorization: token ${{ secrets.DD_DEP_UPDATE_TOKEN }}" \
+               -H "Accept: application/vnd.github.everest-preview+json" \
+               "https://api.github.com/repos/doc-detective/docker-image/dispatches" \
+               -d '{ "event_type": "build-push", "client_payload": { "version": "${{ steps.get_version.outputs.version }}", "additional_info": "triggered from npm-publish workflow" } }'