VEP 4: vixlang官方团队存储库规范

状态
草稿
类型
流程
创建日期
2026-06-30
作者
Fexcode

VEP 4 — vixlang官方团队存储库规范

摘要

定义 vixlang 官方团队(https://github.com/vixlang)创建和管理存储库的命名规范,确保各类型仓库可被快速识别。

动机

vixlang 官方团队维护的仓库涵盖第三方库、工具、扩展、文档等多种类型。统一的命名规范可以带来以下好处:

  • 用户通过仓库名即可判断其用途
  • 工具链(包管理器、编译器)可基于命名前缀自动分类处理
  • 社区贡献者能快速找到所需类型的仓库
  • 避免命名冲突,保持组织整洁

详细设计

命名规则

前缀 适用类型 示例 说明
vlib- 第三方库 vlib-json, vlib-http 可被其他项目依赖的库
vtool- 命令行工具 vtool-fmt, vtool-lint 可直接安装和调用的 CLI 工具
ext- 扩展/周边支持 ext-vscode, ext-vim Vix 语言扩展功能或编辑器插件
vdoc- 文档 vdoc-tutorial, vdoc-spec 教程、规范、参考文档等

说明

  • vlib-:纯库项目,提供 API 供其他项目使用,不包含可执行入口
  • vtool-:命令行工具,可通过包管理器安装,包含可执行入口
  • ext-:非核心编译器的拓展功能,包括但不限于编辑器插件、语言服务器、构建工具集成等
  • vdoc-:文档性质的内容,不包含可运行的代码

示例

官方团队仓库布局:

github.com/vixlang/
├── vlib-json/         # JSON 解析库
├── vlib-http/         # HTTP 客户端库
├── vtool-fmt/         # 代码格式化工具
├── vtool-lint/        # 代码检查工具
├── ext-vscode/        # VS Code 插件
├── ext-vim/           # Vim 插件
├── vdoc-tutorial/     # 入门教程
└── vdoc-spec/         # 语言规范文档

兼容性考虑

  • 本规范仅适用于新建仓库,不追溯现有仓库
  • 已有仓库可通过重命名逐步迁移,但需更新所有引用该仓库的依赖配置
  • VEP 仓库本身作为流程性项目,不适用本命名规范

参考文献


This site uses Just the Docs, a documentation theme for Jekyll.