@@ -12,23 +12,23 @@ package manager, `just` as the task runner, and `prek` (a parallel pre-commit ru
1212All commands use the ` justfile ` (with imports from ` tests/test.just ` and ` docs/docs.just ` ). Always prefer ` just `
1313commands over direct tool invocation.
1414
15- | Task | Command |
16- | --------------------------------------- | ---------------------- |
17- | Install dependencies | ` just install ` |
18- | Run full test suite | ` just test ` |
19- | Run GDS regression tests only | ` just test-gds ` |
20- | Run GDS tests, stop at first failure | ` just test-gds-fail-fast ` |
21- | Regenerate GDS reference files | ` just test-gds-force ` |
22- | Run model regression tests | ` just test-models ` |
23- | Regenerate model reference files | ` just test-models-force ` |
24- | Run HFSS simulation tests | ` just test-hfss ` |
25- | Run GDSFactory+ tests | ` just test-gfp ` |
26- | Run pre-commit hooks (lint + format) | ` just run-pre ` |
27- | Build HTML documentation | ` just docs ` |
28- | Build PDF documentation | ` just docs-pdf ` |
29- | Build package | ` just build ` |
30- | Show/preview a component interactively | ` just show ` |
31- | Run everything (test, lint, build, docs) | ` just all ` |
15+ | Task | Command |
16+ | ---------------------------------------- | --- ---------------------- |
17+ | Install dependencies | ` just install ` |
18+ | Run full test suite | ` just test ` |
19+ | Run GDS regression tests only | ` just test-gds ` |
20+ | Run GDS tests, stop at first failure | ` just test-gds-fail-fast ` |
21+ | Regenerate GDS reference files | ` just test-gds-force ` |
22+ | Run model regression tests | ` just test-models ` |
23+ | Regenerate model reference files | ` just test-models-force ` |
24+ | Run HFSS simulation tests | ` just test-hfss ` |
25+ | Run GDSFactory+ tests | ` just test-gfp ` |
26+ | Run pre-commit hooks (lint + format) | ` just run-pre ` |
27+ | Build HTML documentation | ` just docs ` |
28+ | Build PDF documentation | ` just docs-pdf ` |
29+ | Build package | ` just build ` |
30+ | Show/preview a component interactively | ` just show ` |
31+ | Run everything (test, lint, build, docs) | ` just all ` |
3232
3333Pre-commit hooks ** must** pass before every commit. They include ` ruff ` (format + lint), ` pyrefly ` (type checking),
3434` yamlfmt ` , ` yamllint ` , ` codespell ` , ` interrogate ` (docstring coverage), ` markdownlint ` , ` mdformat ` , ` actionlint ` ,
@@ -111,8 +111,8 @@ justfile Task runner recipes (imports test.just and docs.just)
111111- Physical constants ** must** come from ` qpdk/models/constants.py ` — verify no local redefinitions of ` e ` , ` h ` , ` Φ_0 ` ,
112112 ` ε_0 ` , etc.
113113- New models need unit tests in ` tests/models/ ` verifying behavior, passivity, and reciprocity.
114- - HFSS/Q3D simulation automation lives in ` qpdk/simulation/ ` — changes there should be tested with ` just test-hfss `
115- when HFSS is available.
114+ - HFSS/Q3D simulation automation lives in ` qpdk/simulation/ ` — changes there should be tested with ` just test-hfss ` when
115+ HFSS is available.
116116
117117### Testing
118118
0 commit comments