Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ workspaces/custom_parser/ # workspace root
├── custom_parser/ # Python package
│ ├── __init__.py
│ └── custom_parser.py # CoreParser-based template
├── tests/
├── detectmatelibrary_tests/
│ └── test_custom_parser.py # generated from template to test custom_parser
├── data.json # example data to run the code
├── LICENSE.md # copied from main project
Expand Down
6 changes: 3 additions & 3 deletions docs/create_components.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ workspaces/custom_parser/ # workspace root
├── custom_parser/ # Python package
│ ├── __init__.py
│ └── custom_parser.py # CoreParser-based template
├── tests/
├── detectmatelibrary_test/
│ └── test_custom_parser.py # generated from template to test custom_parser
├── data.json # example data to run the code
├── LICENSE.md # copied from main project
Expand All @@ -49,8 +49,8 @@ workspaces/custom_parser/ # workspace root

To add the new component to the `DetectMateLibrary`, you need to add the component file to the specific folder and update the import paths.

* **Detector**: Add the detector file component in `src/detectmatelibrary/detectors` and the unit tests in `tests/test_detectors`.
* **Parsers**: Add the parser file component in `src/detectmatelibrary/parsers` and the unit tests in `tests/test_parsers`.
* **Detector**: Add the detector file component in `src/detectmatelibrary/detectors` and the unit tests in `detectmatelibrary_test/test_detectors`.
* **Parsers**: Add the parser file component in `src/detectmatelibrary/parsers` and the unit tests in `detectmatelibrary_test/test_parsers`.

Once that is complete, **ensure that all unit tests and the pre-commit process are successful**.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ uv run --dev pytest --cov=. --cov-report=term-missing

**Tips**:

- Run a single test or directory to speed iteration: `uv run --dev pytest tests/some_test.py::test_name -q`
- Run a single test or directory to speed iteration: `uv run --dev pytest detectmatelibrary_tests/some_test.py::test_name -q`

## Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion src/detectmatelibrary_tools/workspace/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def create_readme(name: str, ws_type: str, target_impl: Path, target_dir: Path)
## Contents

- `{normalize(name)}/{target_impl.name}`: starting point for your `{ws_type}` implementation.
- `tests/test_{target_impl.name}`: unit tests for your `{ws_type}`.
- `detectmatelibrary_tests/test_{target_impl.name}`: unit tests for your `{ws_type}`.
- `LICENSE.md`: EUPL-1.2 license copied from the main project.
- `.pre-commit-config.yaml`: recommended pre-commit hook configuration.
- `.gitignore`: standard ignore rules.
Expand Down
Loading