npm 包 @stellar/prettier-config 使用教程

1. 前言

如果你是一名前端开发者，你一定会对代码的格式有所要求。在团队合作中，为了让代码具有一致性，我们通常会遵循一个代码风格规范。而这个规范的执行，则需要使用代码格式化工具。

prettier 是目前最受欢迎的代码格式化工具之一。它提供了多种可定制的配置选项以满足不同团队的需求。npm 包 @stellar/prettier-config 则是一个针对 Stellar 团队开发环境的 prettier 配置包。

本篇文章将介绍如何使用 @stellar/prettier-config 包来帮助我们快速配置 prettier 工具。

2. 安装 @stellar/prettier-config 包

我们可以通过以下命令来安装 @stellar/prettier-config 包：

npm install -D @stellar/prettier-config

安装完毕后，我们需要在项目根目录下添加一个 .prettierrc.js 配置文件，并将以下代码写入该文件：

// .prettierrc.js
module.exports = {
  ...require("@stellar/prettier-config"),
};

3. 配置 prettier.config.js

我们也可以选择直接在项目 package.json 文件中配置 prettier 设置：

// package.json
{
  // ...
  "prettier": "@stellar/prettier-config"
}

不过我们还需要在 package.json 文件中增加一行命令：

// package.json
{
  // ...
  "scripts": {
    // ...
    "prettier": "prettier --config .prettierrc.js --write \"**/*.+(js|jsx|json|yml|yaml|css|md|mdx|html|graphql|svelte)\""
  }
}

上面的命令将会在运行时自动使用项目根目录下的 .prettierrc.js 配置文件，并对指定类型的文件进行 prettier 格式化。

4. 示例

// 示例代码
function add(x, y) {
  return x + y
}

console.log(add(1,2))

使用 prettier 后，上述示例代码将会自动格式化成：

function add(x, y) {
  return x + y;
}

console.log(add(1, 2));

5. 总结

@stellar/prettier-config 是一个面向 Stellar 团队开发环境的 prettier 配置包，使用起来非常简单方便。值得一提的是，团队协作中保持代码一致性十分重要，而 prettier 提供的自动化代码格式化功能也会让团队协作更加高效。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedcb00b5cbfe1ea061251d