Sanity.io 工具包用于Next.js的安装与使用指南

本指南将带你深入了解如何搭建并使用sanity-io/next-sanity这个开源项目，它是一套专为构建生产级、可编辑内容的Next.js应用程序而设计的工具箱。我们将分步解释其核心组件、目录结构、启动与配置流程。

1. 项目目录结构及介绍

sanity-io/next-sanity不是一个独立的应用程序，而是一个工具集，因此其GitHub仓库主要包含的是库代码而非完整的应用示例。然而，我们可以推断出使用此工具包创建的项目可能包含以下典型结构：

• src/

  • 这个目录通常存放你的Next.js应用的主要源代码。
    • sanity/
      • 包含与Sanity CMS相关的配置和查询文件。
        • env.ts: 环境变量设置，如Sanity项目ID和数据集名称。
        • lib/: 存放自定义的Sanity查询（如queries.ts）和客户端配置。
          • queries.ts: 定义GROQ查询的文件。
        • types: 由Sanity TypeGen生成的TypeScript类型文件。
    • 其他Next.js标准目录结构，例如pages/, components/等。

• public/

  • 静态资源存放目录。

• package.json

  • 包含项目依赖、脚本命令等信息。

• .gitignore, pnpm-lock.yaml, package-lock.json, 或 yarn.lock

  • 版本控制忽略文件和锁文件。

• README.md

  • 项目说明文档，包括快速入门步骤和其他重要说明。

• sanity.config.ts

  • 如果包含嵌入式Sanity Studio，该文件可能位于根目录，用于配置Sanity Studio的路径、项目ID等。

2. 项目的启动文件介绍

在使用sanity-io/next-sanity构建的项目中，并没有一个单独称为“启动文件”的概念，而是遵循Next.js的常规启动模式。启动过程通常通过以下命令完成：

# 开发环境启动
npm run dev

# 生产环境构建
npm run build

• 开发模式 (npm run dev): 启动Next.js的热重载开发服务器。
• 构建模式 (npm run build): 根据源码生成生产环境优化后的静态页面和服务器代码。

3. 项目的配置文件介绍

环境配置文件 (.env.local)

通常需要在项目根目录下创建或修改.env.local来包含Sanity的项目ID和数据集名称：

NEXT_PUBLIC_SANITY_PROJECT_ID=你的项目ID
NEXT_PUBLIC_SANITY_DATASET=你的数据集名称

Sanity配置文件 (sanity.config.ts)

如果你选择嵌入Sanity Studio到应用中，会有一个sanity.config.ts文件来定义Studio的配置，如项目ID、数据集以及任何定制的结构或插件配置。

// sanity.config.ts
import { defineConfig } from 'sanity';
import { structureBuilder } from 'sanity';

const projectId = process.env.NEXT_PUBLIC_SANITY_PROJECT_ID;
const dataset = process.env.NEXT_PUBLIC_SANITY_DATASET;

export default defineConfig({
  basePath: '/studio', // 必须匹配你在路由中的Studio位置
  projectId,
  dataset,
  plugins: [
    structureBuilder().list('My Custom List').build(),
    // ...其他可能的插件
  ],
});

Type Generation Configuration (sanity-typegen.json)

若使用Sanity TypeGen，会有一个配置文件指导类型生成过程，这有助于自动产生TypeScript类型：

{
  "paths": ["src/**/*.ts", "src/**/*.tsx"],
  "schema": "src/sanity/extract.json",
  "generates": "src/sanity/types.ts"
}

这些配置确保了你的Next.js应用能够与Sanity CMS无缝集成，利用强类型系统提高开发效率。