treefmt-nix/programs/sql-formatter.nix at main · adam-gaia/treefmt-nix · GitHub

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
{
  pkgs,
  lib,
  config,
  mkFormatterModule,
  ...
}:
let
  cfg = config.programs.sql-formatter;

  dialects = [
    "bigquery"
    "db2"
    "db2i"
    "hive"
    "mariadb"
    "mysql"
    "n1ql"
    "plsql"
    "postgresql"
    "redshift"
    "spark"
    "sqlite"
    "sql"
    "tidb"
    "trino"
    "transactsql"
    "tsql"
    "singlestoredb"
    "snowflake"
  ];
in
{
  imports = [
    (mkFormatterModule {
      name = "sql-formatter";
      package = "sql-formatter";
      includes = [ "*.sql" ];
    })
  ];

  options.programs.sql-formatter = {
    dialect = lib.mkOption {
      description = "The sql dialect to use for formatting";
      type = with lib.types; nullOr (enum dialects);
      default = null;
      example = "postgresql";
    };
  };

  config = lib.mkIf cfg.enable {
    settings.formatter.sql-formatter = {
      # sql-formatter doesn't support multiple file targets
      # see https://github.com/sql-formatter-org/sql-formatter/issues/552
      command = pkgs.writeShellScriptBin "sql-formatter-fix" ''
        for file in "$@"; do
          ${cfg.package}/bin/sql-formatter --fix ${
            lib.optionalString (cfg.dialect != null) "-l ${cfg.dialect}"
          } $file
        done
      '';
    };
  };
}