Vix 语言文档

Appearance

xpm - Vix 包管理器 ​

VixLicense

xpm（Vix Package Manager）是 Vix 编程语言的官方包管理工具，依托 Git 仓库进行包管理，提供简洁的语法来下载、管理和发布 Vix 包。

English | 快速开始 | 命令介绍 | 参与贡献

特性概览# ​

  • 基于 Git 的包管理（支持 GitHub / Gitee）
  • 简洁的包引用语法（支持 @ 指定分支）
  • 自动依赖解析与本地缓存
  • 支持树形结构查看已安装包#

官方包下载仓库# ​

地址：https://github.com/vixlang

规范# ​

官方仓库的标准库项目名以 vlib- 开头。

快速开始# ​

安装 xpm# ​

bash
git clone https://github.com/vix-lang/xpm.git
cd xpm
python main.py install

验证安装# ​

bash
xpm --version

第一个包# ​

下载并安装一个包：

bash
xpm add vnet                        # 下载 github.com/vixlang/vlib-vnet
xpm add example.vnet                # 下载 github.com/example/vnet 仓库  
xpm add example.vnet@master         # 下载 master 分支

使用包# ​

vix
import "lib/vnet/server.vix"

fn main() -> i32 {
    let server = vnet.createServer(8080)
    print("Server running on port 8080")
    return 0
}

包索引格式# ​

bash
xpm add vnet                        # 下载 github.com/vixlang/vlib-vnet
xpm add example.vnet                # 下载 github.com/example/vnet 仓库  
xpm add example.vnet@master         # 下载 github.com/example/vnet 仓库 master 分支      
xpm add gitee.com:example.vnet      # 下载 gitee.com/example/vnet 仓库  
xpm add gitee:example.vnet@master   # .com 可以省略

我还给自己留了个语法糖（因为我比较喜欢 Gitee 嘛），
@example.xpm # 等价于 gitee:example.xpm

xpm命令介绍# ​

xpm add - 添加包# ​

xpm add 命令用于从 Git 仓库下载并安装 Vix 包。

格式# ​

bash
xpm add <git主仓库地址>:<用户名>.<git仓库项目名>@<分支名>

示例# ​

bash
xpm add example.vnet                # 下载 github.com/example/vnet 仓库
xpm add example.vnet@master         # 下载 github.com/example/vnet 仓库 master 分支
xpm add gitee.com:example.vnet      # 下载 gitee.com/example/vnet 仓库
xpm add gitee:example.vnet@master   # .com 可以省略
xpm add @example.vnet               # @符号开头默认为 gitee.com

xpm del - 删除包# ​

xpm del 命令用于删除已安装的 Vix 包。

格式# ​

bash
xpm del <git主仓库地址>:<用户名>.<git仓库项目名>

示例# ​

bash
xpm del example.vnet                # 删除 github.com/example/vnet 仓库
xpm del gitee.com:example.vnet      # 删除 gitee.com/example/vnet 仓库
xpm del gitee:example.vnet          # .com 可以省略
xpm del @example.vnet               # @符号开头默认为 gitee.com

xpm list - 列出已安装的包# ​

xpm list 命令用于列出所有已安装的 Vix 包。

格式# ​

bash
xpm list [-t|--tree]

参数# ​

  • -t, --tree: 以树形结构显示包列表#

示例# ​

bash
xpm list              # 列出所有已安装的包
xpm list -t           # 以树形结构显示包列表

xpm prune - 清理无效包和空目录# ​

xpm prune 命令用于删除没有 vindex.toml 的包和空目录。

格式# ​

bash
xpm prune [--empty-only | --invalid-only]

选项# ​

  • --empty-only: 只删除空目录
  • --invalid-only: 只删除没有 vindex.toml 的包#

示例# ​

bash
xpm prune                      # 删除无效包和空目录
xpm prune --empty-only         # 只删除空目录
xpm prune --invalid-only       # 只删除无效包

.vix 目录结构示例# ​

bash
.vix
└── libs
    ├── gitee.com
    │   ├── example
    │   │   ├── xpm
    │   │   └── xpm2
    │   └── example2
    │       └── xpm3
    └── github.com
        ├── example
        │   └── xpm
        ├── example2
        │   └── xpm2
        └── example3
            └── xpm3

参与贡献# ​

我们欢迎各种形式的贡献！包括但不限于：提出功能建议、撰写文档、报告 bug、提交代码、完善包生态等。

许可证# ​

本项目基于 Apache License 2.0 开源。

联系方式# ​

如果你对 xpm 感兴趣，欢迎 star、fork、提 issue，或者直接上手试试！