pbiplint 0.1.1 → 0.2.0

package/NOTICE

@@ -27,3 +27,30 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+pbiplint also bundles rule metadata derived from Rules/Base-rules.json and
+test fixtures derived from FabInspector.Tests/Files/pbip in the
+NatVanG/fab-inspector repository (https://github.com/NatVanG/fab-inspector),
+which is licensed under the MIT License:
+
+MIT License
+
+Copyright (c) 2024 Nat Van Gulck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,21 +1,27 @@
 # pbiplint
 
-Best-practice linter for Power BI semantic models. Point it at a `.SemanticModel` folder, a PBIP
-folder, or one `.tmdl` file and get ranked findings with a link to a fix page for each rule.
-Nothing is uploaded: it reads the files you name and writes to your terminal. Node 20 or later.
+Best-practice linter for Power BI projects. Point it at a PBIP folder, a `.pbip` file, a
+`.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).
 
 ```bash
 npx pbiplint path/to/Model.SemanticModel
-npx pbiplint --sample                                       # a bundled model with planted violations
+npx pbiplint --sample                                       # a bundled project, a model and its report, with planted violations
 npx pbiplint path/to/model --format sarif --output pbiplint.sarif
 npx pbiplint path/to/model --format markdown
 npx pbiplint rules                                          # every rule with status and severity
+npx pbiplint --help                                         # every option, in one screen
+npx pbiplint --version
 ```
 
 Formats: `text` (default), `json`, `sarif` (for GitHub code scanning and editors), `markdown`.
 
-Exit codes: `0` no findings at or above `--fail-on` (default `error`), `1` findings, `2` usage or
-input error. `--fail-on warning` tightens the gate; `--fail-on none` always exits 0.
+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.
 
 ## Configuration
 
@@ -33,6 +39,9 @@ picks one explicitly):
 }
 ```
 
+A rule that takes options is set with an object, such as
+`"REDUCE_VISUALS_ON_PAGE": { "severity": "error", "max": 15 }`; each rule's page lists its options.
+
 To ignore a rule on one object, annotate it in TMDL (Power BI Desktop keeps the annotation):
 
 ```
@@ -41,17 +50,34 @@ To ignore a rule on one object, annotate it in TMDL (Power BI Desktop keeps the
 		annotation pbiplint.ignore = HIDE_FOREIGN_KEYS, MARK_PRIMARY_KEYS
 ```
 
+To ignore a report rule on one page or visual, add the annotation to the `annotations` array of its
+page.json or visual.json (Power BI Desktop keeps it there too):
+
+```json
+"annotations": [{ "name": "pbiplint.ignore", "value": "ENSURE_ALTTEXT" }]
+```
+
 ## What it checks
 
 Every rule from the Microsoft Best Practice Analyzer ruleset, ported literally so the numbers match
 Tabular Editor. Five 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.
 
+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
+rules are the 11 base rules of PBI Inspector by Nat Van Gulck, ported so the results match its
+command line on the same report, with six documented deviations, and pbiplint's own rules for a
+report's correctness and readiness and for the model objects the report never reaches. When the
+input has a report, the "Report at a glance" block states what the report will do when someone
+opens it, whether or not anything fired. A notice names anything about the input a reader must
+know, such as a file that could not be read or a `definition.pbir` that points at a model other
+than the one beside it.
+
 The same linter runs in the browser at https://pbiplint.com. Source, issues, and contributing:
 https://github.com/pbiplint/pbiplint.
 
 ## License
 
 Copyright (C) 2026 McKinley Consulting. GNU Affero General Public License, version 3 or later; see
-LICENSE. The vendored Microsoft ruleset is MIT-licensed; see NOTICE. The name pbiplint and its
-logo are trademarks of McKinley Consulting.
+LICENSE. The vendored Microsoft ruleset and PBI Inspector rule metadata are MIT-licensed; see
+NOTICE. The name pbiplint and its logo are trademarks of McKinley Consulting.