docs: clarify LinterStep

Fixes #60

Author: jdx

docs/configuration.md

@@ -14,9 +14,9 @@ Here's a basic `hk.pkl` file:
 amends "package://github.com/jdx/hk/releases/download/v0.7.0/hk@0.7.0#/Config.pkl"
 import "package://github.com/jdx/hk/releases/download/v0.7.0/hk@0.7.0#/builtins.pkl"
 
-local linters = new {
+local linters = new Mapping<String, Step> {
     // linters can be manually defined
-    ["eslint"] {
+    ["eslint"] = new LinterStep {
         // the files to run the linter on, if no files are matched, the linter will be skipped
         // this will filter the staged files and return the subset matching these globs
         glob = List("*.js", "*.ts")
@@ -100,7 +100,7 @@ A command to run that modifies files. This typically is a "fix" command like `es
 
 ```pkl
 local linters = new Mapping<String, Step> {
-    ["prettier"] {
+    ["prettier"] = new LinterStep {
         fix = "prettier --write {{files}}"
     }
 }
@@ -122,7 +122,7 @@ If true, hk will run the linter on batches of files instead of all files at once
 
 ```pkl
 local linters = new Mapping<String, Step> {
-    ["eslint"] {
+    ["eslint"] = new LinterStep {
         batch = true
     }
 }
@@ -140,7 +140,7 @@ If set, run the linter on workspaces only which are parent directories containin
 
 ```pkl
 local linters = new Mapping<String, Step> {
-    ["cargo-clippy"] {
+    ["cargo-clippy"] = new LinterStep {
         workspace_indicator = "Cargo.toml"
     }
 }
@@ -152,7 +152,7 @@ If set, run the linter scripts with this prefix, e.g.: "mise exec --" or "npm ru
 
 ```pkl
 local linters = new Mapping<String, Step> {
-    ["eslint"] {
+    ["eslint"] = new LinterStep {
         prefix = "npm run"
     }
 }
@@ -199,8 +199,10 @@ A list of steps that must finish before this step can run.
 ```pkl
 hooks {
     ["pre-commit"] {
-        ["prettier"] {
-            depends = List("eslint")
+        steps = new Mapping<String, Step> {
+            ["prettier"] = new LinterStep {
+                depends = List("eslint")
+            }
         }
     }
 }
@@ -225,8 +227,10 @@ A list of steps that must finish before this step can run.
 ```pkl
 hooks {
     ["pre-commit"] {
-        ["prettier"] {
-            depends = List("eslint")
+        steps = new Mapping<String, Step> {
+            ["prettier"] = new LinterStep {
+                depends = List("eslint")
+            }
         }
     }
 }
@@ -239,8 +243,10 @@ A list of globs of files to add to the git index after running a fix step.
 ```pkl
 hooks {
     ["pre-commit"] {
-        ["prettier"] {
-            stage = List("*.js", "*.ts")
+        steps = new Mapping<String, Step> {
+            ["prettier"] {
+                stage = List("*.js", "*.ts")
+            }
         }
     }
 }
@@ -257,14 +263,16 @@ If true, this step will wait for any previous steps to finish before running. No
 ```pkl
 hooks {
     ["pre-commit"] {
-        ["prelint"] {
-            exclusive = true // blocks other steps from starting until this one finishes
-            run = "mise run prelint"
-        }
-        // ... other steps will run in parallel ...
-        ["postlint"] {
-            exclusive = true // wait for all previous steps to finish before starting
-            run = "mise run postlint"
+        steps = new Mapping<String, Step> {
+            ["prelint"] {
+                exclusive = true // blocks other steps from starting until this one finishes
+                run = "mise run prelint"
+            }
+            // ... other steps will run in parallel ...
+            ["postlint"] {
+                exclusive = true // wait for all previous steps to finish before starting
+                run = "mise run postlint"
+            }
         }
     }
 }

docs/getting_started.md

@@ -50,7 +50,7 @@ import "package://github.com/jdx/hk/releases/download/v0.7.0/hk@0.7.0#/builtins.
 
 local linters = new Mapping<String, Step> {
     // linters can be manually defined
-    ["eslint"] {
+    ["eslint"] = new LinterStep {
         // the files to run the linter on, if no files are matched, the linter will be skipped
         // this will filter the staged files and return the subset matching these globs
         glob = new { "*.js"; "*.ts" }
@@ -67,7 +67,9 @@ local linters = new Mapping<String, Step> {
 
 hooks {
     ["pre-commit"] {
-        ["fix"] = new Fix {}
+        steps = new Mapping<String, Step> {
+            ["fix"] = new Fix {}
+        }
     }
 }
 ```

hk-example.pkl

@@ -1,11 +1,11 @@
 amends "package://github.com/jdx/hk/releases/download/v0.7.0/hk@0.7.0#/Config.pkl"
 import "package://github.com/jdx/hk/releases/download/v0.7.0/hk@0.7.0#/builtins.pkl"
 
-local linters = {
+local linters = new Mapping<String, Step> {
     // some linters are built into hk
-    ["actionlint"] = new actionlint.Actionlint {}
+    ["actionlint"] = builtins.actionlint
     // linters can be manually defined
-    ["eslint"] {
+    ["eslint"] = new LinterStep {
         // the files to run the hook on, if no files are matched, the hook will be skipped
         // this will filter the staged files and return the subset matching these globs
         glob = List("*.js", "*.ts")
@@ -25,19 +25,19 @@ local linters = {
         batch = true
     }
     // linters can start from a builtin linter and be customized
-    ["prettier"] = new prettier.Prettier {
+    ["prettier"] = (builtins.prettier) {
         // providing a "check_list_files" command will be used to help the "check_first" method work more efficiently
         // rather than running fix against all the files that were checked, it only runs fix against the files returned by this command
         check_list_files = "prettier --list-different {{files}}"
     }
-    ["clippy"] {
+    ["clippy"] = new LinterStep {
         // this linter works on directories instead of individual files.
         // This tells hk what filename to look for to know if a directory is a workspace.
         workspace_indicator = "Cargo.toml"
         check = "cargo clippy --manifest-path {{workspace_indicator}}"
         fix = "cargo clippy --manifest-path {{workspace_indicator}} --fix --allow-dirty --allow-staged"
     }
-    ["gomod_tidy"] {
+    ["gomod_tidy"] = new LinterStep {
         workspace_indicator = "go.mod"
         // assists "check_first" method because this will return a patch to stdout that hk can simply apply
         // without needing to actually run a "fix" step

hk.pkl

@@ -3,7 +3,7 @@ amends "pkl/Config.pkl"
 import "pkl/builtins.pkl"
 
 // defines what happens during git pre-commit hook
-local linters = new Mapping<String, LinterStep> {
+local linters = new Mapping<String, Step> {
     ["actionlint"] = builtins.actionlint
     // TODO: fails on releases with hk-example.pkl
     //["pkl"] {
@@ -16,7 +16,7 @@ local linters = new Mapping<String, LinterStep> {
          check = "cargo clippy --manifest-path {{workspace_indicator}} -- -D warnings"
      }
      ["cargo-fmt"] = builtins.cargo_fmt
-     ["dbg"] {
+     ["dbg"] = new LinterStep {
          // ensure no dbg! macros are used
          glob = List("**/*.rs")
          check = "sleep 1.5; ! rg -e 'dbg!' {{files}}"

src/cli/init.rs

@@ -23,12 +23,12 @@ impl Init {
 amends "package://github.com/jdx/hk/releases/download/v0.7.0/hk@0.7.0#/Config.pkl"
 import "package://github.com/jdx/hk/releases/download/v0.7.0/hk@0.7.0#/builtins.pkl"
 
-local linters = new Mapping<String, LinterStep> {
+local linters = new Mapping<String, Step> {
     // uses builtin prettier linter config
     ["prettier"] = builtins.prettier
 
     // uses custom pkl linter config
-    ["pkl"] {
+    ["pkl"] = new LinterStep {
         glob = List("*.pkl")
         check = "pkl eval {{files}} >/dev/null"
     }