更漂亮的配置

检查数字 高级 配置

版权所有 2021-2026 检查 Digit, LLC

使用量

安装

$ npm add -D @checkdigit/prettier-config

重要说明来自 高级安装文档数字 :

在您的工程中安装精确的 Pretier 本地版本 。 这保证了项目中的每个人 得到Pretier的准确版本。 即使是Pretier的补丁发布 也会导致稍有不同 格式化,所以你不希望不同的团队成员使用不同的版本和格式化彼此 前后变化.

为方便起见,只要安装 @checkdigit/prettier-config 将锁定到特定版本 联 合 国 prettier 将自动通过它的 peerDependencies。 。 。 . 不特别安装 prettier 本身是一个依赖.

编辑 package.json

{
  // ...
  "prettier": "@checkdigit/prettier-config"
  // ...
  scripts: {
    // ...
    "prettier": "prettier . --check",
    "prettier:fix": "prettier . --write",
    // ...
    "test": "... && npm run prettier"
    // ...
  }
}

除了进行测试和起伏外,还应使用更漂亮的设备 npm test 以验证格式化.

如果有问题, npm run prettier:fix 将把整个工程重新格式化为必要的样式.

注:Pretier 3.0和较新的忽略文件 .gitignore 默认。 如果您需要额外的 Pretier 特性 除外情形,将其添加到 .prettierignore 文档.

添加 .prettierignore 文件( 可选)

如果您已经生成了 TypeScript 文件, 您可以通过创建一个 .prettierignore 类似文件 :

src/api/*/swagger.ts

网络结构

WebStorm 支持 Pretier, 在首选项内打开 : Languages and Frameworks QQ JavaScript QQ Pretier.

您可以使用 QQP 用 Pretier 格式化块 。 WebStorm 还应询问您是否想要在整个项目中应用 Pretier 代码样式规则 。 (说是)

格式化固定装置

test 包含覆盖 TypeScript 和每个已配置插件的格式基线. npm test 检查它们; 在依赖或配置更改后运行 npm run prettier:fix 并审查固定diffs.

许可证

麻省理工学院