sanity-schema-manager

sanity-io 的头像作者 sanity-io

管理模式生命周期,包括脚手架构建、安全字段弃用和数据迁移。在修改现有模式时使用。

📖 中文导读:管理模式生命周期,包括脚手架构建、安全字段弃用和数据迁移。在修改现有模式时使用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: sanity-schema-manager description: Manages schema lifecycle including scaffolding, safe field deprecation, and data migrations. Use when modifying existing schemas.

Schema Manager

This skill handles the lifecycle of Sanity Schema types.

Procedure

  1. Scaffold (Create)

    • Use templates to create document, object, or singleton types.
    • Constraint: Ensure defineType and defineField are used.
    • Constraint: Ensure an icon is imported from @sanity/icons.
  2. Deprecate (Update)

    • Ask: "Which field do you want to deprecate?"
    • Action: Apply the "ReadOnly -> Hidden -> Deprecated" pattern to the field definition.
    • Output:
      defineField({
        name: 'oldField',
        deprecated: { reason: 'Use newField instead' },
        readOnly: true,
        hidden: ({value}) => value === undefined,
        initialValue: undefined
      })
      
  3. Migrate (Data)

    • Generate a migration script using @sanity/migrate or standard client patches.
    • Template: Iterate over documents -> patch(doc.id).set({ newField: doc.oldField }).unset(['oldField']).
  4. Clean (Delete)

    • Only allow deleting a field definition if the user confirms "I have migrated the data and the field is undefined in all documents."