PerlNavigator 使用教程

PerlNavigator 使用教程

PerlNavigatorPerl Language Server that includes syntax checking, perl critic, and code navigation项目地址:https://gitcode.com/gh_mirrors/pe/PerlNavigator

1. 项目介绍

PerlNavigator 是一个 Perl 语言服务器，提供了语法检查、自动补全、Perl Critic 静态代码分析、代码导航和悬停提示等功能。它基于 Microsoft 的 LSP（Language Server Protocol）库实现，适用于 Windows、MacOS 和 Linux 平台。PerlNavigator 的 VSCode 扩展包含了所有必要的组件，无需额外安装即可使用。

2. 项目快速启动

2.1 安装 PerlNavigator

首先，确保你已经安装了 Node.js 和 npm。然后，按照以下步骤安装 PerlNavigator：

# 克隆项目仓库
git clone https://github.com/bscan/PerlNavigator.git

# 进入项目目录
cd PerlNavigator/

# 安装依赖并构建项目
npm run ci-all

# 进入服务器目录
cd server/

# 编译 TypeScript 代码
npx tsc

2.2 配置 VSCode

在 VSCode 中，安装 PerlNavigator 扩展。然后，在 VSCode 的 settings.json 中添加以下配置：

{
    "perlnavigator.perlPath": "~/perl5/perlbrew/perls/perl-5.38.2/bin",
    "perlnavigator.perlcriticSeverity": 1,
    "perlnavigator.includePaths": [
        "~/git/KohaCommunity",
        "~/git/KohaCommunity/lib"
    ],
    "perlnavigator.perlcriticEnabled": true,
    "perlnavigator.enableWarnings": true
}

2.3 启动 PerlNavigator

在 VSCode 中打开一个 Perl 文件，PerlNavigator 将自动启动并提供语法检查、代码补全等功能。

3. 应用案例和最佳实践

3.1 多根工作区支持

PerlNavigator 支持多根工作区，这意味着你可以在一个 VSCode 窗口中同时处理多个 Perl 项目。只需在 VSCode 中添加多个工作区目录即可。

3.2 自定义 Perl 路径

如果你使用的是自定义的 Perl 安装路径，可以在 settings.json 中设置 perlnavigator.perlPath 来指定 Perl 的安装路径。

3.3 启用 Perl Critic

PerlNavigator 集成了 Perl Critic，可以通过设置 perlnavigator.perlcriticEnabled 为 true 来启用静态代码分析。

4. 典型生态项目

4.1 RakuNavigator

如果你对 Raku 语言感兴趣，可以查看 RakuNavigator，这是一个类似的 Raku 语言服务器项目。

4.2 LiteXL 编辑器

对于 LiteXL 编辑器的用户，可以通过安装 LSP 插件并配置 perlnavigator 来使用 PerlNavigator。

local lsp = require "plugins.lsp"
lsp.add_server {
    name = "perlnavigator",
    language = "Perl",
    file_patterns = { "%pl$", "%pm$" },
    command = { "perlnavigator" },
    settings = {
        perlnavigator = {
            perlPath = "perl"
        }
    }
}

通过以上步骤，你可以在 LiteXL 编辑器中使用 PerlNavigator 提供的功能。

---

通过本教程，你应该已经掌握了 PerlNavigator 的基本使用方法和配置技巧。希望你能充分利用 PerlNavigator 提供的强大功能，提升 Perl 开发的效率。

PerlNavigatorPerl Language Server that includes syntax checking, perl critic, and code navigation项目地址:https://gitcode.com/gh_mirrors/pe/PerlNavigator