xlings: 跨平台一键安装功能设计与思考 - 多编程环境搭建、工具软件安装、项目依赖管理

在前段时间开源了一个开发者命令行工具xlings, 收到了一些关注和反馈, 并且最近也对其中的一键安装功能 做了进步增强。希望不仅可以帮助初学者快速的搭建编程环境, 也能用于项目开发者来管理复杂项目的开发环境依赖和一键搭建配置支持

下面就从 最小功能实现、递归依赖安装、项目依赖管理 循序渐进的介绍一下这个功能的设计和思考

github.com/d2learn/xli...

注: 这个软件和功能目前依然处于比较前期的探索和开发中

一、最小功能实现 - 接口规范

1.1 接口设计视角

对于安装一个软件或编程环境大概可以划分成3个步骤: 下载 - 安装 - 配置

并且为了避免重复安装和显示软件的信息, 用top-down的思想,大概核心的接口设计如下:

lua 复制代码
function support()
-- ...
end

function installed()
-- ...
end

function install()
-- ...
end

function config()
-- ...
end

function info()
-- ...
end

其中support接口用来标识当前系统是否支持, info接口是用于获取软件的基础信息

lua 复制代码
function support()
    return {
        windows = true,
        linux = true,
        macosx = false
    }
end

function info()
    return {
        name     = "vscode",
        homepage = "https://code.visualstudio.com",
        author   = "https://github.com/microsoft/vscode/graphs/contributors",
        licenses = "MIT",
        github   = "https://github.com/microsoft/vscode",
        docs     = "https://code.visualstudio.com/docs",
        profile  = "Visual Studio Code",
    }
end

1.2 接口实现视角

从对于单一软件或环境接口实现视角来看, 有点类似很多项目中的一键安装/配置脚本

但区别是xlings的安装实现上是符合一个接口规范 的, 这样才能为后面的复用提供可能性。并且使用者可以不用关心实现细节, 通过标准接口就可以使用对应的模块。

lua 复制代码
function installed()
    return try {
        function()
            if os.host() == "windows" and (os.getenv("USERNAME") or ""):lower() == "administrator" then
                return os.isfile("C:\\Program Files\\Microsoft VS Code\\Code.exe")
            else
                -- os.exec("code --version") - windows cmd not support?
                common.xlings_exec("code --version") -- for windows
            end
            return true
        end, catch {
            function(e)
                return false
            end
        }
    }
end

function install()
    print("[xlings]: Installing vscode...")

    local url = vscode_url[os.host()]
    -- only windows administrator
    local use_winget_sys = (os.getenv("USERNAME") or ""):lower() == "administrator"

    if not os.isfile(vscode_file) and not use_winget_sys then
        common.xlings_download(url, vscode_file)
    end

    return try {
        function ()
            if os.host() == "windows" then
                print("[xlings]: runninng vscode installer, it may take some minutes...")
                if use_winget_sys then
                    os.exec("winget install vscode --scope machine")
                else
                    common.xlings_exec(vscode_file .. " /verysilent /suppressmsgboxes /mergetasks=!runcode")
                end
            elseif os.host() == "linux" then
                os.exec("sudo dpkg -i " .. vscode_file)
            elseif os.host() == "macosx" then
                -- TODO: install vscode on macosx
            end

            return true
        end, catch {
            function (e)
                os.tryrm(vscode_file)
                return false
            end
        }
    }
end

二、递归安装依赖 - 复用&依赖图

通过上面的接口规范化后, 实现软件依赖的自动递归安装和复用就相对简单了。只需要再增加一个用于描述依赖的接口

lua 复制代码
function deps() -- pnpm
    return {
        windows = {
            "npm"
        },
        linux = {
            "npm"
        },
        macosx = {
            "npm" 
        }
    }
end

以pnpm的实现为例, 只需要通过依赖描述添加npm, 而不需要关心npm是否安装。当执行pnpm安装的时候会自动的递归检查依赖并安装。从单个软件的依赖链来看像一个不严谨的树形结构, 如果绘制所有软件和依赖会是一个依赖图, 并且节点是可以复用的 -- 软件安装复用

三、项目依赖管理 - 快速搭建项目开发环境

很多人在拿到一个不怎么熟悉的项目的时候, 往往要成功的去构建或运行这个项目要花不少时间去解决这个软件或库的依赖问题。所以xlings有了基础软件的安装功能, 就自然而然的想到当把一个项目从github上clone下来的时候能不能通过一行命令就自动配置好开发这个项目所需要的环境

在有上面的基础后, 就可以通过一个简单的依赖描述文件来描述一个项目依赖。xlings只需要通过加载这个依赖文件, 然后通过解析出依赖项, 按照递归的方式逐个安装,就可以实现一键配置好一个项目的开发环境。

config.xlings配置文件示例

lua 复制代码
xname = "ProjectName"
xdeps = {
    rust = "",
    python = "3.12",
    vs = "2022",
    nodejs = "",
    vscode = "",
    ...
    -- postprocess cmds
    xppcmds = {
        "cmd1",
        "cmd2",
    }
}

在配置文件中通过xdeps来描述项目的直接依赖, 并且可以通过其中的xppcmds项来自定义安装项目依赖后的后处理命令

四、统一的软件版本管理

目前xlings的下一步是期望能实现基于场景记忆的版本管理。例如当在一个特定的项目文件夹下 会使用不同的软件版本, 只不过这个还在规划中...

Other

相关推荐
zkmall2 小时前
企业电商解决方案哪家好?ZKmall模块商城全渠道支持 + 定制化服务更省心
大数据·运维·重构·架构·开源
DeepSeek-大模型系统教程6 小时前
推荐 7 个本周 yyds 的 GitHub 项目。
人工智能·ai·语言模型·大模型·github·ai大模型·大模型学习
ai小鬼头9 小时前
AIStarter最新版怎么卸载AI项目?一键删除操作指南(附路径设置技巧)
前端·后端·github
青阳流月11 小时前
1.vue权衡的艺术
前端·vue.js·开源
马可奥勒留11 小时前
睡前幻想——基于透明化黄金锚定的超主权货币体系设计:一种解决政府货币滥用的奥地利学派方案(3)
程序员
小小鱼儿小小林12 小时前
免费一键自动化申请、续期、部署、监控所有 SSL/TLS 证书,ALLinSSL开源免费的 SSL 证书自动化管理平台
开源·自动化·ssl
三花AI13 小时前
阿里开源 OmniAvatar:音频驱动数字人模型
开源·资讯
说私域13 小时前
基于开源AI智能客服、AI智能名片与S2B2C商城小程序的微商服务质量提升路径研究
人工智能·小程序·开源
蚂蚁数据AntData13 小时前
从性能优化赛到社区Committer,走进赵宇捷在Apache Fory的成长之路
大数据·开源·apache·数据库架构
阿里云云原生14 小时前
Spring AI Alibaba 游乐场开放!一站式体验AI 应用开发全流程
开源