Skip to main content

在 Remotion 存储库中的格式设置

Prettier

在合并代码之前,Remotion 代码库使用 Prettier 和 ESLint 进行格式设置,并要求所有代码都要正确格式化。

Prettier

在 VS Code 中,您可以安装 Prettier。其他编辑器的扩展程序可在 Prettier 网站 上找到。

编辑器应在您保存文件时自动读取我们的 .vscode/settings.json 文件并格式化您的代码。

要手动格式化整个包,请在包上运行 pnpm exec prettier src --write。示例:

bash
cd packages/renderer
pnpm exec prettier src --write
bash
cd packages/renderer
pnpm exec prettier src --write

ESLint

ESLint 将警告有关代码样式问题和错误。您可以安装 ESLint VS Code 扩展程序,在编写代码时在编辑器中获得警告。其他编辑器的扩展程序可在 ESLint 网站 上找到。

您还可以在任何包中运行 pnpm run lint 来检查是否有任何错误。示例:

bash
cd packages/renderer
pnpm run lint
bash
cd packages/renderer
pnpm run lint

测试所有内容

您可以在根目录中运行

bash
pnpm run stylecheck
bash
pnpm run stylecheck

来本地测试整个存储库是否格式正确,并且能通过持续集成检查。