Skip to content
项目

shd101wyy/Yo has 41 GitHub stars and 0 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-16 20:53 UTC. Last push 2026-11-13.

这些数字如何统计

可以做什么

  • First-class types.
  • Compile-time evaluation.
  • Homoiconicity and metaprogramming (Yo syntax is inspired by the Lisp S expression. Simple syntax rule, Human & AI friendly).
  • Algebraic Effects and Handlers (One-shot delimited continuation. Tail-Resumptive. Effect handlers with return/unwind, by Evidence Passing).

实测星标增长

24小时
0
7天
更新延迟
15天
更新延迟
1个月
更新延迟

各周期内的星标净变化,周期相互重叠,并非每日新增。缺失的测量保持空白。星标代表关注度,不代表软件质量。

关于

[WIP NOT READY] Yo (柚) - A programming language that's LLM-friendly to write and human-friendly to read

人工智能

docs/zh-CN/README.md

原文

Yo

Yo logo

English | 简体中文

开发中 :) 尚未就绪!

https://shd101wyy.github.io/Yo

LLM 友好地编写,人类友好地阅读。

一种多范式、通用型、编译型编程语言。 Yo 的目标是 简单 和 快速(比 C 语言慢约 0% - 15%)。

Yo 这个名字来源于中文单词 柚(yòu),意为柚子,一种类似葡萄柚的大型柑橘类水果。这是我女儿的小名。

Yo 熊猫柚柚

认识一下 Yo 的熊猫柚柚(Youyou)。 Rust 有螃蟹 Ferris,Yo 有柚柚,一只抱着半个柚子的熊猫。Logo 也是这个柚子:三瓣果肉之间的白色果络组成一个 Y,外面一圈圆圆的柚子皮就是 o。


📖 我与编程语言的故事 —— 从 16 岁学 Java 到构建 Yo 的旅程。

特性

关于语言设计,请参阅 DESIGN.md。

以下是 Yo 支持的部分特性(非详尽列表):

  • 一等类型(First-class types)。
  • 编译时求值(Compile-time evaluation)。
  • 同像性(Homoiconicity)和元编程(Yo 语法受 Lisp S 表达式启发。简单的语法规则,对人类和 AI 友好)。
  • 闭包(Closure)。
  • 代数效应与处理器(一次性 delimited continuation、尾调用恢复式、通过 return/unwind 的效应处理器,基于 证据传递/Evidence Passing)。
  • Async/Await(内置 Io 效应。无栈协程与合作式多任务。惰性 Future、多 await、通过状态机转换实现的单线程并发)。
  • 默认内存安全 —— 用户代码无法在不显式声明 pragma(Pragma.AllowUnsafe); opt-in 的情况下写出 UB(无原始指针、无 FFI、无内联汇编)。原地修改使用 name : &mut T 参数;yo unsafe-report 用于审计 unsafe 表面。
  • 显式分配器 —— 与引用计数并存的 Zig 风格放置:默认使用全局分配器,在创建处传一个参数(Rc.new(v, alloc : .Some(a))、ArrayList(T).new(alloc : .Some(a)))就把内存块放进分配器 a;何时释放仍由 RC 决定,释放总是回到分配它的分配器。
  • 采用非原子引用计数的引用语义类型(ref(struct(...))/ref(enum(...))),与 Rust 的 Rc 相同:环会泄漏,除非用 Weak(T) 句柄打破它(内存安全)。
  • 基于所有权和生命周期分析的编译时引用计数。
  • 每核并行模型(详见 PARALLELISM.md)。
  • 形式化验证 —— 契约(requires/ensures/decreases)、精化类型(refine(T, p))与 ghost/量词规格在编译期经固定版本的 Z3 证明(yo verify):被驳倒的义务给出反例,附带缓存遥测、--strict 门禁、JSON 报告与 LSP 契约悬停。
  • 受 Zig 和 Nix 启发的声明式构建系统(yo build、yo init、WASM 目标)。
  • C 语言互操作。
  • 等等。
Yo 中的编译期阶乘;编辑器悬停在 result 上显示 comptime_int = 120

安装

安装脚本(推荐)

安装原生预编译的编译器。

# macOS / Linux
$ curl -sSL https://shd101wyy.github.io/Yo/install.sh | sh
# Windows(PowerShell)
> irm https://shd101wyy.github.io/Yo/install.ps1 | iex

