Configuration

cms-lab is deliberately config-first. Route mappings live in your repo so the scanner follows the same assumptions as your Next.js app.

Example

import { defineConfig } from "@cms-lab/core";

export default defineConfig({
  site: { url: "http://localhost:3000" },
  framework: { type: "next", router: "app" },
  cms: {
    provider: "prismic",
    repositoryName: "my-repo",
    accessToken: process.env.PRISMIC_ACCESS_TOKEN,
  },
  routes: [
    { type: "page", pattern: "/:uid", getPath: (doc) => "/" + doc.uid },
    { type: "article", pattern: "/articles/:uid", getPath: (doc) => "/articles/" + doc.uid },
  ],
  checks: {
    fields: {
      required: [
        { type: "page", path: "title" },
        { type: "article", path: "title", severity: "warning" },
      ],
    },
  },
});

Keys

Adapter examples

Adapter configs use the same route and check model. Strapi and Directus declare collections; WordPress declares REST content types. The adapters preserve native CMS fields in document.data, so route mappings and required-field checks can use provider-specific values when your app needs them.

cms: {
  provider: "strapi",
  url: "http://localhost:1337",
  token: process.env.STRAPI_TOKEN,
  collections: [{ type: "page", endpoint: "pages" }],
}

cms: {
  provider: "directus",
  url: "http://localhost:8055",
  token: process.env.DIRECTUS_TOKEN,
  collections: [{ type: "page", collection: "pages" }],
}

cms: {
  provider: "wordpress",
  url: "http://localhost:8080",
  contentTypes: [{ type: "post", endpoint: "posts" }],
}

Required fields

Field checks are project-specific. Use them for CMS values that your app assumes exist at render time.

checks: {
  seo: {
    metaTitle: true,
    metaDescription: true,
  },
  a11y: {
    imgAlt: true,
  },
  fields: {
    required: [
      { type: "page", path: "title" },
      { type: "article", path: "author.name", severity: "warning" },
    ],
  },
}