@joshski/dust 0.1.8 → 0.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -75,7 +75,7 @@ In fact, you might find it effective to use that as the _only_ line in those fil
75
75
 
76
76
  ## Configuration
77
77
 
78
- Configure hooks into your tools in `./.dust/config/settings.json` e.g.
78
+ Configure dust in `./.dust/config/settings.json` e.g.
79
79
 
80
80
  ```json
81
81
  {
@@ -91,4 +91,39 @@ Configure hooks into your tools in `./.dust/config/settings.json` e.g.
91
91
 
92
92
  The `dust check` command will run all of the configured checks in parallel and produce a very terse (context window-friendly) output unless one or more of the checks fail.
93
93
 
94
+ ### Check Failure Hints
95
+
96
+ Add optional `hints` to help agents recover from check failures:
97
+
98
+ ```json
99
+ {
100
+ "checks": [
101
+ {
102
+ "name": "build",
103
+ "command": "npm run build",
104
+ "hints": [
105
+ "Run `npm install` if this is a fresh checkout",
106
+ "Check for TypeScript errors in the files you modified"
107
+ ]
108
+ }
109
+ ]
110
+ }
111
+ ```
112
+
113
+ When a check fails, hints are displayed after the error output:
114
+
115
+ ```
116
+ ✓ validate
117
+ ✗ build
118
+
119
+ > npm run build
120
+ error TS2307: Cannot find module 'lodash'...
121
+
122
+ Hints for fixing 'build':
123
+ - Run `npm install` if this is a fresh checkout
124
+ - Check for TypeScript errors in the files you modified
125
+
126
+ 1/2 checks passed
127
+ ```
128
+
94
129
  Agents are instructed to run `dust check` before and after any changes, as a way of keeping them on track. It's more important that these commands are comprehensive, than they are fast.