tally-cli 0.6.0 → 0.7.0

package/README.md

@@ -41,9 +41,9 @@ tally integrates rules from multiple sources:
 <!-- BEGIN RULES_TABLE -->
 | Source | Rules | Description |
 |--------|-------|-------------|
-| **[BuildKit](https://docs.docker.com/reference/build-checks/)** | 12/22 rules | Docker's official Dockerfile checks (captured + reimplemented) |
-| **tally** | 5 rules | Custom rules including secret detection with [gitleaks](https://github.com/gitleaks/gitleaks) |
-| **[Hadolint](https://github.com/hadolint/hadolint)** | 27 rules | Hadolint-compatible Dockerfile rules (expanding) |
+| **[BuildKit](https://docs.docker.com/reference/build-checks/)** | 14/22 rules | Docker's official Dockerfile checks (captured + reimplemented) |
+| **tally** | 8 rules | Custom rules including secret detection with [gitleaks](https://github.com/gitleaks/gitleaks) |
+| **[Hadolint](https://github.com/hadolint/hadolint)** | 31 rules | Hadolint-compatible Dockerfile rules (expanding) |
 <!-- END RULES_TABLE -->
 
 **See [RULES.md](RULES.md) for the complete rules reference.**
@@ -167,187 +167,40 @@ EOF
 
 ## Ignoring Violations
 
-You can suppress specific violations using inline comment directives.
-
-### Next-Line Directives
-
-Suppress violations on the next line:
+Suppress specific violations using inline comment directives:
 
 ```dockerfile
 # tally ignore=StageNameCasing
 FROM alpine AS Build
-```
-
-### Global Directives
 
-Suppress violations throughout the entire file:
-
-```dockerfile
-# tally global ignore=max-lines
+# tally global ignore=max-lines;reason=Generated file
 FROM alpine
-# ... rest of file is not checked for max-lines
-```
-
-### Multiple Rules
-
-Suppress multiple rules with comma-separated values:
-
-```dockerfile
-# tally ignore=StageNameCasing,DL3006
-FROM Ubuntu AS Build
 ```
 
-### Adding Reasons
-
-Document why a rule is being ignored using `;reason=` (BuildKit-style separator):
+tally also supports `hadolint` and `check=skip` directive formats for easy migration.
 
-```dockerfile
-# tally ignore=DL3006;reason=Using older base image for compatibility
-FROM ubuntu:16.04
-
-# tally global ignore=max-lines;reason=Generated file, size is expected
-FROM alpine
-
-# check=skip=StageNameCasing;reason=Legacy naming convention
-FROM alpine AS Build
-```
-
-Use `--require-reason` to enforce that all ignore directives include an explanation:
-
-```bash
-tally check --require-reason Dockerfile
-```
-
-Note: The `;reason=` syntax is a tally extension that works with all directive formats. BuildKit silently ignores the `reason` option.
-
-### Migration Compatibility
-
-tally supports directive formats from other linters for easy migration:
-
-```dockerfile
-# hadolint ignore=DL3006
-FROM ubuntu
-
-# hadolint global ignore=DL3008
-FROM alpine
-
-# check=skip=StageNameCasing
-FROM alpine AS Build
-```
-
-### Suppressing All Rules
-
-Use `all` to suppress all rules on a line:
-
-```dockerfile
-# tally ignore=all
-FROM Ubuntu AS Build
-```
-
-### CLI Options
-
-| Flag                       | Description                                                |
-| -------------------------- | ---------------------------------------------------------- |
-| `--no-inline-directives`   | Disable processing of inline ignore directives             |
-| `--warn-unused-directives` | Warn about directives that don't suppress any violations   |
-| `--require-reason`         | Warn about ignore directives without `reason=` explanation |
-
-### Configuration
-
-Inline directive behavior can be configured in `.tally.toml`:
-
-```toml
-[inline-directives]
-enabled = true        # Process inline directives (default: true)
-warn-unused = false   # Warn about unused directives (default: false)
-validate-rules = false # Warn about unknown rule codes (default: false)
-require-reason = false # Require reason= on all ignore directives (default: false)
-```
+**See [Configuration Guide](docs/guide/configuration.md#inline-directives) for full directive syntax.**
 
 ## Configuration
 
-tally supports configuration via TOML config files, environment variables, and CLI flags.
-
-### Config File
-
-Create a `.tally.toml` or `tally.toml` file in your project:
+Create a `.tally.toml` in your project:
 
 ```toml
 [output]
-format = "text"          # text, json, sarif, github-actions, markdown
-path = "stdout"          # stdout, stderr, or file path
-show-source = true       # Show source code snippets
-fail-level = "style"     # Minimum severity for exit code 1
+format = "text"
+fail-level = "warning"
 
-# Rule selection (Ruff-style)
 [rules]
-include = ["buildkit/*", "tally/*"]           # Enable rules by namespace or specific rule
-exclude = ["buildkit/MaintainerDeprecated"]   # Disable specific rules
+include = ["buildkit/*", "tally/*"]
+exclude = ["buildkit/MaintainerDeprecated"]
 
-# Per-rule configuration (severity, options)
 [rules.tally.max-lines]
-severity = "error"
-max = 500
-skip-blank-lines = true
-skip-comments = true
-
-[rules.buildkit.StageNameCasing]
-severity = "info"         # Downgrade severity
-
-[rules.hadolint.DL3026]
-severity = "warning"
-trusted-registries = ["docker.io", "gcr.io"]
+max = 100
 ```
 
-### Config File Discovery
-
-tally uses cascading config discovery similar to [Ruff](https://docs.astral.sh/ruff/configuration/):
-
-1. Starting from the Dockerfile's directory, walks up the filesystem
-2. Stops at the first `.tally.toml` or `tally.toml` found
-3. Uses that config (no merging with parent configs)
-
-This allows monorepo setups with per-directory configurations.
-
-### Priority Order
-
-Configuration sources are applied in this order (highest priority first):
-
-1. **CLI flags** (`--max-lines 100`)
-2. **Environment variables** (`TALLY_RULES_MAX_LINES_MAX=100`)
-3. **Config file** (`.tally.toml` or `tally.toml`)
-4. **Built-in defaults**
+Configuration priority: CLI flags > environment variables > config file > defaults.
 
-### Environment Variables
-
-| Variable                                 | Description                                                           |
-| ---------------------------------------- | --------------------------------------------------------------------- |
-| `TALLY_OUTPUT_FORMAT`                    | Output format (`text`, `json`, `sarif`, `github-actions`, `markdown`) |
-| `TALLY_OUTPUT_PATH`                      | Output destination (`stdout`, `stderr`, or file path)                 |
-| `TALLY_OUTPUT_SHOW_SOURCE`               | Show source snippets (`true`/`false`)                                 |
-| `TALLY_OUTPUT_FAIL_LEVEL`                | Minimum severity for non-zero exit                                    |
-| `NO_COLOR`                               | Disable colored output (standard env var)                             |
-| `TALLY_EXCLUDE`                          | Glob pattern(s) to exclude files (comma-separated)                    |
-| `TALLY_CONTEXT`                          | Build context directory for context-aware rules                       |
-| `TALLY_RULES_MAX_LINES_MAX`              | Maximum lines allowed                                                 |
-| `TALLY_RULES_MAX_LINES_SKIP_BLANK_LINES` | Exclude blank lines (`true`/`false`)                                  |
-| `TALLY_RULES_MAX_LINES_SKIP_COMMENTS`    | Exclude comments (`true`/`false`)                                     |
-| `TALLY_NO_INLINE_DIRECTIVES`             | Disable inline directive processing (`true`/`false`)                  |
-| `TALLY_INLINE_DIRECTIVES_WARN_UNUSED`    | Warn about unused directives (`true`/`false`)                         |
-| `TALLY_INLINE_DIRECTIVES_REQUIRE_REASON` | Require reason= on ignore directives (`true`/`false`)                 |
-
-### CLI Flags
-
-```bash
-# Specify config file explicitly
-tally check --config /path/to/.tally.toml Dockerfile
-
-# Override max-lines from config
-tally check --max-lines 200 Dockerfile
-
-# Exclude blank lines and comments from count
-tally check --max-lines 100 --skip-blank-lines --skip-comments Dockerfile
-```
+**See [Configuration Guide](docs/guide/configuration.md) for full reference.**
 
 ## Output Formats
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tally-cli",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "A fast, configurable linter for Dockerfiles and Containerfiles",
   "repository": {
     "type": "git",
@@ -31,13 +31,13 @@
     "node": ">=18.0.0"
   },
   "optionalDependencies": {
-    "@contino/tally-darwin-arm64": "0.6.0",
-    "@contino/tally-darwin-x64": "0.6.0",
-    "@contino/tally-linux-arm64": "0.6.0",
-    "@contino/tally-linux-x64": "0.6.0",
-    "@contino/tally-windows-arm64": "0.6.0",
-    "@contino/tally-windows-x64": "0.6.0",
-    "@contino/tally-freebsd-x64": "0.6.0"
+    "@contino/tally-darwin-arm64": "0.7.0",
+    "@contino/tally-darwin-x64": "0.7.0",
+    "@contino/tally-linux-arm64": "0.7.0",
+    "@contino/tally-linux-x64": "0.7.0",
+    "@contino/tally-windows-arm64": "0.7.0",
+    "@contino/tally-windows-x64": "0.7.0",
+    "@contino/tally-freebsd-x64": "0.7.0"
   },
   "publishConfig": {
     "access": "public"