kakoune.cr: init at unstable-2021-04-30

[loewenheim]

Motivation for this change

I would like to have kakoune.cr in nixpkgs.

This is still a draft; it doesn't build for reasons that are a mystery to me. To be more concrete, when it gets to the building phase, this happens:

Resolving dependencies
Could not find commit a5df8025fd3ab182ae2511d525f708cbbe0ed43a for shard "fifo" in the repository https://github.com/alexherbo2/fifo.cr.git

I don't understand what "could not find commit" is supposed to mean. As far as I can tell it's set up exactly like crystal2nix, which builds without issue.

@alexherbo2 @manveru @peterhoeg

Things done

• Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
• Built on platform(s)
  • NixOS
  • macOS
  • other Linux distributions
• Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
• Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
• Tested execution of all binary files (usually in ./result/bin/)
• Determined the impact on package closure size (by running nix path-info -S before and after)
• Ensured that relevant documentation is up to date
• Fits CONTRIBUTING.md.

[SuperSandro2000]

I don't understand what "could not find commit" is supposed to mean. As far as I can tell it's set up exactly like crystal2nix, which builds without issue.

Does it try to access git information? They are not available by default. You can either patch it or add leaveDotGit = true; to the github fetcher.

[loewenheim]

Hm, at the very least I don't see where this might happen in crystal2nix. This is the entirety of its default.nix:

{ lib, fetchFromGitHub, fetchgit, crystal, makeWrapper, nix-prefetch-git }:

crystal.buildCrystalPackage rec {
  pname = "crystal2nix";
  version = "0.1.0";

  src = fetchFromGitHub {
    owner = "peterhoeg";
    repo = "crystal2nix";
    rev = "v${version}";
    sha256 = "sha256-K1ElG8VC/D0axmSRaufH3cE50xNQisAmFucDkV+5O0s=";
  };

  format = "shards";

  shardsFile = ./shards.nix;

  nativeBuildInputs = [ makeWrapper ];

  postInstall = ''
    wrapProgram $out/bin/crystal2nix \
      --prefix PATH : ${lib.makeBinPath [ nix-prefetch-git ]}
  '';

  # temporarily off. We need the checks to execute the wrapped binary
  doCheck = false;

  # it requires an internet connection when run
  doInstallCheck = false;

  meta = with lib; {
    description = "Utility to convert Crystal's shard.lock files to a Nix file";
    license = licenses.mit;
    maintainers = with maintainers; [ manveru peterhoeg ];
  };
}

[peterhoeg]

It's https://github.com/peterhoeg/crystal2nix/issues/1 - which manveru has helpfully provided a PR for but I still haven't merged... I'll fix it this weekend.

[loewenheim]

Thank you!

[loewenheim]

@peterhoeg any news?

[alexherbo2]

You should copy bin and share to $out.

[loewenheim]

@loewenheim It is important to copy the whole bin and share directories to $out, as kcr will look in share.

Do the various scripts in share still need to be linked into bin?

[alexherbo2]

If you want nix-shell -p kakoune.cr and have the shipped commands in your path yes.

Otherwise, Nix users will need to enter the following commands:

kcr install commands
kcr install desktop

[loewenheim]

The idea is definitely that you don't have to run these commands after installing with nix.

[alexherbo2]

@loewenheim It is important to copy the whole bin and share directories to $out, as kcr will look in share.

[alexherbo2]

