version: bump 1.2.1 -> 1.2.2

packaging: properly package for nixos

.codespellrc

@@ -1,2 +1,2 @@
 [codespell]
-skip = ./assets/pkg/aur/*/src,./assets/pkg/aur/*/*/objects
+skip = ./assets/pkg/aur/*/src,./assets/pkg/aur/*/*/objects,./assets/pkg/aur/*/*.tar.*

.github/workflows/make-release.yml

@@ -16,6 +16,8 @@ jobs:
           packages: "git"
           version: 1.0
       - uses: actions/checkout@v4
+        with:
+          fetch-tags: true
 
       - name: Check Version Changed
         id: check-ver-changed
@@ -27,6 +29,7 @@ jobs:
             echo "ERR: Git tag matches makefile, did you bump Makefile up?" >&2
             exit 1
           fi
+
           echo "VERSION=$MAKE_TAG" >> "$GITHUB_OUTPUT"
 
 
@@ -70,7 +73,6 @@ jobs:
     needs: [ release-checks, release ]
     steps:
       - run: pacman -Sy --noconfirm git github-cli base-devel pacman-contrib
-
       - uses: actions/checkout@v4
 
       - run: |
@@ -96,3 +98,37 @@ jobs:
             --body "*This PR was created automatically*"
         env:
           GH_TOKEN: ${{ github.token }}
+
+  nix-update:
+    name: Update NixOS module
+    runs-on: ubuntu-24.04
+    permissions: write-all
+    needs: [ release-checks, release ]
+    steps:
+      - uses: cachix/install-nix-action@v31
+      - uses: actions/checkout@v4
+        with:
+          fetch-tags: true
+
+      - run: |
+          tmpdir=$(mktemp -d)
+          git archive v${{ needs.release-checks.outputs.VERSION }} | tar -xC "$tmpdir"
+          sha256sum=$(nix hash path "$tmpdir")
+
+          sed -i -E 's/(.*version\s*=\s*")[0-9.]*(".*)/\1'${{ needs.release-checks.outputs.VERSION }}'\2/' assets/pkg/nix/module.nix
+          sed -i -E 's/(.*sha256\s*=\s*")[^"]*(".*)/\1'"$sha256sum"'\2/' assets/pkg/nix/module.nix
+        # would be cool to be able to check the new module.nix builds
+
+      - run: |
+          BRANCH=actions/update-nix-${{ needs.release-checks.outputs.VERSION }}
+          git config --global --add safe.directory $GITHUB_WORKSPACE
+          git config user.name "GitHub Actions"
+          git config user.email "actions@github.com"
+          git checkout -b $BRANCH
+          git commit -am "Update NixOS module to v${{ needs.release-checks.outputs.VERSION }}"
+          git push -u origin $BRANCH
+          gh pr create --head $BRANCH \
+            --title "[Nix update]: Bump to ${{ needs.release-checks.outputs.VERSION }}" \
+            --body "*This PR was created automatically*"
+        env:
+          GH_TOKEN: ${{ github.token }}

.github/workflows/push.yml

@@ -12,7 +12,24 @@ jobs:
     name: Check
     uses: ./.github/workflows/check.yml
     permissions: write-all
+  check_paths:
+    name: Paths Filter
+    runs-on: ubuntu-latest
+    outputs:
+      code_changed: ${{ steps.filter.outputs.code }}
+    steps:
+      - uses: actions/checkout@v4
+      - id: filter
+        uses: dorny/paths-filter@v3
+        with:
+          filters: |
+            code:
+              - Makefile
+              - 'src/**'
+              - 'include/**'
   build:
     name: Build
+    needs: check_paths
+    if: github.event_name != 'push' || needs.check_paths.outputs.code_changed == 'true'
     uses: ./.github/workflows/build.yml
     permissions: write-all

INSTALL.md

@@ -4,6 +4,7 @@
 - [Installing from Source](#installing-from-source)
 - [AUR](#aur)
 - [Nix Flake](#nix-flake)
+- [Nix Module](#nix-module)
 
 > [!CAUTION]
 > I encourage you to read the manual installation steps to understand what will get installed in your computer by this package.
@@ -73,3 +74,57 @@ nix run github:javalsai/lidm
 
 > [!CAUTION]
 > This doesn't include [service files](./assets/pkg/aur#services) neither
+
+# Nix Module
+
+<details>
+<summary>Sidenote</summary>
+
+The nix module lacks on several aspects, if you know much about nix and know
+how to improve this package, feel free to open an issue or a PR to help. The
+nix package maintainer position is open too.
+
+</details>
+
+Lidm includes a nix module in `assets/pkg/nix/module.nix` that you can add
+(along the included nix files) and import in your `configuration.nix`.
+
+Once imported you'll need to add:
+
+```nix
+services.displayManager.enable = true;
+systemd.services.lidm.enable = true;
+```
+
+Optionally, you can configure it setting `services.lidm.config`. You can either
+pass:
+
+* A string to copy the config from a theme in `themes/` with said name
+  (**name**, e.g `"cherry"`).
+* An attribute tree with the same names as the config file, e.g:
+
+```nix
+with config.lidm.keysEnum; {
+    strings = {
+        f_poweroff = "custom_poweroff";
+    };
+
+    behavior = {
+        include_defshell = true;
+        source = [
+            "path1"
+            "path2"
+        ];
+    };
+
+    functions = { poweroff = F1; };
+
+    # etc...
+};
+```
+
+> *it's not necessary to cover all keys and anything can be put there, even if
+> its not valid config*
+
+> [!NOTE]
+> [service files](./assets/pkg/aur#services) **are** included and enabled

Makefile

@@ -1,4 +1,4 @@
-VERSION = 1.2.1
+VERSION = 1.2.2
 .DEFAULT_GOAL := lidm
 
 CDIR=src

assets/pkg/nix/get-cfg-file.nix

@@ -0,0 +1,23 @@
+{
+  cfg,
+  src,
+  lib,
+  ...
+}:
+let
+  maker = import ./make-cfg.nix {
+    inherit lib;
+    keys-h-file = builtins.readFile "${src}/include/keys.h";
+  };
+in
+{
+  inherit maker;
+  file = builtins.toFile "lidm.conf" (
+    if builtins.isString cfg then
+      builtins.readFile "${src}/themes/${cfg}.ini"
+    else if builtins.isAttrs cfg then
+      maker.make cfg
+    else
+      builtins.throw "invalid cfg type, expected str or attrs"
+  );
+}

assets/pkg/nix/lidm.nix

@@ -1,24 +1,50 @@
-{ config, pkgs, lib, ...}: pkgs.stdenv.mkDerivation rec {
+{
-    pname = "lidm";
+  config,
-    version = config.version;
+  pkgs,
-    src = config.src;
+  lib,
+  ...
+}:
+let
+  get-cfg =
+    if config.cfg != null then
+      import ./get-cfg-file.nix {
+        inherit lib;
+        inherit (config) cfg src;
+      }
+    else
+      null;
+  cfg-file = get-cfg.file;
+  maker = get-cfg.maker;
+in
+pkgs.stdenv.mkDerivation rec {
+  pname = "lidm";
+  version = config.version;
+  src = config.src;
 
-    nativeBuildInputs = with pkgs; [
+  nativeBuildInputs = with pkgs; [
-        gcc
+    gcc
-        gnumake
+    gnumake
-        linux-pam
+    linux-pam
-    ];
+  ];
 
-    makeFlags = [
+  makeFlags =
-        "DESTDIR=$(out)"
+    [
-        "PREFIX="
+      "DESTDIR=$(out)"
+      "PREFIX="
     ]
-    ++ lib.optional (config.xsessions != null)
+    ++ lib.optional (
-        "CPPFLAGS+=-DSESSIONS_XSESSIONS=\\\"${config.xsessions}\\\""
+      config.xsessions != null
-    ++ lib.optional (config.wayland-sessions != null)
+    ) "CPPFLAGS+=-DSESSIONS_XSESSIONS=\\\"${config.xsessions}\\\""
-        "CPPFLAGS+=-DSESSIONS_WAYLAND=\\\"${config.wayland-sessions}\\\"";
+    ++ lib.optional (
+      config.wayland-sessions != null
+    ) "CPPFLAGS+=-DSESSIONS_WAYLAND=\\\"${config.wayland-sessions}\\\""
+    ++ lib.optional (cfg-file != null) "CPPFLAGS+=-DLIDM_CONF_PATH=\\\"${cfg-file}\\\"";
 
-    fixupPhase = ''
+  fixupPhase = ''
-        rm -rf $out/etc
+    rm -rf $out/etc
-    '';
+  '';
+
+  passthru = {
+    keysEnum = maker.keys-enum;
+  };
 }

assets/pkg/nix/make-cfg.nix

@@ -0,0 +1,73 @@
+{ lib, keys-h-file }:
+
+let
+  double-match-to-nameval = dmatch: {
+    name = builtins.elemAt dmatch 0;
+    value = builtins.elemAt dmatch 1;
+  };
+
+  keys-enum =
+    let
+      key-names = builtins.replaceStrings [ "\n" " " ] [ "" "" ] (
+        builtins.elemAt (builtins.match ".*KEY_NAMES\\[][[:blank:]]*=[[:blank:]]*\\{([^}]*)}.*" keys-h-file) 0
+      );
+
+      keys-2d-list = builtins.map (builtins.match "\\[(.*)]=\"(.*)\"") (
+        builtins.filter (s: builtins.isString s && s != "") (builtins.split "," key-names)
+      );
+
+    in
+    builtins.listToAttrs (
+      builtins.map (
+        k:
+        k
+        // {
+          value = {
+            __enum_key = k.value;
+          };
+        }
+      ) (builtins.map double-match-to-nameval keys-2d-list)
+    );
+in
+{
+  inherit keys-enum;
+  make =
+    let
+      name-val-to-attrs = (name: value: { inherit name value; });
+      map-attrs = attrset: fn: lib.map fn (lib.attrsets.mapAttrsToList name-val-to-attrs attrset);
+
+      try-foldl' =
+        op: nul: list:
+        if (builtins.length list) == 0 then "" else builtins.foldl' op nul list;
+      concat-with = sepr: list: try-foldl' (x: y: if x == null then y else x + sepr + y) null list;
+
+      ser-bool = bool: if bool then "true" else "false";
+      ser-str = str: "\"${builtins.replaceStrings [ "\n" "\"" ] [ "\\n" "\\\"" ] str}\"";
+      ser-kvs =
+        { name, value }:
+        if builtins.isList value then
+          concat-with "\n" (builtins.map (value: ser-kvs { inherit name value; }) value)
+        else
+          "${name} = ${
+            if builtins.isString value then
+              ser-str value
+            else if builtins.isInt value then
+              builtins.toString value
+            else if builtins.isBool value then
+              ser-bool value
+            else if builtins.isAttrs value then
+              value.__enum_key
+            else
+              builtins.throw "type not supported"
+          }";
+
+      ser-table =
+        table':
+        let
+          tname = table'.name;
+          table = table'.value;
+        in
+        "[${tname}]\n" + (concat-with "\n" (map-attrs table ser-kvs));
+    in
+    cfg: concat-with "\n\n" (map-attrs cfg ser-table);
+}

assets/pkg/nix/module.nix

@@ -1,47 +1,73 @@
-{ config, lib, pkgs, ... }:
+{
+  config,
+  lib,
+  pkgs,
+  ...
+}:
 
 let
-    dmcfg = config.services.displayManager;
+  cfg = config.services.lidm;
-    desktops = dmcfg.sessionData.desktops;
 
-    version = "1.2.1";
+  dmcfg = config.services.displayManager;
-    lidmPkg = pkgs.callPackage ./lidm.nix {
+  desktops = dmcfg.sessionData.desktops;
-        inherit pkgs;
-        config = {
-            inherit version lib;
-            src = pkgs.fetchFromGitHub {
-              owner = "javalsai";
-              repo = "lidm";
-              rev = "v${version}";
-              sha256 = "sha256-3CgUI8PUs4c1bfBrykPw87SSa4lzrh4E4Hug7cGRKFk=";
-            };
 
-            xsessions = "${desktops}/share/xsessions";
+  version = "1.2.2";
-            wayland-sessions = "${desktops}/share/wayland-sessions";
+  lidmPkg = pkgs.callPackage ./lidm.nix {
-        };
+    inherit pkgs;
+    config = {
+      inherit version lib;
+      cfg = cfg.config;
+      src = pkgs.fetchFromGitHub {
+        owner = "javalsai";
+        repo = "lidm";
+        rev = "v${version}";
+        sha256 = "sha256-3CgUI8PUs4c1bfBrykPw87SSa4lzrh4E4Hug7cGRKFk=";
+      };
+
+      xsessions = "${desktops}/share/xsessions";
+      wayland-sessions = "${desktops}/share/wayland-sessions";
     };
+  };
 in
 {
-    config = {
+  options = {
-        services.displayManager.defaultSession = "lidm";
+    lidm.keysEnum = lib.mkOption {
-
+      type = with lib.types; attrs;
-        systemd.services.lidm = {
+      default = lidm.passthru.keysEnum;
-            description = "TUI display manager";
+      readOnly = true;
-            aliases = [ "display-manager.service" ];
+      description = "Keys enum constants";
-            after = [
-                "systemd-user-sessions.service"
-                "plymouth-quit-wait.service"
-            ];
-            serviceConfig = {
-                Type = "idle";
-                ExecStart = "${lidmPkg}/bin/lidm 7";
-                StandardInput = "tty";
-                StandardOutput = "tty";
-                StandardError = "tty";
-                TTYPath = "/dev/tty7";
-                TTYReset = "yes";
-                TTYVHangup = "yes";
-            };
-        };
     };
+    services.lidm.config = lib.mkOption {
+      type =
+        with lib.types;
+        oneOf [
+          str
+          attrs
+        ];
+      default = { };
+      description = "Config options for lidm | Either attr tree or name of bundled themes";
+    };
+  };
+  config = {
+    services.displayManager.defaultSession = "lidm";
+
+    systemd.services.lidm = {
+      description = "TUI display manager";
+      aliases = [ "display-manager.service" ];
+      after = [
+        "systemd-user-sessions.service"
+        "plymouth-quit-wait.service"
+      ];
+      serviceConfig = {
+        Type = "idle";
+        ExecStart = "${lidmPkg}/bin/lidm 7";
+        StandardInput = "tty";
+        StandardOutput = "tty";
+        StandardError = "tty";
+        TTYPath = "/dev/tty7";
+        TTYReset = "yes";
+        TTYVHangup = "yes";
+      };
+    };
+  };
 }

flake.lock

@@ -5,11 +5,11 @@
         "systems": "systems"
       },
       "locked": {
-        "lastModified": 1710146030,
+        "lastModified": 1731533236,
-        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
+        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
         "owner": "numtide",
         "repo": "flake-utils",
-        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
         "type": "github"
       },
       "original": {
@@ -20,11 +20,11 @@
     },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1724224976,
+        "lastModified": 1751637120,
-        "narHash": "sha256-Z/ELQhrSd7bMzTO8r7NZgi9g5emh+aRKoCdaAv5fiO0=",
+        "narHash": "sha256-xVNy/XopSfIG9c46nRmPaKfH1Gn/56vQ8++xWA8itO4=",
         "owner": "nixos",
         "repo": "nixpkgs",
-        "rev": "c374d94f1536013ca8e92341b540eba4c22f9c62",
+        "rev": "5c724ed1388e53cc231ed98330a60eb2f7be4be3",
         "type": "github"
       },
       "original": {

flake.nix

@@ -7,16 +7,18 @@
   };
 
   outputs =
-    { flake-utils, nixpkgs, ... }:
+    {
+      flake-utils,
+      nixpkgs,
+      self,
+    }:
     flake-utils.lib.eachDefaultSystem (
       system:
       let
         pkgs = import nixpkgs { inherit system; };
 
         name = "lidm";
-        version = builtins.elemAt (
+        version = builtins.elemAt (builtins.match "VERSION[[:blank:]]*=[[:space:]]*([^\n]*)\n.*" (builtins.readFile ./Makefile)) 0;
-          builtins.match "VERSION[[:blank:]]*=[[:space:]]*([^\n]*)\n.*" (builtins.readFile ./Makefile)
-        ) 0;
 
         lidm = pkgs.callPackage assets/pkg/nix/lidm.nix {
           inherit pkgs;
@@ -26,6 +28,8 @@
             src = ./.;
             xsessions = null;
             wayland-sessions = null;
+            cfg = null;
+            # cfg = "cherry";
           };
         };
       in
@@ -33,8 +37,10 @@
         defaultApp = flake-utils.lib.mkApp { drv = defaultPackage; };
         defaultPackage = lidm;
         devShell = pkgs.mkShell { buildInputs = lidm.nativeBuildInputs ++ [ pkgs.clang-tools ]; };
+        formatter = nixpkgs.legacyPackages.${system}.nixfmt-tree;
       }
-    ) // {
+    )
+    // {
       nixosModules.lidm = assets/pkg/nix/module.nix;
     };
 }

src/desktop.c

@@ -66,7 +66,8 @@ int read_desktop(FILE* fd, void* ctx,
       buf_start[eq_idx] = '\0'; // the equal
       key = trim_str(key);
       char* value = &buf_start[eq_idx + 1];
-      buf_start[read_size - 1] = '\0'; // the newline
+      if(buf_start[read_size - 1] == '\n')
+        buf_start[read_size - 1] = '\0';
       value = trim_str(value);
 
       // Callback