29cc0b4a6b
Goal is to make generateLuarocksConfig appropriate in more scenarios, in my case, to generate rocks.nvim luarocks config We override the luarocks default for rocks_subdir to avoid conflicts when creating lua environments but it is not appropriate for other scenarios so let's not default to it in the "lib" function.
236 lines
7.1 KiB
Nix
236 lines
7.1 KiB
Nix
# Generic builder for lua packages
|
|
{ lib
|
|
, lua
|
|
, wrapLua
|
|
, luarocks_bootstrap
|
|
, writeTextFile
|
|
|
|
# Whether the derivation provides a lua module or not.
|
|
, luarocksCheckHook
|
|
, luaLib
|
|
}:
|
|
|
|
{ pname
|
|
, version
|
|
# we need rockspecVersion to find the .rockspec even when version changes
|
|
, rockspecVersion ? version
|
|
|
|
# by default prefix `name` e.g. "lua5.2-${name}"
|
|
, namePrefix ? "${lua.pname}${lib.versions.majorMinor lua.version}-"
|
|
|
|
# Dependencies for building the package
|
|
, buildInputs ? []
|
|
|
|
# Dependencies needed for running the checkPhase.
|
|
# These are added to nativeBuildInputs when doCheck = true.
|
|
, nativeCheckInputs ? []
|
|
|
|
# propagate build dependencies so in case we have A -> B -> C,
|
|
# C can import package A propagated by B
|
|
, propagatedBuildInputs ? []
|
|
|
|
# used to disable derivation, useful for specific lua versions
|
|
# TODO move from this setting meta.broken to a 'disabled' attribute on the
|
|
# package, then use that to skip/include in each lua${ver}Packages set?
|
|
, disabled ? false
|
|
|
|
# Additional arguments to pass to the makeWrapper function, which wraps
|
|
# generated binaries.
|
|
, makeWrapperArgs ? []
|
|
|
|
# Skip wrapping of lua programs altogether
|
|
, dontWrapLuaPrograms ? false
|
|
, doCheck ? false
|
|
# Non-Lua / system (e.g. C library) dependencies. Is a list of deps, where
|
|
# each dep is either a derivation, or an attribute set like
|
|
# { name = "rockspec external_dependencies key"; dep = derivation; }
|
|
# The latter is used to work-around luarocks having a problem with
|
|
# multiple-output derivations as external deps:
|
|
# https://github.com/luarocks/luarocks/issues/766<Paste>
|
|
, externalDeps ? []
|
|
|
|
# Appended to the generated luarocks config
|
|
, extraConfig ? ""
|
|
|
|
# transparent mapping nix <-> lua used as LUAROCKS_CONFIG
|
|
# Refer to https://github.com/luarocks/luarocks/wiki/Config-file-format for specs
|
|
, luarocksConfig ? {}
|
|
|
|
# relative to srcRoot, path to the rockspec to use when using rocks
|
|
, rockspecFilename ? null
|
|
|
|
# must be set for packages that don't have a rock
|
|
, knownRockspec ? null
|
|
|
|
, ... } @ attrs:
|
|
|
|
|
|
# Keep extra attributes from `attrs`, e.g., `patchPhase', etc.
|
|
|
|
let
|
|
|
|
# TODO fix warnings "Couldn't load rockspec for ..." during manifest
|
|
# construction -- from initial investigation, appears it will require
|
|
# upstream luarocks changes to fix cleanly (during manifest construction,
|
|
# luarocks only looks for rockspecs in the default/system tree instead of all
|
|
# configured trees)
|
|
luarocks_config = "luarocks-config.lua";
|
|
|
|
luarocksDrv = luaLib.toLuaModule ( lua.stdenv.mkDerivation (self: attrs // {
|
|
|
|
name = namePrefix + self.pname + "-" + self.version;
|
|
inherit rockspecVersion;
|
|
|
|
__structuredAttrs = true;
|
|
env = {
|
|
LUAROCKS_CONFIG = self.configFile;
|
|
} // attrs.env or {};
|
|
|
|
generatedRockspecFilename = "./${self.pname}-${self.rockspecVersion}.rockspec";
|
|
|
|
nativeBuildInputs = [
|
|
lua # for lua.h
|
|
wrapLua
|
|
luarocks_bootstrap
|
|
];
|
|
|
|
inherit doCheck extraConfig rockspecFilename knownRockspec externalDeps nativeCheckInputs;
|
|
|
|
buildInputs = let
|
|
# example externalDeps': [ { name = "CRYPTO"; dep = pkgs.openssl; } ]
|
|
externalDeps' = lib.filter (dep: !lib.isDerivation dep) self.externalDeps;
|
|
in [ luarocks_bootstrap ]
|
|
++ buildInputs
|
|
++ lib.optionals self.doCheck ([ luarocksCheckHook ] ++ self.nativeCheckInputs)
|
|
++ (map (d: d.dep) externalDeps')
|
|
;
|
|
|
|
# propagate lua to active setup-hook in nix-shell
|
|
propagatedBuildInputs = propagatedBuildInputs ++ [ lua ];
|
|
|
|
# @-patterns do not capture formal argument default values, so we need to
|
|
# explicitly inherit this for it to be available as a shell variable in the
|
|
# builder
|
|
rocksSubdir = "${self.pname}-${self.version}-rocks";
|
|
|
|
configFile = writeTextFile {
|
|
name = self.pname + "-luarocks-config.lua";
|
|
text = self.luarocks_content;
|
|
};
|
|
|
|
luarocks_content =
|
|
(lib.generators.toLua { asBindings = true; } self.luarocksConfig) +
|
|
''
|
|
|
|
${self.extraConfig}
|
|
'';
|
|
|
|
# TODO make it the default variable
|
|
luarocksConfig = let
|
|
externalDepsGenerated = lib.filter (drv: !drv ? luaModule)
|
|
(self.nativeBuildInputs ++ self.propagatedBuildInputs ++ self.buildInputs);
|
|
|
|
generatedConfig = luaLib.generateLuarocksConfig {
|
|
externalDeps = lib.unique (self.externalDeps ++ externalDepsGenerated);
|
|
local_cache = "";
|
|
|
|
# To prevent collisions when creating environments, we install the rock
|
|
# files into per-package subdirectories
|
|
rocks_subdir = self.rocksSubdir;
|
|
|
|
# Filter out the lua derivation itself from the Lua module dependency
|
|
# closure, as it doesn't have a rock tree :)
|
|
# luaLib.hasLuaModule
|
|
requiredLuaRocks = lib.filter luaLib.hasLuaModule
|
|
(lua.pkgs.requiredLuaModules (self.nativeBuildInputs ++ self.propagatedBuildInputs));
|
|
};
|
|
|
|
luarocksConfig' = lib.recursiveUpdate luarocksConfig
|
|
(lib.optionalAttrs (attrs ? extraVariables) (lib.warn "extraVariables in buildLuarocksPackage is deprecated, use luarocksConfig instead"
|
|
{
|
|
variables = attrs.extraVariables;
|
|
}))
|
|
;
|
|
in lib.recursiveUpdate generatedConfig luarocksConfig';
|
|
|
|
|
|
configurePhase = ''
|
|
runHook preConfigure
|
|
''
|
|
+ lib.optionalString (self.rockspecFilename == null) ''
|
|
rockspecFilename="${self.generatedRockspecFilename}"
|
|
''
|
|
+ lib.optionalString (self.knownRockspec != null) ''
|
|
# prevents the following type of error:
|
|
# Inconsistency between rockspec filename (42fm1b3d7iv6fcbhgm9674as3jh6y2sh-luv-1.22.0-1.rockspec) and its contents (luv-1.22.0-1.rockspec)
|
|
rockspecFilename="$TMP/$(stripHash ${self.knownRockspec})"
|
|
cp ${self.knownRockspec} "$rockspecFilename"
|
|
''
|
|
+ ''
|
|
runHook postConfigure
|
|
'';
|
|
|
|
buildPhase = ''
|
|
runHook preBuild
|
|
|
|
source ${lua}/nix-support/utils.sh
|
|
nix_debug "Using LUAROCKS_CONFIG=$LUAROCKS_CONFIG"
|
|
|
|
LUAROCKS_EXTRA_ARGS=""
|
|
if (( ''${NIX_DEBUG:-0} >= 1 )); then
|
|
LUAROCKS_EXTRA_ARGS=" --verbose"
|
|
fi
|
|
|
|
runHook postBuild
|
|
'';
|
|
|
|
postFixup = lib.optionalString (!dontWrapLuaPrograms) ''
|
|
wrapLuaPrograms
|
|
'' + attrs.postFixup or "";
|
|
|
|
installPhase = ''
|
|
runHook preInstall
|
|
|
|
# work around failing luarocks test for Write access
|
|
mkdir -p $out
|
|
|
|
# luarocks make assumes sources are available in cwd
|
|
# After the build is complete, it also installs the rock.
|
|
# If no argument is given, it looks for a rockspec in the current directory
|
|
# but some packages have several rockspecs in their source directory so
|
|
# we force the use of the upper level since it is
|
|
# the sole rockspec in that folder
|
|
# maybe we could reestablish dependency checking via passing --rock-trees
|
|
|
|
nix_debug "ROCKSPEC $rockspecFilename"
|
|
luarocks $LUAROCKS_EXTRA_ARGS make --deps-mode=all --tree=$out ''${rockspecFilename}
|
|
|
|
runHook postInstall
|
|
'';
|
|
|
|
checkPhase = ''
|
|
runHook preCheck
|
|
luarocks test
|
|
runHook postCheck
|
|
'';
|
|
|
|
shellHook = ''
|
|
runHook preShell
|
|
export LUAROCKS_CONFIG="$PWD/${luarocks_config}";
|
|
runHook postShell
|
|
'';
|
|
|
|
passthru = {
|
|
inherit lua;
|
|
} // attrs.passthru or { };
|
|
|
|
meta = {
|
|
platforms = lua.meta.platforms;
|
|
# add extra maintainer(s) to every package
|
|
maintainers = (attrs.meta.maintainers or []) ++ [ ];
|
|
broken = disabled;
|
|
} // attrs.meta or {};
|
|
}));
|
|
in
|
|
luarocksDrv
|