vidimus

Vidimus, "we have seen": checks a static website's build before it goes public, and tells you how to fix what it finds.

npm i -D vidimus puppeteer pa11y linkinator
npm run build && npx vidimus

✖ noindex in the production build
    on: /en/search/ /fr/search/ /it/search/ +1 more
    → Remove the robots noindex meta tag, or add the path to seo.allowNoindex if it is intentional.

⚠ no <h1>
    on: /en/ /fr/ /it/ +1 more
    → Add one <h1> heading describing the page, or turn seo.h1 off.

Audits

| | | | --- | --- | | i18n csp seo security budget assets | read the build, no extra dependencies | | a11y links r12s privacy html shots lighthouse | run the tools you install next to vidimus (puppeteer, pa11y, linkinator, html-validate, lighthouse, sharp) |

i18n, csp, a11y, links and r12s run by default; npx vidimus all runs everything, npx vidimus seo budget runs just those. The default set needs puppeteer, pa11y and linkinator, installed above; the others are needed only by the audits that use them.

What each audit checks and its options: ljs360d.github.io/vidimus/audits.

Configure

npx vidimus init       # writes vidimus.config.ts

import { defineConfig } from 'vidimus';

export default defineConfig({
  siteUrl: 'https://example.org',
  audits: ['i18n', 'csp', 'a11y', 'links', 'r12s', 'seo', 'budget'],
  severity: { budget: 'warn' },
  ignore: [{ audit: 'seo', message: '^orphan page' }],
});

Adopting it on an existing site: npx vidimus --accept-findings records today's findings, and later runs fail only on new ones.

Client-rendered apps (React, Angular, Vue) work too: server.fallback answers their routes, routes lists or crawls them, and render audits the DOM the browser builds instead of the empty shell: client-rendered apps.

Docs

ljs360d.github.io/vidimus: getting started, how it works, audits, configuration, CLI, CI, frameworks, custom audits and API. Contributing: CONTRIBUTING.md.

The docs are deliberately built eight times from the same markdown, by VitePress, Starlight, Hugo, Eleventy, Zola, mdBook and client-rendered React and Angular apps, deployed side by side and audited by vidimus as one site, to dogfood it against eight builds' real output: why.

License

MIT