home-manager/modules/programs/sbt.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

203 lines
5.7 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
renderPlugin = plugin: ''
addSbtPlugin("${plugin.org}" % "${plugin.artifact}" % "${plugin.version}")
'';
renderCredential = idx: cred:
let symbol = "credential_${toString idx}";
in ''
lazy val ${symbol} = "${cred.passwordCommand}".!!.trim
credentials += Credentials("${cred.realm}", "${cred.host}", "${cred.user}", ${symbol})
'';
renderCredentials = creds: ''
import scala.sys.process._
${concatStrings (imap0 renderCredential creds)}'';
renderRepository = value:
if isString value then ''
${value}
'' else ''
${concatStrings (mapAttrsToList (name: value: "${name}: ${value}") value)}
'';
renderRepositories = repos: ''
[repositories]
${concatStrings (map renderRepository cfg.repositories)}'';
sbtTypes = {
plugin = types.submodule {
options = {
org = mkOption {
type = types.str;
description =
lib.mdDoc "The organization the artifact is published under.";
};
artifact = mkOption {
type = types.str;
description = lib.mdDoc "The name of the artifact.";
};
version = mkOption {
type = types.str;
description = lib.mdDoc "The version of the plugin.";
};
};
};
credential = types.submodule {
options = {
realm = mkOption {
type = types.str;
description =
lib.mdDoc "The realm of the repository you're authenticating to.";
};
host = mkOption {
type = types.str;
description = lib.mdDoc
"The hostname of the repository you're authenticating to.";
};
user = mkOption {
type = types.str;
description = lib.mdDoc "The user you're using to authenticate.";
};
passwordCommand = mkOption {
type = types.str;
description = lib.mdDoc ''
The command that provides the password or authentication token for
the repository.
'';
};
};
};
};
cfg = config.programs.sbt;
in {
imports = [
(mkRemovedOptionModule [ "programs" "sbt" "baseConfigPath" ]
"Use programs.sbt.baseUserConfigPath instead, but note that the semantics are slightly different.")
];
meta.maintainers = [ maintainers.kubukoz ];
options.programs.sbt = {
enable = mkEnableOption (lib.mdDoc "sbt");
package = mkOption {
type = types.package;
default = pkgs.sbt;
defaultText = literalExpression "pkgs.sbt";
description = lib.mdDoc "The package with sbt to be installed.";
};
baseUserConfigPath = mkOption {
type = types.str;
default = ".sbt";
description = lib.mdDoc ''
Where the sbt configuration files should be located, relative
{env}`HOME`.
'';
};
plugins = mkOption {
type = types.listOf (sbtTypes.plugin);
default = [ ];
example = literalExpression ''
[
{
org = "net.virtual-void";
artifact = "sbt-dependency-graph";
version = "0.10.0-RC1";
}
{
org = "com.dwijnand";
artifact = "sbt-project-graph";
version = "0.4.0";
}
]
'';
description = lib.mdDoc ''
A list of plugins to place in the sbt configuration directory.
'';
};
credentials = mkOption {
type = types.listOf (sbtTypes.credential);
default = [ ];
example = literalExpression ''
[{
realm = "Sonatype Nexus Repository Manager";
host = "example.com";
user = "user";
passwordCommand = "pass show sbt/user@example.com";
}]
'';
description = lib.mdDoc ''
A list of credentials to define in the sbt configuration directory.
'';
};
repositories = mkOption {
type = with types;
listOf
(either (enum [ "local" "maven-central" "maven-local" ]) (attrsOf str));
default = [ ];
example = literalExpression ''
[
"local"
{ my-ivy-proxy-releases = "http://repo.company.com/ivy-releases/, [organization]/[module]/(scala_[scalaVersion]/)(sbt_[sbtVersion]/)[revision]/[type]s/[artifact](-[classifier]).[ext]" }
{ my-maven-proxy-releases = "http://repo.company.com/maven-releases/" }
"maven-central"
]
'';
description = lib.mdDoc ''
A list of repositories to use when resolving dependencies. Defined as a
list of pre-defined repository or custom repository as a set of name to
URL. The list will be used populate the `~/.sbt/repositories`
file in the order specified.
Pre-defined repositories must be one of `local`,
`maven-local`, `maven-central`.
Custom repositories are defined as
`{ name-of-repo = "https://url.to.repo.com"}`.
See
<https://www.scala-sbt.org/1.x/docs/Launcher-Configuration.html#3.+Repositories+Section>
about this configuration section and
<https://www.scala-sbt.org/1.x/docs/Proxy-Repositories.html>
to read about proxy repositories.
'';
};
};
config = mkIf cfg.enable (mkMerge [
{ home.packages = [ cfg.package ]; }
(mkIf (cfg.plugins != [ ]) {
home.file."${cfg.baseUserConfigPath}/1.0/plugins/plugins.sbt".text =
concatStrings (map renderPlugin cfg.plugins);
})
(mkIf (cfg.credentials != [ ]) {
home.file."${cfg.baseUserConfigPath}/1.0/credentials.sbt".text =
renderCredentials cfg.credentials;
})
(mkIf (cfg.repositories != [ ]) {
home.file."${cfg.baseUserConfigPath}/repositories".text =
renderRepositories cfg.repositories;
})
]);
}