Skip to content

Workspace adaptation#62

Merged
viktorbeck98 merged 16 commits intodevelopmentfrom
adapt/workspace
Mar 6, 2026
Merged

Workspace adaptation#62
viktorbeck98 merged 16 commits intodevelopmentfrom
adapt/workspace

Conversation

@ipmach
Copy link
Contributor

@ipmach 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.

@ipmach ipmach changed the title Adding data to workspace and change a log to debug mode Workspsace adaptation Feb 25, 2026
@ipmach ipmach changed the title Workspsace adaptation Workspace adaptation Feb 25, 2026
@ipmach ipmach marked this pull request as ready for review February 26, 2026 15:15
@ipmach ipmach added the enhancement New feature or request label Feb 26, 2026
@viktorbeck98
Copy link
Collaborator

Looks good to me!

There are only some small spelling mistakes, maybe @copilot can handle this?

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.json generation for new parser/detector workspaces and update workspace creation tests accordingly.
  • Update workspace templates (parser/detector) with runnable __main__ examples using From.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 sync doesn’t install Git hooks and may fail without a lockfile; this should likely remain prek install (after ensuring prek is 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.

viktorbeck98 and others added 4 commits March 2, 2026 12:07
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>
@viktorbeck98 viktorbeck98 merged commit 18a0bf4 into development Mar 6, 2026
1 check passed
@viktorbeck98 viktorbeck98 deleted the adapt/workspace branch March 6, 2026 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants