rumk 0.0.5__py3-none-win_amd64.whl

rumk-0.0.5.dist-info/METADATA

@@ -0,0 +1,299 @@
+Metadata-Version: 2.4
+Name: rumk
+Version: 0.0.5
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Quality Assurance
+License-File: LICENSE
+Summary: A fast linter for Makefiles
+Author: Ruben Jongejan
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Documentation, https://github.com/rvben/rumk#readme
+Project-URL: Homepage, https://github.com/rvben/rumk
+Project-URL: Issues, https://github.com/rvben/rumk/issues
+Project-URL: Repository, https://github.com/rvben/rumk.git
+
+# rumk
+
+A fast Makefile linter written in Rust, built as the Makefile sibling of
+[Rumdl](https://github.com/rvben/rumdl).
+
+Rumk is currently alpha software. Its CLI, configuration model, diagnostics, fixing behavior,
+and exit codes intentionally follow Rumdl so existing Rumdl users can reuse their workflow.
+
+## Features
+
+- Lints individual Makefiles or entire directory trees
+- Safely fixes recipe indentation, style-aware `.PHONY` declarations, and recursive Make
+  invocations
+- Parses continued logical statements and nested `$(...)`/`${...}` expressions
+- Models GNU Make assignment flavors, static patterns, target-specific variables, includes,
+  conditionals, `define` blocks, custom recipe prefixes, and `.ONESHELL`
+- Builds semantic indexes for variables, references, targets, dependencies, and includes
+- Safely evaluates statically knowable variables and conditionals without running recipes,
+  shell commands, or side-effecting Make functions
+- Supports GNU substitution references plus common word, path, list, and lazy logical functions
+- Resolves expanded include graphs and reports cross-file findings at their real source paths
+- Preserves LF/CRLF line endings and final newlines during fixes
+- Uses Rumdl-style `check`, `fmt`, `rule`, `config`, `init`, and `explain` commands
+- Discovers `.rumk.toml` upward through the project tree
+- Respects `.gitignore` by default
+- Supports rule selection, file globs, per-file ignores, severities, and fix allowlists
+- Emits text, flat JSON, and GitHub Actions annotations
+
+## Installation
+
+```bash
+cargo install rumk --locked --version 0.0.5
+```
+
+Or install the native executable from PyPI with a Python tool manager:
+
+```bash
+uv tool install rumk==0.0.5
+# or
+pipx install rumk==0.0.5
+```
+
+Rumk is alpha-stage `0.0.x` software, so installation names the version explicitly. Release
+archives and Python wheels cover Linux, macOS, and Windows. GitHub release assets include SHA-256
+checksums and build-provenance attestations.
+
+## Quick start
+
+```bash
+# Check Makefiles below the current directory
+rumk check
+
+# Check specific files or directories
+rumk check Makefile build/
+
+# Apply safe fixes, then fail only if violations remain
+rumk check --fix
+
+# Format files with formatter-style exit behavior
+rumk fmt
+
+# Preview formatting changes
+rumk fmt --diff
+
+# Fail when formatting changes are required
+rumk fmt --check
+
+# Inspect rules and effective configuration
+rumk rule
+rumk rule MK101
+rumk config
+rumk config get MK101.line-length
+rumk config file
+```
+
+Run `rumk --help` or `rumk <command> --help` for all options.
+
+## Configuration
+
+Create a `.rumk.toml` file manually or run `rumk init`:
+
+```toml
+[global]
+dialect = "gnu"
+respect-gitignore = true
+exclude = ["vendor/**", "generated/**"]
+disable = ["MK101"]
+fixable = ["MK001"]
+include-paths = ["mk"]
+predefined-variables = { FROM_CLI = "yes" }
+entry-targets = ["all"]
+
+[MK101]
+enabled = true
+severity = "warning"
+line-length = 100
+ignore-comments = true
+ignore-recipes = true
+
+[MK102]
+enabled = true
+style = "upper-case"
+
+[MK201]
+placement = "auto"
+
+[per-file-ignores]
+"vendor/**/*.mk" = ["MK202"]
+```
+
+Configuration discovery checks `.rumk.toml`, `rumk.toml`, and `.config/rumk.toml` while walking
+upward, stopping at a Git project boundary. Use `--config <PATH>` for an explicit file or
+`--no-config`/`--isolated` for built-in defaults.
+
+Configurations can inherit another file with `extends = "../.rumk.toml"`; nested tables are
+merged, child values win, relative paths resolve from the extending file, and cycles are rejected.
+
+Rules can be suppressed in Make comments without changing project configuration:
+
+```makefile
+# rumk-disable MK202
+INSTALL_PREFIX := /usr/local
+# rumk-enable MK202
+
+# rumk-disable-next-line MK201
+clean:
+	rm -rf build
+```
+
+`rumk-disable`, `rumk-enable`, `rumk-disable-line`, and `rumk-disable-next-line` are supported.
+Recipe shell comments are not interpreted as Rumk directives.
+
+The original Rumk `[rules]` and `[ignore]` configuration sections remain accepted for migration.
+
+`include-paths` models GNU Make's `-I` search directories and resolves relative entries from the
+configuration directory. `predefined-variables` supplies command-line-style values to safe
+evaluation and names expected by opt-in rule `MK208`. That rule intentionally ignores references
+inside recipes and deferred macro bodies, where command-line parameters and shell values are
+normal. `entry-targets` supplies the roots for opt-in reachability rule `MK209`; the rule stays
+silent without explicit roots because any Make target may be invoked directly from the command
+line.
+
+### Rule and file selection
+
+Rumk follows Rumdl's selection vocabulary:
+
+```bash
+rumk check --enable MK001,MK002 .
+rumk check --disable MK101 .
+rumk check --extend-enable MK202 .
+rumk check --exclude "vendor/**,generated/**" .
+rumk check --include "src/**" .
+rumk check --respect-gitignore=false .
+rumk fmt --fixable MK001 .
+```
+
+### Exit codes
+
+- `0`: success, or all selected violations were fixed
+- `1`: lint violations, or `fmt --check` found required changes
+- `2`: configuration, file access, or other tool error
+
+`rumk check` fails on any diagnostic by default. Use `--fail-on warning`, `--fail-on error`, or
+`--fail-on never` to change that policy. `rumk fmt` exits successfully after formatting even if
+non-fixable lint diagnostics remain.
+
+## Output
+
+Text diagnostics follow Rumdl's familiar form:
+
+```text
+Makefile:2:1: [MK001] Recipe must be indented with tab, not spaces [*]
+```
+
+JSON output is a flat array collected across all files:
+
+```bash
+rumk check --output-format json .
+```
+
+```json
+[
+  {
+    "file": "Makefile",
+    "line": 2,
+    "column": 1,
+    "end_line": 2,
+    "end_column": 1,
+    "rule": "MK001",
+    "message": "Recipe must be indented with tab, not spaces",
+    "severity": "error",
+    "fixable": true,
+    "fix": {
+      "range": { "start": 7, "end": 11 },
+      "replacement": "\t"
+    }
+  }
+]
+```
+
+The legacy `--format` spelling remains an alias for `--output-format`.
+
+## Rules
+
+Rules marked **default** run without configuration.
+Each rule page documents its behavior, configuration, fixes, edge cases, and
+the GNU Make, POSIX, or Rumk convention on which it is based.
+
+### Syntax
+
+- [`MK001`](https://github.com/rvben/rumk/blob/main/docs/mk001.md) — Recipes must use tab
+  indentation (**default**, fixable)
+- [`MK002`](https://github.com/rvben/rumk/blob/main/docs/mk002.md) — Invalid variable syntax
+  (**default**)
+- [`MK003`](https://github.com/rvben/rumk/blob/main/docs/mk003.md) — Malformed conditional
+  structure (**default**)
+- [`MK004`](https://github.com/rvben/rumk/blob/main/docs/mk004.md) — Targets must not mix
+  single- and double-colon declarations (**default**)
+- [`MK005`](https://github.com/rvben/rumk/blob/main/docs/mk005.md) — GNU Make special targets
+  must stand alone (**default**)
+
+### Style
+
+- [`MK101`](https://github.com/rvben/rumk/blob/main/docs/mk101.md) — Declarative line exceeds
+  the configured maximum length; comments and recipes are ignored by default (**default**)
+- [`MK102`](https://github.com/rvben/rumk/blob/main/docs/mk102.md) — Variable naming convention
+- [`MK103`](https://github.com/rvben/rumk/blob/main/docs/mk103.md) — Target naming convention
+
+### Best practices
+
+- [`MK201`](https://github.com/rvben/rumk/blob/main/docs/mk201.md) — Conventional
+  non-file targets should be `.PHONY`;
+  fixes consolidate canonical groups, preserve per-section style, and wrap long
+  declarations (**default**, fixable)
+- [`MK202`](https://github.com/rvben/rumk/blob/main/docs/mk202.md) — Avoid hardcoded absolute
+  paths (opt-in)
+- [`MK203`](https://github.com/rvben/rumk/blob/main/docs/mk203.md) — Recursive Make invocations
+  should use `$(MAKE)` (**default**, fixable)
+- [`MK204`](https://github.com/rvben/rumk/blob/main/docs/mk204.md) — Concrete targets should not
+  declare multiple single-colon recipes (**default**)
+- [`MK205`](https://github.com/rvben/rumk/blob/main/docs/mk205.md) — Explicit target dependencies
+  must not form cycles (**default**)
+- [`MK206`](https://github.com/rvben/rumk/blob/main/docs/mk206.md) — Required static includes must
+  resolve (**default**)
+- [`MK207`](https://github.com/rvben/rumk/blob/main/docs/mk207.md) — Static Makefile includes must
+  not form cycles (**default**)
+- [`MK208`](https://github.com/rvben/rumk/blob/main/docs/mk208.md) — Static graph-level variable
+  references must resolve (opt-in)
+- [`MK209`](https://github.com/rvben/rumk/blob/main/docs/mk209.md) — Targets must be reachable
+  from explicitly configured entries (opt-in)
+- [`MK210`](https://github.com/rvben/rumk/blob/main/docs/mk210.md) — Explain include expressions
+  blocked by safe evaluation (opt-in)
+
+## Development
+
+```bash
+cargo test --all-targets --all-features
+cargo clippy --all-targets --all-features -- -D warnings
+cargo fmt --all -- --check
+cargo build --release
+make check-gnu-fixtures
+```
+
+The product-level compatibility contract is documented in
+[`docs/rumdl-compatibility.md`](docs/rumdl-compatibility.md).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+MIT. See [LICENSE](LICENSE).
+

rumk-0.0.5.dist-info/RECORD

@@ -0,0 +1,6 @@
+rumk-0.0.5.data/scripts/rumk.exe,sha256=iIP5r90i7fPiCtQqKENLuCApWfsCijnSiK6u09Kg948,3506688
+rumk-0.0.5.dist-info/METADATA,sha256=p_S69XhTbqbVZoFWeJirSD4S9O-6KREDISQ9Q7iwB14,10413
+rumk-0.0.5.dist-info/WHEEL,sha256=8Aej0W0a6Cz6apA3IzJrTnxLRVLAt-w0Oh8SA3Con_c,94
+rumk-0.0.5.dist-info/licenses/LICENSE,sha256=NTJ5LF0SegnhXXgkiSAZT4YaGhgWpXsBzNzSBWPZ-3g,1100
+rumk-0.0.5.dist-info/sboms/rumk.cyclonedx.json,sha256=xCra2-2wmq5divLcr9Q1LQgY1XP4he9HGbYvUPsJskc,70440
+rumk-0.0.5.dist-info/RECORD,,

rumk-0.0.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.15.0)
+Root-Is-Purelib: false
+Tag: py3-none-win_amd64

rumk-0.0.5.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2026 rumk contributors
+
+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.