uncomment-hermes-plugin 3.10.3__py3-none-any.whl

uncomment_hermes_plugin/__init__.py

@@ -0,0 +1,12 @@
+# AI-RULEZ :: GENERATED FILE — DO NOT EDIT
+# Content-Hash: blake3:108dedcbe5c8f5d5ef009226493fbc1177125be18fe519ed65e26bc396133b3e
+# Source-Hash: blake3:0935b1c74300d0f985a89bd38c3cfd9146d3b7832a514aca4b1d1a2f0db775ed
+# Schema-Version: v1
+
+"""Hermes Agent plugin package."""
+
+from . import hermes
+from .hermes import register
+
+__version__ = "3.10.3"
+__all__ = ["hermes", "register"]

uncomment_hermes_plugin/hermes.py

@@ -0,0 +1,24 @@
+# AI-RULEZ :: GENERATED FILE — DO NOT EDIT
+# Content-Hash: blake3:f0861e3a09f285cd65f5c91452dbe9269b3364f36d138b56dab9f1e5f972ba27
+# Source-Hash: blake3:0935b1c74300d0f985a89bd38c3cfd9146d3b7832a514aca4b1d1a2f0db775ed
+# Schema-Version: v1
+
+"""Register the bundled read-only skill with Hermes Agent."""
+
+from pathlib import Path
+from typing import Protocol
+
+
+class SkillContext(Protocol):
+    """The registration API provided by the Hermes plugin SDK."""
+
+    def register_skill(self, name: str, path: Path, description: str = "") -> None: ...
+
+
+def register(ctx: SkillContext) -> None:
+    """Resolve skill bytes relative to the installed native plugin."""
+    ctx.register_skill(
+        "uncomment",
+        Path(__file__).parent / "skills/uncomment/SKILL.md",
+        "Inventory, preserve, lint and remove source comments with Uncomment.",
+    )

uncomment_hermes_plugin/plugin.yaml

@@ -0,0 +1,5 @@
+name: "uncomment"
+version: "3.10.3"
+description: "Inventory, preserve and remove source comments with AST parsing. Skills only; install the Uncomment CLI separately."
+author: "Goldziher"
+kind: "standalone"

uncomment_hermes_plugin/skills/uncomment/SKILL.md

@@ -0,0 +1,104 @@
+---
+description: Inventory, preserve, lint and remove source comments using Uncomment's tree-sitter CLI or Rust library. Use for comment cleanup and preservation policies without changing comment-like text in strings.
+name: uncomment
+license: MIT
+metadata:
+    author: Goldziher
+    repository: https://github.com/Goldziher/uncomment
+---
+
+<!--
+AI-RULEZ :: GENERATED FILE — DO NOT EDIT
+Content-Hash: blake3:0c7de78d48b93b3fbba0488c23059fea8b4e0ff49f7c1de07c8c7bbf8a3c24fa
+Source-Hash: blake3:0935b1c74300d0f985a89bd38c3cfd9146d3b7832a514aca4b1d1a2f0db775ed
+Schema-Version: v1
+-->
+
+## Uncomment Source Comment Cleanup
+
+Uncomment uses tree-sitter to find source comments. This skill targets Uncomment
+3.10 and newer, including `scan`, `keep`, `lint` and the `--check` gate. Install the
+CLI separately; this plugin provides instructions and has no MCP server.
+
+```bash
+cargo install uncomment --version '^3.10'
+# Binary wrappers are available as uncomment-cli on npm and uncomment on PyPI.
+uncomment --version
+```
+
+### Inspect and preview
+
+Start with the paths the user selected. An ordinary removal invocation writes
+files; `scan`, `--dry-run`, and `--check` let you inspect the planned cleanup.
+
+```bash
+uncomment scan src/ --only removable --format jsonl --output comments.jsonl
+uncomment src/ --dry-run --diff
+```
+
+Scan records contain `id`, `path`, `line`, `end_line`, `start_byte`, `end_byte`,
+`kind`, `verdict` and `text`. Preserved records also include `reason`. Positions are
+one-based lines and zero-based byte offsets. Use IDs to select comments; IDs survive
+edits above a comment but depend on its path, exact text and occurrence index.
+
+### Preserve selected comments
+
+Use a plain comment marker for comments that must survive cleanup:
+
+```rust
+// This workaround must stay until the upstream fix ships. ~keep
+// ~keep
+/// Documentation that must survive --remove-doc.
+```
+
+A standalone marker uses the language's plain comment token, such as `//` or `#`,
+not a documentation prefix such as `///`. Quoted mentions of `~keep` are prose,
+not active markers. Let `keep` handle block comments and docstrings so it can
+place and verify the marker without editing their runtime contents.
+
+```bash
+uncomment keep src/ --id 'ID_FROM_SCAN'
+uncomment keep src/ --match 'workaround' --dry-run --diff
+uncomment keep src/ --from selected-comments.jsonl
+```
+
+`--from` marks every ID in the supplied JSON or JSONL records; select the records
+first. Extra decision fields do not turn an ID into a rejection. Missing IDs fail
+unless `--skip-missing` is explicitly requested.
+
+### Apply cleanup or gate it
+
+```bash
+uncomment src/ --dry-run --diff
+uncomment src/
+uncomment --check src/ --format json
+uncomment --check --changed-only --base origin/main .
+```
+
+Defaults preserve TODO/FIXME, documentation, common lint directives and active
+`~keep` markers. `--remove-todo`, `--remove-fixme` and `--remove-doc` opt into removing
+those categories; `--ignore PATTERN` adds case-sensitive substring preservation.
+`--no-default-ignores` disables the built-in preservation patterns.
+
+The removal gate exits 0 when nothing would be removed, 1 when removable comments
+exist, and 2 when inspection could not complete. Check reported file counts;
+zero matched files are not evidence that the intended tree passed. In 3.10.3, a
+missing input path can print an error and still exit 0, so also verify paths exist
+and the report covers the expected files. Current main source builds reject a
+missing explicit path with exit 2; that fix has not been released yet.
+
+### Lint tag conventions
+
+Tag linting removes nothing and is inactive until `[lint] enabled = true` is
+configured. Use [configuration](references/configuration.md) for layering,
+exclusions and rule settings.
+
+```bash
+uncomment lint src/ --format json
+uncomment lint src/ --fix --todo-key 'PROJECT-123'
+```
+
+Use `--fix` only when rewriting tag comments is part of the requested work.
+The key must be a real issue key chosen for that project.
+
+For read-only Rust integration, see [library usage](references/library.md).

uncomment_hermes_plugin/skills/uncomment/index.md

@@ -0,0 +1,10 @@
+<!--
+AI-RULEZ :: GENERATED FILE — DO NOT EDIT
+Content-Hash: blake3:f42f05d7c370b764780e3f369cbb5e6946ea4a6b7ff99106c59e97bdfcc8435d
+Source-Hash: blake3:0935b1c74300d0f985a89bd38c3cfd9146d3b7832a514aca4b1d1a2f0db775ed
+Schema-Version: v1
+-->
+
+# Concepts
+
+* [Uncomment Source Comment Cleanup](SKILL.md) - Inventory, preserve, lint and remove source comments using Uncomment's tree-sitter CLI or Rust library. Use for comment cleanup and preservation policies without changing comment-like text in strings.

uncomment_hermes_plugin/skills/uncomment/references/configuration.md

@@ -0,0 +1,73 @@
+<!--
+AI-RULEZ :: GENERATED FILE — DO NOT EDIT
+Content-Hash: blake3:ff5a20cc917540f9afd622ab89d697c603c90a3bbccc6240082b43bca9bf06c6
+Source-Hash: blake3:0935b1c74300d0f985a89bd38c3cfd9146d3b7832a514aca4b1d1a2f0db775ed
+Schema-Version: v1
+-->
+
+# Configuration and CLI Selection
+
+The preferred project file is `.uncomment.toml`. Generate it with
+`uncomment init`; `--comprehensive` includes every option. Existing files are
+protected unless `--force` is supplied.
+
+```toml
+[global]
+remove_todos = false
+remove_fixme = false
+remove_docs = false
+use_default_ignores = true
+preserve_patterns = ["WORKAROUND", "Copyright", "License"]
+exclude = ["generated/**", "vendor/**"]
+
+[lint]
+enabled = true
+```
+
+Global options layer from built-in defaults to the platform global config, project
+ancestor configs, the nearest project config, and CLI flags. `-c, --config FILE`
+selects a single config instead of automatic discovery. `.uncommentrc.toml` and
+`uncomment.toml` are deprecated fallbacks; new projects should use `.uncomment.toml`.
+A directory containing multiple recognized names uses the highest-precedence one,
+not a merge of those files.
+
+The global config lives under the platform config directory: typically
+`~/.config/uncomment/config.toml` on Linux and
+`~/Library/Application Support/uncomment/config.toml` on macOS.
+
+`preserve_patterns` and `--ignore` match case-sensitive substrings of an already
+identified comment, not regular expressions over source code. Short patterns can
+preserve more comments than intended. Use narrow patterns for a named convention.
+
+## File selection
+
+- Paths can name files, directories or globs. Quote globs when Uncomment should expand them.
+- `.gitignore` is respected unless `--no-gitignore` is supplied.
+- `--exclude GLOB` adds exclusions to `[global] exclude`.
+- Nested Git repositories are skipped unless `--traverse-git-repos` is supplied.
+- `-j, --threads N` selects workers; 0 uses all cores, and the default is 1.
+- No `--language` or stdin mode is declared in the CLI; use source file extensions
+  or configured language registrations.
+
+For branch gates, use `--changed-only --base REF` to restrict files, or
+`--changed-lines --base REF` to restrict findings to changed lines. `--staged`
+selects the index diff rather than the worktree diff.
+
+## Tag linting
+
+`[lint] enabled = true` activates the default tag rules. `uncomment lint` then
+checks canonical tags and issue keys, including references to the current branch's
+own issue key. Without this setting, matching files have no active tag policy.
+
+```toml
+[lint]
+enabled = true
+
+[lint.rules]
+todo_missing_key = "error"
+todo_self_reference = "warn"
+```
+
+`--baseline FILE` makes already-recorded violations informational;
+`--write-baseline --baseline FILE` records the current violations and exits 0.
+Use baselines only when the project intentionally accepts that existing debt.

uncomment_hermes_plugin/skills/uncomment/references/library.md

@@ -0,0 +1,40 @@
+<!--
+AI-RULEZ :: GENERATED FILE — DO NOT EDIT
+Content-Hash: blake3:c2b7c3bed8e321e5c3e141562df4cc9908f270936bd0dd786bbbdbb9f263394c
+Source-Hash: blake3:0935b1c74300d0f985a89bd38c3cfd9146d3b7832a514aca4b1d1a2f0db775ed
+Schema-Version: v1
+-->
+
+# Rust Library Integration
+
+```toml
+[dependencies]
+uncomment = "3.10"
+anyhow = "1"
+```
+
+`Processor` and `ConfigManager` expose the same AST-based processing used by the
+CLI. `process_file_with_config` reads the source and returns a `ProcessedFile`; it
+does not write the processed bytes back.
+
+```rust
+use std::path::Path;
+use uncomment::{Processor, config::ConfigManager};
+
+fn preview() -> anyhow::Result<()> {
+    let manager = ConfigManager::new(Path::new("."))?;
+    let mut processor = Processor::new_with_config(&manager);
+    let result = processor.process_file_with_config(Path::new("src/lib.rs"), &manager, None)?;
+    println!("{}", result.processed_content);
+    Ok(())
+}
+```
+
+Use `Processor::inspect` for individual comment records and preservation reasons,
+or `Processor::plan_removals` for byte-range edits. Both accept source text, a path
+and a `ResolvedConfig`. Preserve byte offsets; they are not character indices.
+
+The CLI's `scan`, `keep`, `lint` and removal planner share this inspection surface,
+so use it rather than implementing another comment detector with text matching.
+The language pack is compiled into the binary; no runtime grammar download or
+custom MCP server is part of this library API.

uncomment_hermes_plugin-3.10.3.dist-info/METADATA

@@ -0,0 +1,21 @@
+Metadata-Version: 2.5
+Name: uncomment-hermes-plugin
+Version: 3.10.3
+Summary: Inventory, preserve and remove source comments with AST parsing. Skills only; install the Uncomment CLI separately.
+Project-URL: Repository, https://github.com/Goldziher/uncomment
+License-Expression: MIT
+Keywords: code-cleanup,comments,linting,tree-sitter
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# uncomment Hermes plugin
+
+Inventory, preserve and remove source comments with AST parsing. Skills only; install the Uncomment CLI separately.
+
+Install this package in the same Python environment as Hermes Agent:
+
+```sh
+python -m pip install uncomment-hermes-plugin
+```
+
+Enable the plugin through Hermes Agent's plugin configuration. Available registrations depend on the plugin's authored Hermes adapter.

uncomment_hermes_plugin-3.10.3.dist-info/RECORD

@@ -0,0 +1,11 @@
+uncomment_hermes_plugin/__init__.py,sha256=pQJ_pWq9Z1SYs4-BR6-IoS1ZJQlssyUCw9HyiY5HQkc,385
+uncomment_hermes_plugin/hermes.py,sha256=8FjdeZkdrd2b6Ho84R5E7w2wIzVpFpTP9LmXw46O4JA,851
+uncomment_hermes_plugin/plugin.yaml,sha256=EhWJkRlp9TNR52k-zdoXPzbF9XjoZTN1A3Mp50oer4k,206
+uncomment_hermes_plugin/skills/uncomment/SKILL.md,sha256=59xIRqk-K-1U9AryiwxSXt8zS7hQEnp58JPMQW36fQE,4058
+uncomment_hermes_plugin/skills/uncomment/index.md,sha256=76fgjUko6-6Bm9rw12TvFuV3_rn1orFt0KEzzWyfdd4,505
+uncomment_hermes_plugin/skills/uncomment/references/configuration.md,sha256=PjqHBbs37hWjNNOIgQ_S8LNiGtnh2qjfcXnTichIlro,2875
+uncomment_hermes_plugin/skills/uncomment/references/library.md,sha256=c5tSknk1eEISjkcDHlsov2nKTRDN4JerAI082tJUAh8,1466
+uncomment_hermes_plugin-3.10.3.dist-info/METADATA,sha256=oSiW8PkCo_fpR7Ddao8gVFEL36asbV4ckNJGYzBYxYs,804
+uncomment_hermes_plugin-3.10.3.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+uncomment_hermes_plugin-3.10.3.dist-info/entry_points.txt,sha256=CYsfRWn9nqXjQfqd77JQuYVDuFsFwNJAWGCtwXP5qp8,59
+uncomment_hermes_plugin-3.10.3.dist-info/RECORD,,

uncomment_hermes_plugin-3.10.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

uncomment_hermes_plugin-3.10.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[hermes_agent.plugins]
+uncomment = uncomment_hermes_plugin