[feature] fileAssociations for some perl files (latexmkrc, ...)

[Freed-Wu]

latexmk/latexmk.pl is the latexmk code. latexmk uses latexmkrc/.latexmkrc as its configuration file, which contains some default variables such as $out_dir, $show_time, @default_files, and functions like add_cus_dep, etc. The goal is to provide LSP support for latexmkrc/.latexmkrc, including completion for default variables and functions, as well as function jumping.

A possible and general solution is to provide an additional configuration option in the initializationOptions of the initialize request for perl-language-server.

{
  "method": "initialize",
  "params": {
    "initializationOptions": {
      "perlnavigator": {
        "fileAssociations": {
            "latexmkrc": ["/the/path/of/latexmk"],
            ".latexmkrc": ["/the/path/of/latexmk"]
        }
      }
    }
  }
}

/the/path/of/latexmk is the path to latexmk/latexmk.pl, and then the language server can provide LSP support for latexmkrc/.latexmkrc based on this file.

Similar issues:

• [feature] fileAssociations for some perl files (latexmkrc, ...) FractalBoy/perl-language-server#206
• [feature] fileAssociations for some perl files (latexmkrc, ...) richterger/Perl-LanguageServer#223

[bscan]

Hi @Freed-Wu, thanks for filing the issue. This is generally a language association problem, which is often handled by the editor. If you are using vscode, you can change the associated language in the bottom right.

However, your question about default associations is a good question. I did some digging and these are currently defined by vscode itself, where vscode identifies languages based on either file extension (e.g. .pl, .pm) or content ( "firstLine": "^#!.*\\bperl\\b" ) . See
https://github.com/microsoft/vscode/blob/main/extensions/perl/package.json

You can also add additional explicit associations if you'd like as a User setting. This is probably the simplest solution for now:

"files.associations": {
    "latexmkrc": "perl",
    ".latexmkrc": "perl"
}

It's possible for Perl Navigator to extend the vscode defaults by adding a contributes.languages.filenames as specified here https://github.com/microsoft/vscode-docs/blob/main/api/references/contribution-points.md#contributeslanguages , but Perl Navigator doesn't currently modify vscode's definition of Perl.

I looked around and one example that does this is Shopify's Ruby LSP where they specify additional filenames (e.g. Gemfile) that are always handled by the Ruby extension: https://github.com/Shopify/ruby-lsp/blob/7111db0d5d0d95c8915f3d7f7b558af0348f6fa1/vscode/package.json#L770

If we were to do this in Perl Navigator, I would probably copy the list from Github's linguist here, which includes latexmk: https://github.com/github-linguist/linguist/blob/ee4fb24d13cb21a0eb43b30b52f5cde17fbba8ae/lib/linguist/languages.yml#L5969

Probably won't get to this for a bit, but the files.association is a good workaround for now. Also, everything here is relevant to richterger/Perl-LanguageServer#223 as well.

[Freed-Wu]

This is generally a language association problem,

No, I means complete the builtin variables. That is when I edit a new file latexmkrc, and press $, the completion will work.

If you are using vscode

I use coc-perl

[bscan]

Ah, thanks for the clarification. I was thinking it was a language association problem where the editor did not recognize the file as Perl.

Once changed, it still won't do autocomplete since Perl Navigator doesn't have a mode for it. It's a good suggestion though and would make a nice feature. Perl Navigator doesn't currently have any file specific variables, but it's a nice idea. I won't get to it for a bit, but I'll leave this open if anyone wants to submit a pull request.