1
0
mirror of https://github.com/nix-community/home-manager synced 2024-06-30 18:38:31 +02:00
home-manager/modules/programs/sqls.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

49 lines
1.0 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.sqls;
yamlFormat = pkgs.formats.yaml { };
in {
meta.maintainers = [ ];
options.programs.sqls = {
enable =
mkEnableOption (lib.mdDoc "sqls, a SQL language server written in Go");
settings = mkOption {
type = yamlFormat.type;
default = { };
example = literalExpression ''
{
lowercaseKeywords = true;
connections = [
{
driver = "mysql";
dataSourceName = "root:root@tcp(127.0.0.1:13306)/world";
}
];
}
'';
description = lib.mdDoc ''
Configuration written to
{file}`$XDG_CONFIG_HOME/sqls/config.yml`. See
<https://github.com/lighttiger2505/sqls#db-configuration>
for supported values.
'';
};
};
config = mkIf cfg.enable {
home.packages = [ pkgs.sqls ];
xdg.configFile."sqls/config.yml" = mkIf (cfg.settings != { }) {
source = yamlFormat.generate "sqls-config" cfg.settings;
};
};
}