hhstore commented 1 year ago

Zig + Vscode/Sublime Text 4/Clion 搭建开发环境:

✅ 推荐使用 Sublime Text 4/Vscode 做为开发工具.
✅ subl 似乎和 zig + zls 搭配更稳定. vscode 炸了一波了.
✅ zls 目前只支持 zig 标准库补全, 不支持第三方包.

步骤说明:

✅ 1. 安装 zig. ✅ 2. 安装 zls, 用于 vscode 解析/索引 zig 代码. ✅ 3. 安装 vscode/clion 相关 zig 插件 ✅ 4. 更改 vscode 插件设置, 配置 zls 参数. ✅ 5. 配置结束, 愉快写代码.

安装 Zig:

setup zig development environment.

install:

✅ 建议直接安装 dev 版本, zig 迭代很活跃. 社区包, 基本都是基于 nightly 版本构建.
✅ 脚本1, 安装 zig dev 版本, 从官网下载官网 - 安装包, 解压到指定路径.
✅ 脚本2, 安装 zig 稳定版本 + zls 脚本. 可以把 zls 安装脚本挑出来, 单独安装 zls.


  # for macos + m1:
  install:zig:dev:
    cmds:
      - mkdir -p $HOME/.local/bin/;
      - cd $HOME/.local/bin/; curl -L https://ziglang.org/builds/zig-macos-aarch64-0.10.0-dev.2617+47c4d4450.tar.xz | tar -xJ --strip-components=1 -C .;
      - chmod +x $HOME/.local/bin/zig;
      - zig version

  install:zig:
    cmds:
      - brew install zig
      - zig version
      - brew install xz # for zig zls
      - mkdir $HOME/zls && cd $HOME/zls && curl -L https://github.com/zigtools/zls/releases/download/0.9.0/x86_64-macos.tar.xz | tar -xJ --strip-components=1 -C .
      - chmod +x $HOME/zls/zls
      - sudo $HOME/zls/zls configure
    ignore_error: true

当前 dev 版本:


➤ which zig
/Users/dev/.local/bin/zig

➤ zig version
0.10.0-dev.2617+47c4d4450

➤ zig env
{
 "zig_exe": "/Users/dev/.local/bin/zig",
 "lib_dir": "/Users/dev/.local/bin/lib/zig",
 "std_dir": "/Users/dev/.local/bin/lib/zig/std",
 "global_cache_dir": "/Users/dev/.cache/zig",
 "version": "0.10.0-dev.2617+47c4d4450"
}

安装 ZLS: (代码解析)

✅ https://github.com/zigtools/zls#installation
- 预先安装 zls, 实现代码跳转


  install:zls:
    cmds:
      - brew install xz # for zig zls
      - mkdir $HOME/zls && cd $HOME/zls && curl -L https://github.com/zigtools/zls/releases/download/0.9.0/x86_64-macos.tar.xz | tar -xJ --strip-components=1 -C .
      - chmod +x $HOME/zls/zls
      - sudo $HOME/zls/zls configure
    ignore_error: true

交互式配置日志:


Welcome to the ZLS configuration wizard!
      *
       |\
      /* \
      |  *\
    _/_*___|_    x
      | @ @     /
     @     \   /
      \__-/   /

? Should this configuration be system-wide? (y/n) > y
Found zig executable '/Users/dev/.local/bin/zig' in PATH.
? Which code editor do you use? (select one)

  - VSCode
  - Sublime
  - Kate
  - Neovim
  - Vim8
  - Emacs
  - Doom
  - Other

> vscode
? Do you want to enable snippets? (y/n) > y
? Do you want to enable style warnings? (y/n) > y
? Do you want to enable semantic highlighting? (y/n) > y
? Do you want to enable .* and .? completions? (y/n) > y
Writing config to /Library/Preferences/zls.json ... successful.

To use ZLS in Visual Studio Code, install the 'ZLS for VSCode' extension from 
'https://github.com/zigtools/zls-vscode/releases' or via the extensions menu.
Then, open VSCode's 'settings.json' file, and add:

"zigLanguageClient.path": "[command_or_path_to_zls]"

Thank you for choosing ZLS!

vscode 配置:

vscode 下载:

✅ https://code.visualstudio.com/

vscode 插件安装:

参考:

✅ https://zig.news/jarredsumner/setting-up-visual-studio-code-for-writing-zig-kcj

`clion / IntelliJ IDEA` 配置:

IDE: clion

✅ https://www.jetbrains.com/zh-cn/clion/
✅ IntelliJ IDEA Community Edition
- 免费的 IntelliJ IDEA 社区版, 也支持 zig 插件. 基本够用.

插件: intellij-zig

hhstore commented 1 year ago

vscode 配置:

✅ 当前 zls-vscode 新版插件炸了, 回退上一个版本(v1.1.2):
- https://github.com/zigtools/zls/issues/524
✅ 安装 zls 插件, 才能实现 vscode 的代码跳转.
✅ https://github.com/zigtools/zls/wiki/Installing-for-Visual-Studio-Code


# vscode 设置, 搜索 zls, 添加对应的 zls 安装路径

/Users/dev/zls/zls

vscode 设置:

✅ 代码预览:

✅ 成功跳转:

✅ 跳转到标准库:

之后, 就可以愉快的写 zig 了.

hhstore commented 1 year ago

clion / IntelliJ IDEA 配置:

目前 zig 的几个插件, 对最新版本的 IntelliJ IDEA 并不 work.
so, 只能使用 vscode + zig + zls 开发.
理论上, vim + zls 也应该是 work 的.

hhstore commented 1 year ago

1

hhstore commented 1 year ago

Sublime Text 4 + ZLS 配置 Zig 开发环境:

zls 配置:

https://github.com/zigtools/zls#sublime-text

步骤:

下载安装 Sublime Text 4.

安装 LSP 插件: https://github.com/sublimelsp/LSP

设置中, 添加 LSP 配置段:

注意 zls 的路径, 填写自己机器对应的路径.

结束. (如果不生效, 重启一下编辑器)


// Settings in here override those in "LSP/LSP.sublime-settings"
{
    "clients": {
        "zig": {
            "command": ["/Users/dev/zls/zls"],
            "enabled": true,
            "selector": "source.zig"
        }
    }
}