怎样编写一个 JavaScript 的代码格式化工具？-js教程-PHP中文网

怎样编写一个 JavaScript 的代码格式化工具？

夢幻星辰

发布： 2025-10-08 19:31:01

原创

440人浏览过

使用 Esprima 解析代码为 AST，通过 estraverse 遍历节点并按规则添加缩进与换行，结合 escodegen 生成格式化代码，构建轻量级 JavaScript 格式化工具。

怎样编写一个 javascript 的代码格式化工具？

编写一个 JavaScript 代码格式化工具，核心是解析原始代码、构建语法树、再按照规则重新输出格式化的代码。最有效的方式是借助现有的解析器和生成器，结合自定义的格式化逻辑。

使用 Esprima 解析代码为 AST

Esprima 是一个高性能的 JavaScript 解析器，能将源码转换成抽象语法树（AST），这是格式化的第一步。

安装 Esprima：

npm install esprima

使用 Esprima 解析代码：

立即学习“Java免费学习笔记（深入）”；

const esprima = require('esprima');
const code = `function hello(){console.log("hi");}`;
const ast = esprima.parseScript(code);

得到的 ast 对象包含了完整的结构信息，比如语句类型、位置、嵌套关系等。

遍历 AST 并生成格式化代码

有了 AST 后，需要递归遍历每个节点，并根据节点类型决定如何添加空格、换行和缩进。

可以手动实现遍历函数，也可以使用工具如 estraverse 来简化操作。

腾讯云AI代码助手

基于混元代码大模型的AI辅助编码工具

查看详情

const estraverse = require('estraverse');

定义缩进级别和输出缓冲：

let indentLevel = 0;
let result = '';
const INDENT = ' '; // 两个空格

在遍历过程中处理不同节点：

遇到函数声明或块语句时，增加缩进
遇到语句结束时添加换行
根据规则控制括号前后空格、操作符间距等

示例片段：

estraverse.traverse(ast, {
  enter: function(node) {
    if (node.type === 'FunctionDeclaration') {
      result += 'function ' + (node.id ? node.id.name : '') + '(';
      // 处理参数...
      result += ') {';
      indentLevel++;
      result += '\n' + INDENT.repeat(indentLevel);
    }
  },
  leave: function(node) {
    if (node.type === 'BlockStatement') {
      indentLevel--;
      result += '\n' + INDENT.repeat(indentLevel) + '}';
    }
  }
});

使用 Escodegen 重建代码（可选）

如果不想手动拼接字符串，可以用 escodegen 直接从 AST 生成代码，并设置格式选项。

const escodegen = require('escodegen');
const formatted = escodegen.generate(ast, {
  format: {
    indent: { style: ' ', base: 0 },
    compact: false,
    renumber: true,
    quotes: 'single'
  }
});

escodegen 能自动处理大部分格式问题，适合快速实现基础格式化功能。

基本上就这些。你可以基于 Esprima + estraverse + escodegen 搭建一个轻量级格式化工具，再逐步加入自己的规则，比如分号风格、引号选择、箭头函数格式等。这类工具虽然不如 Prettier 强大，但有助于理解代码解析与格式化的核心机制。

以上就是怎样编写一个 JavaScript 的代码格式化工具？的详细内容，更多请关注php中文网其它相关文章！