25 lines
1.3 KiB
Markdown
25 lines
1.3 KiB
Markdown
|
# ProjectStructure Configuration
|
|||
|
|
|
|||
|
|
The repository reads user preferences from `config.json` in the ProjectStructure
|
|||
|
|
root (copied alongside helper batches when they are deployed to projects).
|
|||
|
|
|
|||
|
|
## Keys
|
|||
|
|
|
|||
|
|
| Key | Type | Meaning |
|
|||
|
|
| --- | --- | --- |
|
|||
|
|
| `dailyFormat` | bool | `true` → daily folders named `YYYY-MM-DD`; `false` → `daily_*` style. |
|
|||
|
|
| `structDir` | string | Absolute or relative path to the canonical ProjectStructure directory. Blank values default to the folder containing `config.json`. |
|
|||
|
|
| `projectsRoot` | string (optional) | Override for the root directory scanned by `UpgradeSeqBatches.ps1`. Defaults to the parent of `structDir`. |
|
|||
|
|
| `zipper` | bool | `true` → use 7‑Zip (if available); `false` → use Python’s built-in zipfile module. |
|
|||
|
|
| `compression` | int | Compression level `0-9` (0 = store only, 9 = max). Applies to both zipfile and 7‑Zip. |
|
|||
|
|
|
|||
|
|
## Notes
|
|||
|
|
|
|||
|
|
- `UpgradeSeqBatches.ps1` copies `config.json` and `ConfigLoader.ps1` to every
|
|||
|
|
target folder so the helper `.bat` launchers can resolve script locations.
|
|||
|
|
- When `zipper` is `true`, the tool searches for `7z`/`7za` on `PATH`. If neither
|
|||
|
|
is found it logs a warning and falls back to `zipfile`.
|
|||
|
|
- Leaving `structDir` empty is safe—the scripts fall back to the directory that
|
|||
|
|
contains `config.json`.
|
|||
|
|
|