vimPlugins.magenta-nvim: init at 2025-01-24

[david-r-cox]

Things done

• 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/)
• 25.05 Release Notes (or backporting 24.11 and 25.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.

[david-r-cox]

Magenta requires running npm install --frozen-lockfile during install.

I'm not yet sure how to declare this.

One idea I had was to do it within pkgs/applications/editors/vim/plugins/overrides.nix, however, this isn't as straightforward as just running npm install in buildPhase because there's no network access during the build (for purity).

Another idea is to do something similar to what's done in markdown-preview-nvim but with npm instead of yarn:

  markdown-preview-nvim =
    let
      # We only need its dependencies `node-modules`.
      nodeDep = mkYarnModules rec {
        inherit (super.markdown-preview-nvim) pname version;
        packageJSON = ./markdown-preview-nvim/package.json;
        yarnLock = "${super.markdown-preview-nvim.src}/yarn.lock";
        offlineCache = fetchYarnDeps {
          inherit yarnLock;
          hash = "sha256-kzc9jm6d9PJ07yiWfIOwqxOTAAydTpaLXVK6sEWM8gg=";
        };
      };
    in
    super.markdown-preview-nvim.overrideAttrs {
      patches = [
        (replaceVars ./markdown-preview-nvim/fix-node-paths.patch {
          node = "${nodejs}/bin/node";
        })
      ];
      postInstall = ''
        ln -s ${nodeDep}/node_modules $out/app
      '';

      nativeBuildInputs = [ nodejs ];
      doInstallCheck = true;
      installCheckPhase = ''
        node $out/app/index.js --version
      '';
    };

There doesn't seem to be a npm equivalent to mkYarnModules though and AFIK there isn't a way to do this cleanly with node2nix.

Open to ideas.

[david-r-cox]

Not sure how all 7 of you got tagged as reviewers... apologies.

[PerchunPak]

You are looking for fetchNpmDeps, no?

Not sure how all 7 of you got tagged as reviewers... apologies.

That's okay. Otherwise, we wouldn't know this PR existed

[GaetanLepage]

Not sure how all 7 of you got tagged as reviewers... apologies.

This is normal and expected. The whole neovim team gets pinged when a PR edits specific files such as the plugin derivations.