首页
/ 推荐开源项目:Doctor Pretty - 美观的Swift代码打印机

推荐开源项目:Doctor Pretty - 美观的Swift代码打印机

2024-05-30 23:34:06作者:卓炯娓

项目介绍

Doctor Pretty是一个基于A prettier printer (Wadler 2003)论文的Swift实现,它的目标是高效地将任意抽象语法树(AST)转换为美观的字符串。灵感来源于wl-pprint-annotated,该项目提供了一组组合器和一个名为Doc的基本元素,用于描述如何优雅地打印数据,就像解析器组合子库用来描述从文本到AST的转换一样。

项目技术分析

Doctor Pretty的核心是一个称为Doc的枚举类型,它封装了文本和换行信息。特别是,Doc中的.union情况非常关键,它表示尝试较长的行优先,如果空间不足再尝试较短的行。这个设计使得开发者可以通过组合各种Doc来表达复杂的布局策略。渲染器通过工作列表算法进行最佳匹配,先尝试长线,然后是短线,直到列表为空。

此外,项目提供了多种用于组合Doc的操作符,如<%><%%>等,使得在不同宽度下控制代码布局变得更加便捷。

应用场景

  1. 代码格式化工具:如果你正在构建类似gofmt的工具,用于Swift代码的格式化。
  2. 代码生成器:当你的应用需要自动生成Swift代码时,它可以提高代码的可读性。
  3. 源码到源码的编译器:在源码转换过程中,美化输出是很重要的一步。
  4. 命令行帮助信息:如果在终端窗口显示命令行应用程序的帮助信息,Doctor Pretty可以帮助优化显示效果。

项目特点

  1. 效率与美观并存:无论页面宽度大小,都能找到最合适的排版方式。
  2. 高度可组合Doc结构支持灵活的组合,使你可以轻松创建复杂的打印规则。
  3. 适应性强:能适应不同的页面宽度,并自动调整格式。
  4. 简单易用的API:提供的操作符易于理解和使用,可以快速上手。

安装Doctor Pretty只需在你的Package.swift中添加依赖:

.Package(url: "https://github.com/bkase/DoctorPretty.git",
         majorVersion: 0, minor: 5)

如果你对如何工作的原理感兴趣,请阅读论文A prettier printer (Wadler 2003)以获取更多细节。

总的来说,Doctor Pretty是一个强大且实用的工具,对于任何关注代码输出美观性和终端用户体验的开发者来说,都是不可或缺的。现在就开始使用它,让你的代码看起来更加专业和整洁!

登录后查看全文
热门项目推荐

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
662
442
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
138
222
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
361
354
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
97
155
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
815
149
gin-vue-admingin-vue-admin
🚀Vite+Vue3+Gin的开发基础平台,支持TS和JS混用。它集成了JWT鉴权、权限管理、动态路由、显隐可控组件、分页封装、多点登录拦截、资源权限、上传下载、代码生成器【可AI辅助】、表单生成器和可配置的导入导出等开发必备功能。
Go
46
8
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
110
74
凹语言凹语言
凹语言 | 因为简单,所以自由
Go
16
5
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
112
253