安装到 <prefix>/lib/yo/<tag>,并在 <prefix>/bin/yo 创建链接,prefix 默认为 $HOME/.local。常用选项:

选项 含义
-v, --version=<tag> 安装指定版本(默认:最新版)
-p, --prefix=<dir> 安装前缀 —— 系统级安装用 /usr/local(需 sudo)
--from-source 从发布的单文件 yo.c 构建
-cc, --c-compiler=<cc> 源码构建使用的 C 编译器(隐含 --from-source)
-cflags, --c-flags=<f> 源码构建的额外 C 编译选项(隐含 --from-source)
-u, --uninstall 卸载而非安装
--dry-run 仅显示将要执行的操作,不做任何改动
# 安装指定版本,系统级安装
$ curl -sSL https://shd101wyy.github.io/Yo/install.sh | sh -s -- --version=v0.2.4 --prefix=/usr/local

# 使用自己的工具链从源码构建
$ curl -sSL https://shd101wyy.github.io/Yo/install.sh | sh -s -- -cc=gcc -cflags='-march=native'

没有预编译包的平台 —— 使用 --from-source。安装脚本会下载该版本的单文件 yo.c,并用你自己的 C 编译器编译,因此它链接的是你自己的 libc 和加载器。这正是 NixOS 上的解决方案 —— 预编译二进制文件中硬编码的 ELF 解释器路径 (/lib64/ld-linux-x86-64.so.2)在 NixOS 上并不存在。

注意: --from-source 需要发布版本中包含单文件 yo.c。截至 v0.2.4 的所有 版本都早于该产物,因此该选项仅适用于此后发布的版本。安装脚本会明确提示这一点, 而不会以晦涩的方式失败。

内存: 构建 Yo 本身(无论是 --from-source,还是在代码仓库中运行 yo build), 在 v0.2.43 或更新的编译器下,一台 8 GB 内存的机器就足够。完整构建编译器的峰值约为 4.3 GiB(在 Linux 上测得,包含 C 编译器),CI 在每次变更时都会在 8 GB、无 swap 的限制下 构建它。更早的版本约需 10 GB。编译你自己的程序所需的内存要少得多。

安装脚本会把 yo 命令放到你的 PATH 中。运行 yo --help 查看可用命令。

Yo 将代码转换为 C,因此需要一个 C 编译器来生成机器码。上面的安装脚本会替你 准备好;下面的指南用于手动配置工具链,或排查安装失败的问题。

以 WebAssembly 为目标还需要 Emscripten —— 参见 WASM 配置。

快速开始

$ yo init my-project        # 创建新项目
$ cd my-project
$ yo build run              # 构建并运行
Hello, world!

yo init 生成一个包含构建文件、源代码和测试的项目:

my-project/
├── build.yo              # 构建配置
├── src/
│   ├── main.yo           # 入口点
│   └── lib.yo            # 库模块
└── tests/
    └── main.test.yo      # 单元测试

src/main.yo:

{ println } :: import("std/fmt");

main :: (fn() -> unit)({
  println("Hello, world!");
});

export(main);

常用构建命令:

$ yo build                  # 构建所有产物
$ yo build run              # 构建并运行可执行文件
$ yo build test             # 运行测试
$ yo build --list-steps     # 列出可用构建步骤
$ yo build doc              # 生成 HTML 文档
$ yo fmt                    # 格式化 Yo 源文件
$ yo fmt --check            # 只检查格式,不写入变更

预导入模块(Prelude)

每个 Yo 文件自动导入 std/prelude.yo,它提供了无需任何显式导入即可使用的核心类型、trait 和内置函数:

  • 基本类型:bool、i8–i64、u8–u64、f32、f64、isize、usize、str
  • C 兼容类型:int、uint、short、long、longlong、char 等
  • 核心 trait:Eq、Ord、Add、Sub、Mul、Div、Iterator、IntoIterator、TryFrom、TryInto、Drop、Send、Acyclic 等
  • 元编程:Type、Expr、ExprList
  • 异步:Io、FutureState、JoinHandle
  • 工具函数:assert、unsafe、try、for、not、Rc.new、Arc.new
  • 等等

标准库

设计中

Yo 附带一个全面的标准库,涵盖字符串、集合、文件 I/O、网络、编码、正则表达式、加密等。完整模块参考,请参阅 标准库文档。

你可以使用 yo doc 为自己的项目生成文档:

