bend-lint 0.1.1 → 0.2.0

package/README.md

@@ -10,8 +10,8 @@ Install bend-lint in each project, never globally:
 bun add -D --trust bend-lint
 ```
 
-The install writes `bend-lint.json` and `bend-lint-rules/format.bend`, which turns on the formatter,
-and downloads Bend. Without `--trust`, Bun skips that: run `bunx bend-lint init`.
+The install writes a `bend-lint.json` that turns on the formatter, downloads Bend, and builds your
+rules. Without `--trust`, Bun skips that: run `bunx bend-lint init`, then `bunx bend-lint prepare`.
 
 > **Why per project:** a Bend limitation. Bend imports a file only by a relative path of plain names
 > (or from BendHub), so bend-lint can reach your rules only inside your project. bend-lint refuses
@@ -29,7 +29,7 @@ and says so on each run.
 
 ```sh
 bunx bend-lint [<file or glob>...] [--fix | --fix-dangerously] [--show-suppressed] [--json]
-               [--jobs <number or max>]
+               [--jobs <number or max>] [--overlays] [--report <file>]
 ```
 
 | Flag                | Does                                                                               |
@@ -39,16 +39,29 @@ bunx bend-lint [<file or glob>...] [--fix | --fix-dangerously] [--show-suppresse
 | `--show-suppressed` | also prints the findings that a directive covers                                   |
 | `--json`            | prints one JSON object on stdout, with every fix. The summary goes to stderr       |
 | `--jobs`            | how many files to lint at once: a number, or `max` (default: half the CPU threads) |
+| `--overlays`        | reads a JSON object of paths to texts on stdin, which stand for those files        |
+| `--report`          | writes a JSON report to the file: versions, backend, build, caches and timings     |
 
 - With no files, it lints the `.bend` files in the folder you run it in: those git lists (so none
   that `.gitignore` lists), and none in `node_modules` or a hidden folder.
 - Quote globs, and use `/` in paths.
+- With `--overlays`, the checker and the rules read each overlay in place of its file, also when a
+  file imports it, and the file need not be on disk; name such a file to lint it. An editor gives
+  its unsaved buffers so. It does not go with `--fix-dangerously`, which writes files on disk.
 - bend-lint builds your rules on its first run (about 40 s), and keeps the build until a rule or
-  Bend changes.
+  Bend changes. `bunx bend-lint prepare` builds them, and lints nothing: an editor runs it at start.
+  If each rule you turn on is one of bend-lint's own, from `bend-lint-rules`, the build holds all of
+  them, so you can turn them on and off without a new build.
 - A fix that touches an earlier fix's edits waits for the next run.
 - bend-lint runs at low priority: a long run slows down, not your computer.
 - bend-lint does not report Bend's own errors: `bend <file> --check-only` does. If Bend's check of a
   file fails, the rules that need its types do not run on it, and bend-lint names them on stderr.
+- With `--json`, a finding of one of bend-lint's own rules has `docs`: the link to its rule's file,
+  whose header explains it.
+- With `--json`, `skipped` gives each file that rules did not run on: its `path`, the `reason`
+  (`unloaded`, `unchecked` or `unentered`), the `rules`, the `entry` (for `unentered`), and the
+  `message` stderr gets. An error that ends the run prints `{"ok": false, "errors": [...]}` instead,
+  each error with its `message`, and the `path` of the file it is about, if one.
 - Exit code: 0 no errors (warnings do not count), 1 an error, 2 a usage or config error.
 - The downloaded Bend, builds and cached checks go to `~/.cache/bend-lint/`. You can delete it at
   any time.
@@ -115,7 +128,7 @@ A rule is a file in `bend-lint-rules/`. It imports bend-lint's rule API from Ben
 
 ```
 import Base
-import bend-lint-api@0.1.1.0/linter/lint.bend as Lint
+import bend-lint-api@0.2.0.0/linter/lint.bend as Lint
 
 def rule() -> Lint.Rule:
   ...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bend-lint",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Diagnostics for Bend 2 from rules outside the language: source text, and the checker's types",
   "license": "MIT",
   "bin": {
@@ -8,10 +8,10 @@
   },
   "type": "module",
   "engines": {
-    "bun": "1.4.3"
+    "bun": "1.4.4"
   },
-  "bendRelease": "bendlang/bend/v2.0.37",
-  "bendWindows": "MattCozendey/bend/8621b563d53ab015dad5af3b07e679643931d780",
+  "bendRelease": "bendlang/bend/v2.0.39",
+  "bendWindows": "MattCozendey/bend/126afd6cbded7e392302b41d2504083ad26b40c1",
   "scripts": {
     "postinstall": "bun ./src/linter/seam.ts postinstall"
   }

package/src/files/main.bend

@@ -1,6 +1,6 @@
 import Base
-import bend-lint-api@0.1.1.0/shared/lists.bend as Lists
-import bend-lint-api@0.1.1.0/shared/strings.bend as Strings
+import bend-lint-api@0.2.0.0/shared/lists.bend as Lists
+import bend-lint-api@0.2.0.0/shared/strings.bend as Strings
 
 # Types
 # =====

package/src/json/main.bend

@@ -1,6 +1,6 @@
 import Base
-import bend-lint-api@0.1.1.0/shared/names.bend as Names
-import bend-lint-api@0.1.1.0/shared/strings.bend as Strings
+import bend-lint-api@0.2.0.0/shared/names.bend as Names
+import bend-lint-api@0.2.0.0/shared/strings.bend as Strings
 
 # Types
 # =====