{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@repo/utils": ["packages/@repo/utils/src/index.ts"],
      "@repo/bundle-manager": ["packages/@repo/bundle-manager/src/index.ts"],
      "@repo/release-notes": ["packages/@repo/release-notes/src/index.ts"],
      "sanity": ["packages/sanity/src/_exports"],
      "groq": ["packages/groq/src/_exports.mts"]
    }
  }
}

3. Set required environment variables (used by bundle-manager and release-notes tooling):

SANITY_AUTH_TOKEN=<your-sanity-token>
GITHUB_TOKEN=<your-github-token>

4. Wire the shared Vitest config in your vitest.config.ts:

import {defineConfig} from './packages/@repo/test-config/vitest/index.mjs'

export default defineConfig({
  test: {
    include: ['src/**/*.test.ts'],
  },
})

5. Wire the shared ESLint config in your eslint.config.mjs:

import sharedConfig from './packages/@repo/eslint-config/index.js'

export default [...sharedConfig]

Public API

tagVersion

import {tagVersion} from '@repo/bundle-manager'

function tagVersion(options: {
  version: string
  tag: string
  dryRun?: boolean
}): Promise<void>

Tags a specific bundle version in Sanity's CDN manifest. Use this after a release is cut to associate a dist-tag (e.g. latest, next) with a specific uploaded version.

uploadBundles

import {uploadBundles} from '@repo/bundle-manager'

function uploadBundles(options: {
  version: string
  buildDir: string
  dryRun?: boolean
}): Promise<void>

Uploads compiled Studio bundle artifacts to Sanity's CDN. Call this as part of a CI release pipeline after building the Studio packages.

createOrUpdateChangelogDocs

import {createOrUpdateChangelogDocs} from '@repo/release-notes'

function createOrUpdateChangelogDocs(options: {
  version: string
  releaseNotes: string
  dryRun?: boolean
}): Promise<void>

Creates or updates changelog documentation for a release in the configured destination (e.g. Sanity dataset or GitHub). Use this in a post-release CI step to keep changelog documents in sync with published versions.

defineConfig (test-config)

import {defineConfig} from '@repo/test-config/vitest/index.mjs'

function defineConfig(config?: UserConfig): UserConfig

Wraps Vitest's defineConfig with monorepo-standard defaults: disabled console interception, package path aliases, and typecheck/exclude presets. Use this in every package's vitest.config.ts to stay consistent.

readEnv

import {readEnv} from '@repo/utils'

function readEnv(key: string): string

Reads a required environment variable by name, throwing if it is absent. Use instead of raw process.env access to get early, clear errors when configuration is missing.

Working examples

Scenario - Upload and tag a Studio release in CI

A CI pipeline builds the Studio and then uses bundle-manager to upload artifacts and tag the release.

import {tagVersion, uploadBundles} from '@repo/bundle-manager'
import {readEnv} from '@repo/utils'

async function publishRelease(version: string) {
  // Ensure required env is present
  readEnv('SANITY_AUTH_TOKEN')

  await uploadBundles({
    version,
    buildDir: './dist',
    dryRun: process.env.DRY_RUN === 'true',
  })

  await tagVersion({
    version,
    tag: 'latest',
    dryRun: process.env.DRY_RUN === 'true',
  })

  console.log(`Version ${version} uploaded and tagged as latest`)
}

publishRelease('5.24.0').catch(console.error)

Scenario - Generate and publish changelog documentation

After a release PR is merged, create or update changelog docs in the Sanity dataset.

import {createOrUpdateChangelogDocs} from '@repo/release-notes'
import {readEnv} from '@repo/utils'

async function updateChangelog(version: string, notes: string) {
  readEnv('SANITY_AUTH_TOKEN')
  readEnv('GITHUB_TOKEN')

  await createOrUpdateChangelogDocs({
    version,
    releaseNotes: notes,
    dryRun: false,
  })

  console.log(`Changelog docs updated for ${version}`)
}

updateChangelog('5.24.0', '## What changed\n- Fixed layout bug\n- Improved performance').catch(
  console.error,
)

Scenario - Configure Vitest for a package with custom test settings

A package in the monorepo needs Vitest with additional exclusions and its own global setup.

// packages/my-package/vitest.config.ts
import {defineConfig} from '../../@repo/test-config/vitest/index.mjs'