You can replace with cp share/kcr/commands/*/kcr-* $out/bin.

[alexherbo2]

I updated again. :(

[loewenheim]

No problem :)

[peterhoeg]

@peterhoeg any news?

#116981

[peterhoeg]

I suggest you use format = "shards"; and then do the copying in the postInstall hook. You can use install instead of first creating a directory and then cping the file afterwards. Please also use a recent shards that supports the v2 format (crystal2nix now handles this correctly in v0.1.1).

[loewenheim]

@pteterhoeg What do you mean by “use install instead of first creating a directory and then cping the file”?

[peterhoeg]

Instead of doing this:

mkdir -p $out/share/icons/hicolor/scalable/apps
cp $icon $out/share/icons/hicolor/scalable/apps/kakoune.svg

mkdir -p $out/share/applications
cp share/kcr/applications/kakoune.desktop $out/share/applications

You can do:

install -Dm444 $icon $out/share/icons/hicolor/scalable/apps/${icon.name}
install -Dm444 t $out/share/applications share/kcr/applications/kakoune.desktop 

It's just less code and easier to read.

[loewenheim]

Instead of doing this:

mkdir -p $out/share/icons/hicolor/scalable/apps
cp $icon $out/share/icons/hicolor/scalable/apps/kakoune.svg

mkdir -p $out/share/applications
cp share/kcr/applications/kakoune.desktop $out/share/applications

You can do:

install -Dm444 $icon $out/share/icons/hicolor/scalable/apps/${icon.name}
install -Dm444 t $out/share/applications share/kcr/applications/kakoune.desktop 

It's just less code and easier to read.

TIL. Thank you very much for the explanation.

[SuperSandro2000]

Please squash the commits when appending new review feedback.

[alexherbo2]

@loewenheim bin/kcr should be able to find ../share/kcr.

[loewenheim]

Building on my machine fails with

In src/version.cr:3:8

 3 | {{ `git describe --tags --always`.chomp.stringify }}
        ^
Error: error executing command: git describe --tags --always, got exit status 128

error: builder for '/nix/store/aszwsjwcvnpglh60379dn8s85kwxyaxy-kakoune-cr-0.1.0.drv' failed with exit code 1;
       last 10 log lines:
       > Error target kcr failed to compile:
       > fatal: not a git repository (or any of the parent directories): .git
       > Showing last frame. Use --error-trace for full trace.
       >
       > In src/version.cr:3:8
       >
       >  3 | {{ `git describe --tags --always`.chomp.stringify }}
       >         ^
       > Error: error executing command: git describe --tags --always, got exit status 128
       >
       For full logs, run 'nix log /nix/store/aszwsjwcvnpglh60379dn8s85kwxyaxy-kakoune-cr-0.1.0.drv'.

i suppose the problem is the not a git repository: .git part, but I don't know what that's supposed to mean.

[SuperSandro2000]

i suppose the problem is the not a git repository: .git part, but I don't know what that's supposed to mean.

Nix strips the .git directory to make the tarballs reproducible. Can you overwrite the version detection with the version number? Maybe we need to patch this so that the version number is hardcoded or read from an environment variable. Last option would be to leave the git directory in the download.

[peterhoeg]

Or inject a "git" script that just echoes out the version (or whatever the consumer needs).

[fufexan]

I got it building with these changes. It doesn't work as expected, but it's closer to what we need (hopefully).
For example, running kcr-fzf gives:

/home/mihai/.nix-profile/bin/kcr-fzf: line 3: kcr-fzf-: command not found

and kcr-fzf-buffers complains it can't find fzf.

[fufexan]

This concludes where I've gotten with it. It works fine, tested with auto-pairs.kak and standalone.
@loewenheim can you apply the above suggestions?

[loewenheim]

I applied your suggested changes. Sorry for the slow response, I've been rather busy.

[SuperSandro2000]

This is a semi-automatic executed nixpkgs-review with nixpkgs-review-checks extension. It is checked by a human on a best effort basis and does not build all packages (e.g. lumo, tensorflow or pytorch).
If you have any questions or problems please reach out to SuperSandro2000 on IRC.

Result of nixpkgs-review pr 115011 run on x86_64-linux 1

1 package failed to build and are new build failure:

• kakoune-cr: plain log | pretty log

[fufexan]

It seems like adding kakoune to the buildInputs doesn't fix the tests failing. I suggest removing it and also disabling tests. I've been using this package as an overlay for a month and had no problems.

[loewenheim]

What do you mean by "disabling tests"?

[fufexan]

doInstallCheck = false;

[stale]

I marked this as stale due to inactivity. → More info

[peterhoeg]

@loewenheim - I appreciate that this has been a bit of a struggle, but are you still interested in getting this in?

[loewenheim]

Interest yes, but I'm afraid I don't have the time right now :/

[malte-v]

Updated PR here: #162522

[peterhoeg]

Closing as the linked PR supersedes this.