js-beautify 教程

1. 项目介绍

js-beautify 是一个用于格式化 JavaScript、HTML 和 CSS 的开源工具，旨在使代码更易读、更美观。它支持命令行接口（CLI）、Node.js 库以及网页端库，方便开发者在各种场景下使用。该项目由 Ron Baldwin、Gabriel Harrison、Chris J Shull 等人共同开发，并在持续维护中。

2. 项目快速启动

2.1 安装 Node.js 版本

首先确保已安装 Node.js。接着全局安装 js-beautify：

npm install -g js-beautify

现在你可以通过以下命令对 JavaScript 文件进行格式化：

js-beautify foo.js

2.2 使用 Node.js 库

如果你想在 Node.js 项目中使用 js-beautify，先安装本地依赖：

npm install --save js-beautify

然后在你的代码中引入并使用：

const beautify = require('js-beautify');
const fs = require('fs');

fs.readFile('foo.js', 'utf8', (err, data) => {
  if (err) {
    throw err;
  }
  console.log(beautify.js(data, { indent_size: 2 }));
});

如果你使用的是 ESM 导入，可以这样写：

// 'beautify' 可以替换为你自定义的名字
import { js } from 'js-beautify';

const data = /* your code */;
const options = { indent_size: 2 };
console.log(js(data, options));

2.3 在浏览器中使用

将下面的脚本标签添加到你的 HTML 文档中，以使用最新的 js-beautify 版本：

<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.15.1/js-beautify.min.js"></script>

或从 rawgit CDN 获取：

<script src="https://cdn.jsdelivr.net/npm/js-beautify@1.15.1/js-beautify.min.js"></script>

之后，你可以利用暴露的 js_beautify() 函数进行格式化操作。

3. 应用案例和最佳实践

• 在提交代码之前，作为预提交检查来格式化代码。
• 当你需要整理混乱的代码时，可以用它快速清理。
• 为了团队协作和代码一致性，可以在编辑器中集成 js-beautify 插件。

最佳实践

• 配置合理的缩进大小和空格策略，如 indent_size: 2, space_in_empty_paren: true。
• 结合 Git 或版本控制系统，在代码变动前备份原文件。

4. 典型生态项目

• css-beautify: 专门处理 CSS 格式化的 Node.js 包，可与 js-beautify 配合使用。
• prettier: 另一个流行的代码格式化工具，提供更多的语言支持和更严格的代码风格。

要了解更多关于 js-beautify 的详细配置和使用方法，请参阅其官方文档。