summaryrefslogtreecommitdiffstats
path: root/pkgs/development/compilers/rust/rustfmt.nix
blob: 20707b69308807bd4ae3b655f0c83fa74a3cb25a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
{
  lib,
  stdenv,
  cargo,
  makeWrapper,
  rustPlatform,
  rustc,
  asNightly ? false,
}:

rustPlatform.buildRustPackage {
  pname = "rustfmt" + lib.optionalString asNightly "-nightly";
  inherit (rustc) version src;

  # the rust source tarball already has all the dependencies vendored, no need to fetch them again
  cargoVendorDir = "vendor";
  buildAndTestSubdir = "src/tools/rustfmt";

  # changes hash of vendor directory otherwise
  dontUpdateAutotoolsGnuConfigScripts = true;

  nativeBuildInputs = [
    makeWrapper
  ];

  buildInputs = [
    rustc.llvm
  ];

  # rustfmt uses the rustc_driver and std private libraries, and Rust's build process forces them to have
  # an install name of `@rpath/...` [0] [1] instead of the standard on macOS, which is an absolute path
  # to itself.
  #
  # [0]: https://github.com/rust-lang/rust/blob/f77f4d55bdf9d8955d3292f709bd9830c2fdeca5/src/bootstrap/builder.rs#L1543
  # [1]: https://github.com/rust-lang/rust/blob/f77f4d55bdf9d8955d3292f709bd9830c2fdeca5/compiler/rustc_codegen_ssa/src/back/linker.rs#L323-L331
  preFixup = lib.optionalString stdenv.hostPlatform.isDarwin ''
    install_name_tool -add_rpath "${rustc.unwrapped}/lib" "$out/bin/rustfmt"
    install_name_tool -add_rpath "${rustc.unwrapped}/lib" "$out/bin/git-rustfmt"
  '';

  env = {
    # As of 1.0.0 and rustc 1.30 rustfmt requires a nightly compiler
    RUSTC_BOOTSTRAP = 1;

    # As of rustc 1.45.0, these env vars are required to build rustfmt (due to
    # https://github.com/rust-lang/rust/pull/72001)
    CFG_RELEASE = rustc.version;
    CFG_RELEASE_CHANNEL = if asNightly then "nightly" else "stable";
  };

  postInstall = ''
    wrapProgram $out/bin/cargo-fmt \
      --suffix PATH : ${lib.makeBinPath [ cargo ]}
  '';

  meta = {
    description = "Tool for formatting Rust code according to style guidelines";
    homepage = "https://github.com/rust-lang/rustfmt";
    license = with lib.licenses; [
      mit
      asl20
    ];
    mainProgram = "rustfmt";
    maintainers = with lib.maintainers; [
      globin
      basvandijk
    ];
  };
}