vtsls: init at 0.2.3

[wizardlink]

Description of changes

This package provides a wrapper program for the TypeScript language server, this is an alternative option that a few distributions of NeoVIM are using, such as AstroNvim.

Things done

Added a binary for @vtsls/language-server and it's dependencies (@vtsls/language-service and @vtsls/vscode-fuzzy).

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 24.11 Release Notes (or backporting 23.11 and 24.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[wizardlink]

I haven't ran the nixpkgs-review test successfully, but it fails at 05d7f5e, so not sure what I should do here.

Also haven't added myself to maintainers.nix, I don't think it would be relevant here? I also have a PR (#297598) with it being added, so maybe that should stay just there.

[SuperSandro2000]

Please see #229475

[wizardlink]

Awesome! Will adapt as soon as I'm able to @SuperSandro2000.

[wizardlink]

As per #290715, pnpm.fetchDeps does not works in monorepos, which is the case of vtsls so the alternatives would be to just fetch it pre-compiled from the npm registry or maintain a fork of it without pnpm which I don't know if I'd have the time for.

What are your thoughts @SuperSandro2000?

[wizardlink]

I went with the option of maintaining a package-lock.json for now, will wait for your thoughts on the approach.

[SuperSandro2000]

I think this is causing IFD. Please see https://github.com/NixOS/nixpkgs/blob/ebc8e4d6d449f84364fa8399f9478fc924ec359b/doc/languages-frameworks/javascript.section.md#tool-specific-instructions-javascript-tool-specific

[wizardlink]

I'm sorry for the delay, I have been flooded with e-mails recently.

@SuperSandro2000 what do you mean with "IFD"? If it's the "import from derivation" feature, I'm not familiar with it and how it could relate to this issue.

I'm not quite sure why ofborg is failing to build it, I can locally via nix-build -A vtsls as well as calling the derivation in my system. Reading again the specifications for this, what I'm doing still makes sense to me, maybe I am misinterpreting something.

[wizardlink]

@SuperSandro2000, can you give me an update on this?

[lxsymington]

Far from knowledgeable on this and apologies if this is unhelpful, but this comment feels relevant? #316908 (comment)

[wizardlink]

No need for apologies, we're here to help each other.

vtsls is under a monorepo which in the javascript-section for pnpm it says that it's "[...] hard or impossible to produce a binary from such projects [...]", of which I couldn't myself get it to work, only through this method.

Perhaps I'm misunderstanding something, but through this method it's been working for me thus far.

[aca]

I tried to package vtsls for personal usage. Didn't know this PR existed.
vtsls packages/service build script seems to rely on git submodule and I couldn't get it work. Here's what I tried..
I was able to get it work by using this PR.

{
  bash,
  fetchFromGitHub,
  lib,
  pkgs,
  stdenvNoCC,
}:
stdenvNoCC.mkDerivation (finalAttrs: {
  pname = "vtsls";
  version = "latest";

  src = fetchFromGitHub {
    owner = "yioneko";
    repo = "vtsls";
    rev = "33ab3a11a5fcb3038d10d4f47d91655683b21dbc";
    hash = "sha256-DKJzQj5oD9LN5IHPwaepqGsOWvJjIlkvyutpiInKpDg=";
    fetchSubmodules = true;
    leaveDotGit = true;
  };

  nativeBuildInputs = [
    pkgs.nodejs
    pkgs.unstable.pnpm_9.configHook
    pkgs.git
  ];

  pnpmDeps = pkgs.unstable.pnpm_9.fetchDeps {
    inherit (finalAttrs) pname version src;
    hash = "sha256-NYx8+SVJbB7MZ5Oaw893QqtDmz+AIvaxy1qT6d+oCRU=";
  };

  buildPhase = ''
    set -x
    pnpm install
    pnpm run build
  '';

    # git status
    # git submodule status vscode
    # ls -al packages/service/vscode/
    # runHook preBuild
    # cd packages/service
    # runHook postBuild
})

[aciceri]

Suggested change

	npmDeps = importNpmLock {
	npmRoot = "${src}/packages/server";
	packageLock = lib.importJSON ./package-lock.json;
	};
	npmDeps = importNpmLock {
	package = lib.importJSON ./package.json; # you need to vendor also this file
	packageLock = lib.importJSON ./package-lock.json;
	};

IFD is a nix feature allowed by default in nix but forbidden in nixpkgs. My change above eliminates it but introduces other errors that I wasn't able to quickly fix.
Use

nix --option allow-import-from-derivation false build .#vtsls -L --no-eval-cache

from your nixpkgs directory to be sure that there are no IFDs (I'm also assuming flakes with the command above).
Anyway how did you get the package-lock.json file? Did you use npm i --package-lock-only? In that case it means that we are using different packages versions than upstream.

I saw that there is a package called pnpm-lock-export that should convert the original pnpm-lock.yaml file to a package-lock.json but it fails with that specific lockfile. There is also pnpm-lock-to-npm-lock but I haven't tried since it's not in Nixpkgs. However I believe you should document in a comment the needed to command to generate the lockfile, or even better, write an update script that does it automatically.

[wizardlink]

Thank you very much for the insight @aciceri! Yes I had just created a lockfile myself, since I couldn't create one otherwise (as far as I knew).

I'm seeing this quite late however, so now there seems to be an official way to handle workspaces as @lxsymington mentioned promptly mentioned - I'll be looking into that now and follow up the PR with it if things go smooth.

[lxsymington]

vtsls is under a monorepo which in the javascript-section for pnpm it says that it's "[...] hard or impossible to produce a binary from such projects [...]", of which I couldn't myself get it to work, only through this method.

@wizardlink It looks as if this merged PR #323493 may address that? Again apologies if I'm being unhelpful!

[austinbutler]

A few days ago another PR was opened for vtsls, already using pnpmWorkspace: #347284

[wizardlink]

Just got some time to take a look into it, I can close this PR in favor of it if anything.