$ yo doc ./src -o docs --title "我的项目"

或者在 build.yo 中添加文档步骤 — 详见 yo doc --help。

代码示例

查看 ./tests 和 ./std 文件夹获取更多代码示例。

Hello World

// main.yo
{ println } :: import("std/fmt");

main :: (fn() -> unit)({
  println("Hello, world!");
});

export(main);

// $ yo compile main.yo --optimize 2 -o main
// $ ./main

示例项目

项目 描述
raylib-yo 全面的 raylib bindings —— 35 个结构体类型、535 个函数、227 个常量
tetris-yo | 在线演示 使用 raylib-yo 构建的经典俄罗斯方块游戏,展示 Yo 的构建系统和 C 互操作
http-server-demo-yo 简单的 HTTP/1.1 服务器 —— 异步 I/O、代数效应、TCP 网络、请求解析与路由
markdown-it-yo 将流行的 JavaScript markdown 解析器 markdown-it 直接移植到 Yo,展示了字符串处理能力和性能
markdown-yo | 在线演示 高性能 markdown 转 HTML 转换器 —— 原生比 markdown-it 快 5-7 倍,WASM 快 2-6 倍(≥1 MB)。在浏览器中试用

贡献

编译器用 Yo 编写并自举。开发环境、构建流程与测试运行方式见 CONTRIBUTING.md —— 也欢迎借助 LLM 完成的贡献。

编辑器支持

  • VS Code 扩展可在 这里 获取,为 .yo 文件提供语法高亮和语言客户端。

    语言服务器就是 yo 二进制本身(yo lsp,stdio):诊断、悬停信息、自动补全、跳转到 定义、文档符号、查找引用、重命名、签名帮助、代码折叠和格式化,全部由 Yo 求值器提供。 只要 PATH 中有 yo(或设置了 yo.binPath),扩展就会启动它;其他支持 LSP 的编辑器 可以直接启动 yo lsp。设置方法与功能列表见 docs/zh-CN/LSP.md。

  • Vim / Neovim:最小化的语法文件和使用说明位于 vscode-extension/syntaxes/。 详见 vscode-extension/syntaxes/README.md 了解安装步骤、ftdetect 示例和 home-manager 片段。

版本管理

Yo 支持通过 .yo-version 文件进行项目级版本固定(类似 .nvmrc 或 .python-version):

# 将项目固定到特定的 Yo 版本
yo version pin 0.1.12

# 显示当前版本和固定版本
yo version

# 安装、列出和清理缓存的版本
yo version install 0.1.13
yo version list
yo version clean

当 .yo-version 文件存在时,yo CLI 会自动分发到固定的版本 —— 首次使用时下载并缓存对应的原生发布包。

完整文档请参阅 docs/zh-CN/VERSION_MANAGEMENT.md。

AI Agent 技能包

本仓库内置了一套 Agent 技能文件,帮助 AI Agent 学习如何编写 Yo 程序。这些技能文件具有可移植性 —— 只需将 .github/skills/ 目录复制到任意 Yo 项目中,Agent 即可在该项目中使用它们。

技能 描述
yo-syntax 核心语言语法:花括号语义、cond/match、结构体、枚举、运算符、模块
yo-core-patterns 常用模式:类型、泛型、trait、错误处理、集合、迭代器
yo-async-effects 异步/await、代数效应、Exception、Io、任务派生
yo-project-workflow yo CLI 命令、build.yo 项目文件、依赖管理

在自己的项目中使用

最简单的方式是使用 yo CLI:

yo skills install

该命令会将所有技能文件复制到当前项目中发现的每个 Agent 配置目录(.github、.agents、.claude、.opencode、.openai、.cursor)。如果都不存在,会自动创建 .agents/skills/。

你也可以手动复制:

cp -r .github/skills /path/to/your-yo-project/.github/
# 或者 .agents, .claude, 等,取决于你的 Agent 平台

之后在任意 AI Agent 会话中,通过技能名称(例如 @yo-syntax)调用该技能,即可为 Agent 提供关于 Yo 语言的上下文知识。

CLI 输出语言

CLI 帮助文本和用户可见消息支持双语(英语 + 简体中文):yo --lang zh-CN --help 或 export YO_LANG=zh-CN 可将 CLI 切换为简体中文。默认为英语。

许可证

Apache License 2.0 with LLVM Exceptions