首页
/ 推荐开源项目: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是一个强大且实用的工具,对于任何关注代码输出美观性和终端用户体验的开发者来说,都是不可或缺的。现在就开始使用它,让你的代码看起来更加专业和整洁!

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

项目优选

收起
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
338
1.19 K
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
899
536
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
188
267
kernelkernel
deepin linux kernel
C
22
6
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
140
188
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
375
387
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.09 K
0
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
87
4
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
arkanalyzerarkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
115
45