|
| 1 | +== Configuration |
| 2 | + |
| 3 | +The plugin is configured in your `pyproject.toml` file under `[tool.hatch.build.hooks.reqstool]`. |
| 4 | + |
| 5 | +=== Complete Configuration Example |
| 6 | + |
| 7 | +[source,toml] |
| 8 | +---- |
| 9 | +[tool.hatch.build.hooks.reqstool] |
| 10 | +# Build hook dependency |
| 11 | +dependencies = ["reqstool-python-hatch-plugin"] |
| 12 | +
|
| 13 | +# Directories to scan for decorators |
| 14 | +# Default: ["src", "tests"] |
| 15 | +sources = ["src", "tests"] |
| 16 | +
|
| 17 | +# Test result file pattern(s) |
| 18 | +# Default: "build/junit.xml" |
| 19 | +test_results = "build/junit.xml" |
| 20 | +
|
| 21 | +# Directory containing requirements.yml and optional files |
| 22 | +# Default: "docs/reqstool" |
| 23 | +dataset_directory = "docs/reqstool" |
| 24 | +
|
| 25 | +# Output directory for generated annotations |
| 26 | +# Default: "build/reqstool" |
| 27 | +output_directory = "build/reqstool" |
| 28 | +---- |
| 29 | + |
| 30 | +=== Configuration Parameters |
| 31 | + |
| 32 | +==== sources |
| 33 | + |
| 34 | +Directories to scan for `@Requirements` and `@SVCs` decorators. |
| 35 | +Defaults to `["src", "tests"]`. |
| 36 | + |
| 37 | +[source,toml] |
| 38 | +---- |
| 39 | +sources = ["src", "tests"] |
| 40 | +---- |
| 41 | + |
| 42 | +==== test_results |
| 43 | + |
| 44 | +Path or pattern for test result files (JUnit XML). |
| 45 | +Defaults to `"build/junit.xml"`. |
| 46 | + |
| 47 | +[source,toml] |
| 48 | +---- |
| 49 | +test_results = "build/junit.xml" |
| 50 | +---- |
| 51 | + |
| 52 | +==== dataset_directory |
| 53 | + |
| 54 | +Directory containing `requirements.yml` and optional reqstool files (`software_verification_cases.yml`, `manual_verification_results.yml`). |
| 55 | +Defaults to `"docs/reqstool"`. |
| 56 | + |
| 57 | +[source,toml] |
| 58 | +---- |
| 59 | +dataset_directory = "docs/reqstool" |
| 60 | +---- |
| 61 | + |
| 62 | +==== output_directory |
| 63 | + |
| 64 | +Output directory for the generated `annotations.yml`. |
| 65 | +Defaults to `"build/reqstool"`. |
| 66 | + |
| 67 | +[source,toml] |
| 68 | +---- |
| 69 | +output_directory = "build/reqstool" |
| 70 | +---- |
0 commit comments