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

使用 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 来简化操作。

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 的代码格式化工具?的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1527813.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月20日 19:44:45
下一篇 2025年12月20日 19:44:55

相关推荐

  • 前端组件库设计原理

    前端组件库的核心目标是提升开发效率、保证视觉一致性、降低维护成本。它通过设计系统统一颜色、字体、间距等token,支持主题切换与暗黑模式;采用BEM等命名规范确保样式一致。组件封装注重API语义化(如size=”large”)、支持受控/非受控模式、提供默认值与清晰事件回调。…

    2025年12月20日
    000
  • JavaScript中的标签模板(Tagged Templates)如何用于国际化?

    标签模板通过自定义函数拦截模板字符串解析,实现多语言动态替换。它将静态文本与变量分离,结合国际化词典和语言环境,按键查找翻译并安全插入变量,如i18nHello, ${‘小明’}返回“你好,小明!”。其优势为语法清晰、减少拼接错误、便于翻译提取与集成,适用于中大型应用,但需注…

    2025年12月20日
    000
  • 前端监控系统设计与错误追踪

    前端监控系统的核心目标是及时发现并定位用户遇到的JavaScript错误、资源加载失败和性能异常等问题。通过全局错误监听、Promise异常捕获、资源加载错误监听及框架级错误处理(如Vue、React)实现全面错误捕获;结合基础环境数据、页面状态与轻量级行为链路收集上下文信息,并借助Source M…

    2025年12月20日
    000
  • JavaScript无障碍访问实现

    JavaScript 的无障碍核心是确保动态内容、交互控件和状态变化对辅助技术可见且可操作。1. 使用 aria-live 处理动态更新,依紧急程度选 polite 或 assertive;2. 保障键盘导航,为自定义控件添加 tabindex 和键事件支持,管理模态框焦点;3. 动态更新 ARIA…

    2025年12月20日
    000
  • 前端日志系统设计与实现

    前端日志系统是排查问题、监控体验和优化性能的关键工具,需具备采集、分级、上报、存储与展示能力。首先定义日志级别(debug、info、warn、error、fatal),线上通常只上报warn及以上以控制数据量;结合自动采集(JS错误、Promise异常、资源加载失败、框架错误钩子、性能指标)与手动…

    2025年12月20日
    000
  • JavaScript密码学安全实现

    正确使用密码学需依赖标准库如Web Crypto API或Node.js crypto模块,避免自实现;密钥应通过环境变量或KMS管理,禁止硬编码;采用PBKDF2或Argon2派生密钥,配合高熵盐值;AES选用GCM或CBC模式,禁用ECB,IV随机唯一;哈希使用SHA-256以上,签名用HMAC…

    2025年12月20日
    000
  • JavaScript Deno运行时环境

    Deno 是由 Node.js 创始人 Ryan Dahl 推出的现代 JavaScript 与 TypeScript 运行时,核心特性包括默认安全机制、原生支持 TypeScript、基于 URL 的模块导入、内置标准库与开发工具。它使用 V8 引擎,强调安全性与简洁性,运行时需显式授权文件系统、…

    2025年12月20日
    000
  • 前端数据流架构模式比较

    前端数据流模式需根据项目规模、团队习惯和技术栈选择;2. Flux提出单向数据流,流程清晰但样板代码多;3. Redux采用单一Store和不可变更新,适合大型团队协作;4. MobX基于响应式,开发高效但追踪变化较难;5. Zustand轻量简洁,适合现代React项目快速上手;6. Vue响应式…

    2025年12月20日
    000
  • JavaScript自动化测试脚本

    JavaScript自动化测试核心是通过测试框架验证功能,常用工具包括Jest、Mocha、Cypress和Puppeteer;以Jest为例编写加法函数测试用例并运行npm test;通过mock模拟异步API请求;结合Git Hooks与CI/CD实现持续集成,逐步覆盖核心逻辑。 JavaScr…

    2025年12月20日
    000
  • 深入理解JavaScript原型链与继承机制

    JavaScript的继承基于原型链,每个对象通过[[Prototype]]链接到其原型,属性查找会沿链向上搜索。构造函数的prototype指向原型对象,实例的__proto__指向构造函数的prototype。继承可通过组合或寄生组合实现,ES6的class和extends语法更简洁,但底层仍依…

    2025年12月20日
    000
  • JavaScript发布订阅模式架构

    发布订阅模式是一种松耦合的事件通信机制,通过on、emit、off方法实现对象间解耦,适用于组件通信、状态管理与异步协调,需注意命名规范与内存泄漏。 发布订阅模式(Pub-Sub)是一种在JavaScript中广泛使用的松耦合架构模式,它允许对象之间通过事件进行通信,而无需直接引用彼此。这种模式特别…

    2025年12月20日
    000
  • JavaScript Generator函数原理剖析

    Generator函数通过function*定义,使用yield暂停执行并返回遍历器对象;每次调用next()恢复执行,实现可中断的异步流程控制。 Generator 函数是 JavaScript 中一种特殊的函数类型,它允许你在函数执行过程中暂停和恢复。这种能力使得 Generator 在处理异步…

    2025年12月20日
    000
  • LangChain HNSWLib 向量存储机制详解:内存与本地持久化

    本文深入探讨LangChain中HNSWLib向量存储的内部机制。HNSWLib作为内存型向量存储,其数据实际存储在项目运行的宿主服务器内存中,而非LangChain官方服务器。同时,它支持将向量数据持久化到本地文件系统,确保数据的安全与可恢复性。 在构建基于大型语言模型(LLM)的应用时,向量存储…

    2025年12月20日
    000
  • 微前端架构设计与实现原理

    微前端是一种架构理念,旨在将单体前端拆分为多个独立自治的子应用,实现独立开发、部署与技术栈无关,通过路由分发、沙箱隔离、生命周期管理和样式隔离等机制,在运行时集成并保持解耦,常用框架包括qiankun、Module Federation等,适用于多团队协作的大型系统,但需权衡加载性能、调试复杂度和初…

    2025年12月20日
    000
  • 如何构建一个渐进式Web应用(PWA)并解决其核心挑战?

    答案:构建PWA需围绕Service Worker、Web App Manifest和HTTPS三大核心,实现离线访问、可安装性与安全基础。1. 通过Service Worker拦截请求并缓存资源,采用Cache First等策略提升性能,利用Workbox解决缓存更新与调试难题。2. 配置mani…

    2025年12月20日
    000
  • JavaScript数据库操作优化

    通过减少网络请求、合理使用缓存、优化本地数据处理和提升IndexedDB效率,可显著提升前端数据操作性能。 JavaScript本身不直接操作传统意义上的数据库(如MySQL、PostgreSQL),但在前端或Node.js环境中,我们常通过API与后端数据库交互,或在浏览器中使用IndexedDB…

    2025年12月20日
    000
  • JavaScript中员工数据排名表生成指南:Besson排名法处理并列情况

    本文旨在指导如何使用javascript为员工数据生成多维度排名表,重点解决并列情况下的平均排名(besson rank)计算问题。教程涵盖了从数据准备、核心排名算法的实现,到最终将排名结果动态渲染为html表格的完整流程,为开发者提供了一套专业且实用的数据处理方案。 引言 在企业管理或数据分析场景…

    2025年12月20日
    000
  • 在 VS Code 扩展中检测 Git HEAD 变更以响应终端操作

    在 vs code 扩展中直接监听终端执行的特定命令(如 `git checkout`)具有挑战性。一种高效且跨平台的方法是间接检测 git 仓库的状态变化。本文将详细介绍如何通过监控 git 仓库的 `.git/head` 文件,利用 `chokidar` 库实现对分支切换等关键 git 操作的响…

    2025年12月20日
    000
  • 响应式jQuery Marquee:在移动端初始化与桌面端销毁的实现指南

    本教程旨在解决jquery marquee插件在不同设备尺寸下响应式管理的问题。我们将学习如何利用`window.matchmedia`进行媒体查询,并结合数据属性(`data-*`)来精确控制插件的初始化与销毁,确保在窗口大小调整时,marquee效果能在移动端自动启用,在桌面端自动停用,从而避免…

    2025年12月20日
    000
  • JavaScript边缘计算应用

    JavaScript 在边缘计算中的应用正变得越来越广泛,主要得益于其轻量、灵活以及在服务端(Node.js)和浏览器端的通用性。边缘计算强调在靠近数据源的位置处理信息,减少延迟、节省带宽并提升响应速度。JavaScript 凭借其生态系统和运行时环境,正在多个边缘场景中发挥关键作用。 1. 边缘函…

    2025年12月20日
    000

发表回复

登录后才能评论
关注微信