Merged
Conversation
Contributor
ipmach
commented
Feb 25, 2026
- Adapt the workspace to be use with the new version of detectmate.
- Add a more friendly way to add new parsers, detectors.
- Improve documentation for the workspace usage.
Collaborator
|
Looks good to me! There are only some small spelling mistakes, maybe @copilot can handle this? |
There was a problem hiding this comment.
Pull request overview
This PR updates the workspace generator and related docs/templates to better support the newer DetectMate workflow, including bundled example data and more “run it immediately” template entry points.
Changes:
- Add example
data.jsongeneration for new parser/detector workspaces and update workspace creation tests accordingly. - Update workspace templates (parser/detector) with runnable
__main__examples usingFrom.json(...). - Refresh documentation (MkDocs + getting started docs) and reduce component processing log verbosity (info → debug).
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_workspace/test_create_workspace.py | Adds an assertion that parser workspaces generate data.json. |
| src/tools/workspace/create_workspace.py | Copies example data into generated workspaces; updates template/test rewriting. |
| src/tools/workspace/utils.py | Updates generated README instructions (setup + running examples). |
| src/tools/workspace/templates/CustomParser.py | Adds From usage and a runnable __main__ example. |
| src/tools/workspace/templates/CustomDetector.py | Adds From usage and a runnable __main__ example. |
| src/tools/workspace/templates/data/logs.json | Adds example input log data template for parser workspaces. |
| src/tools/workspace/templates/data/parsed_log.json | Adds example parsed-log data template for detector workspaces. |
| src/detectmatelibrary/common/core.py | Lowers verbosity of processed-output logging (debug instead of info). |
| mkdocs.yml | Removes the “Implement new component” page from navigation. |
| docs/index.md | Removes the “Implement new component” link from the index. |
| docs/implement_components.md | Deletes the (mostly empty) implement-components page. |
| docs/create_components.md | Improves workspace generation docs and adds “data.json” + library integration notes. |
| docs/basic_usage.md | Expands basic usage documentation with parser/detector examples and sample JSON outputs. |
| README.md | Updates the workspace tree example to include data.json. |
Comments suppressed due to low confidence (1)
src/tools/workspace/utils.py:85
- The README text says “Install Git hooks from .pre-commit-config.yaml using prek”, but the command shown is
uv sync.uv syncdoesn’t install Git hooks and may fail without a lockfile; this should likely remainprek install(after ensuringprekis installed via the[dev]extras) or the surrounding text should be updated to match the intended workflow.
```bash
# Install Git hooks from .pre-commit-config.yaml using prek
uv sync
# You can run all hooks on the full codebase with:
# prek run --all-files
```
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.