export default defineConfig({
  test: {
    include: ['src/**/*.test.ts', 'src/**/*.spec.ts'],
    exclude: ['src/**/__fixtures__/**'],
    globals: true,
    environment: 'node',
    setupFiles: ['./test/setup.ts'],
  },
})

File walkthrough

• @repo/bundle-manager/ - Provides tagVersion and uploadBundles commands for managing Studio CDN bundles; exposes a CLI via bin/bundle-manager.ts and a programmatic API via src/index.ts.
• @repo/eslint-config/ - Exports a flat ESLint config array combining TypeScript, React, import sorting, Prettier, and Turbo rules for use across all packages.
• @repo/package.bundle/ - Contains build tooling (src/package.bundle.ts) for bundling individual packages in the monorepo.
• @repo/package.config/ - Shared package configuration helpers used during build and publish steps.
• @repo/release-notes/ - Full automation suite for drafting GitHub release notes, writing changelog files, bumping versions, and publishing; exposes both a CLI and a programmatic API.
• @repo/test-config/ - Shared Vitest configuration factory with monorepo path aliases baked in.
• @repo/test-dts-exports/ - Utilities for validating that TypeScript declaration exports match what packages advertise.
• @repo/test-exports/ - Utilities for validating runtime exports of built packages.
• @repo/tsconfig/ - Base tsconfig.json files extended by all packages for consistent compiler settings.
• @repo/utils/ - Lightweight runtime helpers: readEnv, loadEnvFiles, sanityIdify, startTimer, MONOREPO_ROOT.
• @sanity/ - Collection of Sanity-specific packages (types, schema, diff, mutator, vision, etc.) used as peer dependencies throughout the Studio.
• groq/ - The GROQ query language package consumed by the Studio and user projects.
• sanity/ - The core Sanity Studio package, the primary consumer-facing entry point.

Common pitfalls and fixes

• Missing SANITY_AUTH_TOKEN: readEnv throws immediately if the variable is absent; set it in .env or CI secrets before running any bundle-manager or release-notes commands.
• ESM/CJS interop with @repo/eslint-config: The config uses ES module syntax (import/export); your eslint.config.mjs must use .mjs extension or have "type": "module" in package.json.
• Path aliases not resolving in Vitest: The defineConfig from @repo/test-config automatically sets up aliases for sanity, groq, and @sanity/* packages pointing to src/; do not re-declare conflicting aliases or they will override these.
• dryRun defaulting to false: Both uploadBundles and tagVersion will execute real CDN writes unless dryRun: true is explicitly passed; always gate on an env var in CI pipelines.
• TypeScript strict mode and @repo/tsconfig: The shared tsconfig enables strict mode; consumer packages that extend it and use any casts will see errors; add explicit type annotations rather than suppressing with // @ts-ignore.
• Oxlint rules applied by ESLint config: The shared ESLint config loads eslint-plugin-oxlint; if your project does not have an .oxlintrc.json at the monorepo root, the plugin will warn; copy the root .oxlintrc.json from @repo/release-notes/ as a starting template.

Vibe-coding prompt template

I have purchased the `user@example.com` source block. The source files are in `source/` and the integration guide is in `USAGE.md`.

Please help me integrate this into my existing Node.js/TypeScript project step by step:

1. Read `USAGE.md` fully before starting.
2. Copy the relevant packages from `source/` into my `packages/` directory.
3. Update my root `tsconfig.json` with the path aliases described in USAGE.md.
4. Wire the shared ESLint config from `source/@repo/eslint-config/index.js` into my `eslint.config.mjs`.
5. Wire the shared Vitest config from `source/@repo/test-config/vitest/index.mjs` into my `vitest.config.ts`.
6. Add a CI script that calls `uploadBundles` and `tagVersion` from `@repo/bundle-manager` after a successful build.
7. Add a post-release script that calls `createOrUpdateChangelogDocs` from `@repo/release-notes`.
8. Use `readEnv` from `@repo/utils` for all environment variable access.
9. Show me the final file tree and any `package.json` changes needed.

Only use exports that appear in USAGE.md. Do not invent any APIs.

License and credit

See source/LICENSE if present. This block is derived from the sanity ecosystem published by Sanity.io. The upstream package is user@example.com. Refer to the Sanity Studio repository and its LICENSE file for the authoritative license terms.

This product’s unique contribution is clean room implementation of valuable code block into AVCP compatible standard.

完整安装指南与集成提示词将在购买后解锁。

Sanity JavaScript Client for Content Lake

Automation, Utilities & Developer Tools

免费