Merge pull request #3 from iancleary/feat/linting

Add devShells and formatter

Author: iancleary

.yamllint.yaml

@@ -0,0 +1,6 @@
+---
+extends: default
+rules:
+  line-length:
+    max: 80
+    level: warning

flake.nix

@@ -10,31 +10,39 @@
     };
   };
 
-  outputs = inputs @ { self
+  outputs =
+    inputs @ { self
     , nixpkgs
     , nixpkgs-unstable
     , neovim-plugins
-  }:
-  let
-    overlays = {
-      unstable = final: prev: {
-        unstable = nixpkgs-unstable.legacyPackages.${prev.system};
-        inherit (nixpkgs-unstable.legacyPackages.${prev.system}) neovim-unwrapped;
+    }:
+    let
+      forAllSystems = nixpkgs.lib.genAttrs [ "aarch64-linux" "x86_64-linux" ];
+      overlays = {
+        unstable = final: prev: {
+          unstable = nixpkgs-unstable.legacyPackages.${prev.system};
+          inherit (nixpkgs-unstable.legacyPackages.${prev.system}) neovim-unwrapped;
+        };
+        neovimPlugins = neovim-plugins.overlays.default;
       };
-      neovimPlugins = neovim-plugins.overlays.default;
-    };
 
-    legacyPackages = builtins.currentSystem (system:
-      import inputs.nixpkgs {
+      legacyPackages = builtins.currentSystem (system:
+        import inputs.nixpkgs {
           inherit system;
           overlays = builtins.attrValues overlays;
           config.allowUnfree = true;
         }
-    );
-in
-  {
-    overlays.default = neovim-plugins.overlays.default; # pass through the neovim-plugins overlay
-    homeManagerModules.default = import ./default.nix;
-    homeManagerModules.home-manager = import ./default.nix;
-  };
+      );
+    in
+    {
+      overlays.default = neovim-plugins.overlays.default; # pass through the neovim-plugins overlay
+      homeManagerModules.default = import ./default.nix;
+      homeManagerModules.home-manager = import ./default.nix;
+
+      devShells = forAllSystems (system: {
+        lint = nixpkgs.legacyPackages.${system}.callPackage ./shells/lint.nix { };
+      });
+
+      formatter = forAllSystems (system: nixpkgs.legacyPackages."${system}".nixpkgs-fmt);
+    };
 }

justfile

@@ -0,0 +1,28 @@
+# list recipes
+help:
+  just --list
+
+# Update the flake lock file
+update:
+  nix flake update
+
+# Lint all files (similar to GitHub Actions), setup nix-shell
+lint:
+  nix develop --accept-flake-config .#lint
+
+# format all the files, when in a nix-shell
+format:
+  nixpkgs-fmt .
+
+# check all files (similar to GitHub Actions), when in a nix-shell
+check:
+  actionlint
+  yamllint .
+  selene .
+  stylua --check .
+  statix check
+  nixpkgs-fmt --check .
+
+# Check flake evaluation
+flake:
+  nix flake check --no-build --all-systems

selene.toml

@@ -0,0 +1,3 @@
+[rules]
+undefined_variable = "allow"
+unscoped_variables = "allow"

shells/lint.nix

@@ -0,0 +1,12 @@
+{ pkgs, ... }:
+
+pkgs.mkShellNoCC {
+  nativeBuildInputs = with pkgs; [
+    actionlint
+    selene
+    stylua
+    statix
+    nixpkgs-fmt
+    yamllint
+  ];
+}