npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@acot/acot-runner-sitemap

v0.0.19

Published

An acot custom runner reading audit pages from sitemap.

Downloads

35

Readme

@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
  }
}