@domandigital/sanity-copy

The Doman Digital house copy check inside Sanity Studio. Every document type gains craft's copy rules as validation warnings, on the exact field that caused them, including inside Portable Text. Publishing always still works: copy the owner types is advised on, never overridden.

The rules are COPY.md in @domandigital/craft. This package only decides which strings in a document are copy, and where each finding belongs.

In a Studio

Works in any Sanity Studio, v3 or later. It uses only Rule.custom(), Rule.warning() and plain document-action functions, and imports nothing from Sanity, so no Studio version is pinned. Its tests run against stand-ins for those shapes, not a live Studio. Nothing in it is specific to one site. Two steps:

1. pnpm add @domandigital/sanity-copy (or npm, or yarn) in the Studio's app.
2. Wrap the types array in sanity.config.ts, as below.

import { defineConfig } from "sanity";
import { withCopyCheck } from "@domandigital/sanity-copy";
import { schemaTypes } from "./schemas";

export default defineConfig({
  // ...
  schema: { types: withCopyCheck(schemaTypes) },
});

An editor sees, on the field:

House rule (Em dash): "local businesses — built". Use a full stop, a comma, or a colon.

Why a wrapper and not a plugin: a plugin's schema.types function runs before the Studio's own types are added, so a plugin never sees them.

Options, all optional:

What is read: strings, Portable Text (a block's spans joined, so a template split across spans is still caught), and the alt text and caption of images. What is not: slugs, links, references, enum values, language tags, asset data, and fields the schema hides with hidden: true. A hidden function is not evaluated: it is decided per document and per editor, and the check has no way to know the answer for a nested field, so those fields are still read.

Localised content

The rules are English. On a localised Studio, pass languages: ["en"] so the other languages are left alone ("en" also covers en-GB and en_US). Four shapes are recognised:

Blocking publish (opt-in)

Everything above warns. A Studio that wants the house rules enforced can wrap the publish action, which then stays disabled while the document has a blocking-tier finding, with the finding as its tooltip. The review tier never blocks.

import { withCopyCheck, withCopyGuard } from "@domandigital/sanity-copy";

export default defineConfig({
  schema: { types: withCopyCheck(schemaTypes) },
  document: {
    actions: (prev) => prev.map((a) => (a.action === "publish" ? withCopyGuard(a) : a)),
  },
});

The original action is always called, so its behaviour is unchanged apart from disabled and the tooltip. Excluded types (testimonials and the rest) are never blocked.

Sweeping a whole dataset

npx @domandigital/sanity-copy --project <id>                 # a public dataset
SANITY_API_TOKEN=... npx @domandigital/sanity-copy --project <id> --types homepage,service
npx @domandigital/sanity-copy --file export.json --json

Findings are listed per document and field. Exit 0 no house-rule finding, 1 at least one, 2 nothing was checked. A token is read from the environment, never a flag. It reports and changes nothing.

The claims list

npx @domandigital/sanity-copy --project <id> --claims

No style rule can say whether a figure is true. --claims lists every sentence holding a price, a figure, a date or a named source, on its field, marked sourced (a source is named, in the sentence or a footnote) or UNSOURCED. Check each against its primary source, then source it, correct it or cut it. It always exits 0: a checklist, not a verdict. documentClaims(doc) does the same in code.

In code

import { checkDocumentCopy, pathToString, describeFinding } from "@domandigital/sanity-copy";

for (const f of checkDocumentCopy(doc)) console.log(pathToString(f.path), describeFinding(f));

No Sanity dependency, and nothing a Studio imports touches Node, so the same check runs in the Studio, a script and a test.

Licence

Apache-2.0.