Skip to content

Latest commit

 

History

History

acot-runner-sitemap

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
.gitignore
.gitignore
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

@acot/acot-runner-sitemap

An acot custom runner reading audit pages from sitemap.

Installation

Install via npm:

$ npm install --save-dev @acot/acot-runner-sitemap

Usage

Add @acot/sitemap to the runner field of the configuration file.

{
  "runner": {
    "uses": "@acot/sitemap",
    "with": {
      "source": "https://acot.example/sitemap.xml",
      "random": [
        {
          "pattern": "/articles/**/*",
          "limit": 3
        }
      ]
    }
  }
}

Options

source

Type: string
Required: true

The URL of sitemap.xml

{
  "runner": {
    "uses": "@acot/sitemap",
    "with": {
      "source": "https://acot.example/sitemap.xml"
    }
  }
}

include

Type: string[]
Required: false

Page path pattern to include in audit target. See the micromatch documentation for pattern strings.

{
  "runner": {
    "uses": "@acot/sitemap",
    "with": {
      "source": "https://acot.example/sitemap.xml",
      "include": ["*", "/guidelines/core-*", "/docs/**/*"]
    }
  }
}

exclude

Type: string[]
Required: false

Page path pattern to exclude in audit target. See the micromatch documentation for pattern strings.

{
  "runner": {
    "uses": "@acot/sitemap",
    "with": {
      "source": "https://acot.example/sitemap.xml",
      "exclude": ["/articles/**/*"]
    }
  }
}

limit

Type: number
Required: false

Maximum number of pages to include in the audit target. If no value is specified, all pages will be audit targets.

{
  "runner": {
    "uses": "@acot/sitemap",
    "with": {
      "source": "https://acot.example/sitemap.xml",
      "limit": 30
    }
  }
}

random

Type: { pattern: string; limit: number }[]
Required: false

Randomly include the number of limits in the audit target from the page list that matches pattern. This option is typically used when there are a large number of pages using the same template.

{
  "runner": {
    "uses": "@acot/sitemap",
    "with": {
      "source": "https://acot.example/sitemap.xml",
      "random": [
        {
          "pattern": "/articles/**/*",
          "limit": 3
        },
        {
          "pattern": "/news/*",
          "limit": 2
        }
      ]
    }
  }
}

headers

Type: Record<string, string>
Required: false

The key-value of the header used when fetching the sitemap.xml specified in source.

{
  "runner": {
    "uses": "@acot/sitemap",
    "with": {
      "source": "https://acot.example/sitemap.xml",
      "headers": {
        "X-KEY": "value"
      }
    }
  }
}

timeout

Type: number
Default: 30000
Required: false

Maximum time in milliseconds to wait for collecting sitemaps.

{
  "runner": "@acot/sitemap",
  "with": {
    "source": "https://acot.example/sitemap.xml",
    "timeout": 120000
  }
}

retry

Type: number
Default: 3
Required: false

The maximum retry count.

{
  "runner": "@acot/sitemap",
  "with": {
    "source": "https://acot.example/sitemap.xml",
    "retry": 2
  }
}