treefmt-nix/programs/shfmt.nix at main · numtide/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
65
66
67
68
69
70
{
  config,
  lib,
  mkFormatterModule,
  ...
}:
let
  cfg = config.programs.shfmt;
in
{
  meta.maintainers = [
    "zimbatm"
    "katexochen"
  ];
  meta.brokenPlatforms = [ "riscv64-linux" ];

  imports = [
    (mkFormatterModule {
      name = "shfmt";
      args = [ "-w" ];
      includes = [
        "*.sh"
        "*.bash"
        # direnv
        "*.envrc"
        "*.envrc.*"
      ];
    })
  ];

  options.programs.shfmt = {
    indent_size = lib.mkOption {
      type = lib.types.nullOr lib.types.int;
      default = if cfg.useEditorConfig then null else 2;
      example = 4;
      description = ''
        Sets the number of spaces to be used in indentation. Uses tabs if set to
        zero.
      '';
    };

    simplify = lib.mkOption {
      type = lib.types.bool;
      default = !cfg.useEditorConfig;
      description = ''
        Enables the `-s` (`--simplify`) flag, which simplifies code where possible.
      '';
    };

    useEditorConfig = lib.mkEnableOption ''
      Use .editorconfig file for
      formatting. This is mutually exlusive with all other settings. See [shfmt
      docs](https://github.com/mvdan/sh/blob/v3.12.0/cmd/shfmt/shfmt.1.scd?plain=1#L20-L21).
    '';
  };

  config = lib.mkIf cfg.enable {
    settings.formatter.shfmt.options =
      let
        options =
          (lib.optionals (!isNull cfg.indent_size) [
            "-i"
            (toString cfg.indent_size)
          ])
          ++ (lib.optionals (cfg.simplify) [ "-s" ]);
      in
      assert cfg.useEditorConfig -> builtins.length options == 0;
      options;
  };
}