pbiplint 0.2.2 → 0.2.4

package/README.md

@@ -4,8 +4,10 @@ Best-practice linter for Power BI projects. Point it at a PBIP folder, a `.pbip`
 `.SemanticModel` folder, a `.Report` folder, a `definition` folder, or one `.tmdl` file and get
 ranked findings with a link to a fix page for each rule, and, when the input has a report, a
 "Report at a glance" block that says what the report will do when someone opens it. Nothing is
-uploaded: it reads the files you name and writes to your terminal. Node 20.19 or later (or 22.12
-or later).
+uploaded: it reads the files you name and writes to your terminal, and
+[the pbiplint Privacy Promise](https://pbiplint.com/privacy/) says what that covers. Node 20.19 or a
+later 20 release, or 22.12 or later. [The pbiplint CLI](https://pbiplint.com/cli/) page on the site has more:
+where to get it, what it reads, and how to check that it sends nothing.
 
 ```bash
 npx pbiplint path/to/Model.SemanticModel
@@ -18,10 +20,19 @@ npx pbiplint --version
 ```
 
 Formats: `text` (default), `json`, `sarif` (for GitHub code scanning and editors), `markdown`.
+The Markdown export writes an email address, an `@name`, a `#123` or `GH-123`, and text
+holding two or more `$` as code, so pasted into a GitHub issue or comment it links no one,
+notifies no one, and renders no math.
 
 Exit codes: `0` no findings at or above `--fail-on`, `1` findings, `2` usage or input error.
 `--fail-on error` is the default; `--fail-on warning` and `--fail-on info` tighten the gate;
-`--fail-on none` always exits 0.
+`--fail-on none` exits 0 on any run that lints something. A run that can read nothing in the input,
+such as a report saved as a single `report.json` (PBIR-Legacy) with no model beside it, exits `2`
+and says why, rather than passing with no findings.
+
+Pointed at a folder that is not a project but holds one in a folder below it, as a repository
+often does, pbiplint lints that project and names it in a notice. A folder that holds several exits
+`2` and lists them, each with the command that lints it.
 
 ## Configuration
 
@@ -60,12 +71,18 @@ page.json or visual.json (Power BI Desktop keeps it there too):
 ## What it checks
 
 Every rule from the Microsoft Best Practice Analyzer ruleset, ported so the results match Tabular
-Editor on the same model, with five documented deviations where the source is noisier, or quieter,
+Editor on the same model, with eleven documented deviations where the source is noisier, or quieter,
 than it means to be; and pbiplint's own rules for a year or a date fixed in DAX, such as a measure
-filtered to 2025 or a date table that ends in 2026, and for a DAX user-defined function that nothing
-calls, has a one-word name, or has no description. Five of the Microsoft rules need statistics only
-a live model has; they are listed but not run. Each rule has a page at https://pbiplint.com/rules
-with what it checks, why, how to fix it, and quirks.
+filtered to 2025 or a date table that ends in 2026, for a DAX user-defined function that nothing
+calls, has a one-word name, or has no description, for a visible name that a translated culture
+gives no caption, and for a visible decimal column with no format string. Four of pbiplint's own
+model rules take their test from Tabular Editor's rules, from Tabular Editor 3's built-in set or the
+community's published rule files, and are checked against Tabular Editor on the same model. Five of
+the Microsoft rules need statistics only a live model has; they are listed but not run. A column
+whose TMDL names no type, as Power BI Desktop saves most calculated columns, is left out of the
+thirteen ported rules that test a column's type, where Tabular Editor reads the type from the
+column's DAX. Each rule has a page at https://pbiplint.com/rules with what it checks, why, how to
+fix it, and quirks.
 
 The report layer (PBIR) is read beside the model: a `.Report` folder alone is valid input, and with
 the model beside it the two are paired through `definition.pbir` and checked together. The report