Creation:2025-12-30Last update:2025-12-30
将此文档参考到您的 AI 助手ChatGPTClaudeDeepSeekGoogle AI modeGeminiPerplexityMistralGrok
使用您最喜欢的AI助手总结文档,并引用此页面和AI提供商
版本历史
- "添加 --no-gitignore 选项"v8.6.42026/3/31
- "添加 init 命令内容"v7.5.92025/12/30
此页面的内容已使用 AI 翻译。
查看英文原文的最新版本编辑此文档
如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接Copy
复制文档 Markdown 到剪贴板
初始化 Intlayer
bash
复制代码
复制代码到剪贴板
npx intlayer initinit 命令通过创建必要的文件和设置,在您的项目中自动配置 Intlayer。这是开始使用 Intlayer 的推荐方式。
别名:
npx intlayer init
参数:
--project-root [projectRoot]- 可选。指定项目的根目录。如果未提供,命令将从当前工作目录开始搜索项目根目录。--no-gitignore- 可选。跳过自动更新.gitignore文件。如果设置了此标志,.intlayer将不会添加到.gitignore中。
工作原理:
init 命令执行以下设置任务:
- 验证项目结构 - 确保您位于包含
package.json文件的有效项目目录中。 - 更新
.gitignore- 将.intlayer添加到您的.gitignore文件中,以将生成的文件排除在版本控制之外(可以使用--no-gitignore跳过)。 - 配置 TypeScript - 更新任何
tsconfig.json文件以包含 Intlayer 类型定义 (.intlayer/**/*.ts)。 - 创建配置文件 - 使用默认设置生成
intlayer.config.ts(对于 TypeScript 项目)或intlayer.config.mjs(对于 JavaScript 项目)。 - 更新 Vite 配置 - 如果检测到 Vite 配置文件,将添加
vite-intlayer插件的导入。 - 更新 Next.js 配置 - 如果检测到 Next.js 配置文件,将添加
next-intlayer插件的导入。
示例:
基础初始化:
bash
复制代码
复制代码到剪贴板
npx intlayer init这将在当前目录中初始化 Intlayer,并自动检测项目根目录。
使用自定义项目根目录初始化:
bash
复制代码
复制代码到剪贴板
npx intlayer init --project-root ./my-project这将在指定的目录中初始化 Intlayer。
初始化而不更新 .gitignore:
bash
复制代码
复制代码到剪贴板
npx intlayer init --no-gitignore这将设置所有配置文件,但不会修改您的 .gitignore。
输出示例:
bash
复制代码
复制代码到剪贴板
npx intlayer initChecking Intlayer configuration...✓ Added .intlayer to .gitignore✓ Updated tsconfig.json to include intlayer types✓ Created intlayer.config.ts✓ Injected import into vite.config.ts✓ Intlayer init setup complete.注意事项:
- 该命令是幂等的--您可以安全地多次运行它。已配置的步骤将被跳过。
- 如果配置文件已存在,则不会被覆盖。
- 不包含
include数组的 TypeScript 配置(例如带有引用的 solution-style 配置)将被跳过。 - 如果在项目根目录中未找到
package.json,该命令将报错退出。