diff --git a/CHANGES.md b/CHANGES.md index ffbd356..688e411 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -16,6 +16,8 @@ ## 0.6.0 - 18th September 2026 +* Phase 3 companion: **misc-config-scripts** **0.8.2** removed legacy catalogs; this repo remains sole project-drop-in home; +* Updated **README.md** / **templates/** READMEs for post-cutover ownership (m-c-s **`.commonrc`** / **`.gitconfig`** only); * Phase 2: populate **templates/** as the canonical project drop-in catalogue: * **templates/vscode/** — migrated from **misc-config-scripts** `settings.json/` (plus **c_cxx** alias of **cxx**); * **templates/gitattributes/** — migrated from **misc-config-scripts** `gitattributes/`; diff --git a/NEWS.md b/NEWS.md index f3eace4..b80290d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -3,7 +3,7 @@ | Date | News Item | Details | | -------------------- | --------- | ------- | -| 18th September 2026 | [**misc-dev-scripts** 0.6.0](https://github.com/synesissoftware/misc-dev-scripts/releases/tag/0.6.0) released | Phase 0–2: templates catalogue populated | +| 18th September 2026 | [**misc-dev-scripts** 0.6.0](https://github.com/synesissoftware/misc-dev-scripts/releases/tag/0.6.0) released | Phase 0–3: sole project drop-in catalogue | | 14th September 2026 | [**misc-dev-scripts** 0.5.1](https://github.com/synesissoftware/misc-dev-scripts/releases/tag/0.5.1) released | Python `.sis` help + prefer project `.venv` | | 1st September 2026 | [**misc-dev-scripts** 0.5.0](https://github.com/synesissoftware/misc-dev-scripts/releases/tag/0.5.0) released | JavaScript `run_all_unit_tests` runner | | 25th August 2026 | [**misc-dev-scripts** 0.4.2](https://github.com/synesissoftware/misc-dev-scripts/releases/tag/0.4.2) released | Ruby `tput` TERM/TTY guard | diff --git a/README.md b/README.md index 8d47a90..ee7446d 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Miscellaneous Development Scripts ## Table of Contents - [Introduction](#introduction) -- [Ownership and migration (Phase 0)](#ownership-and-migration-phase-0) +- [Ownership and migration](#ownership-and-migration) - [Catalogue layout](#catalogue-layout) - [Shell Scripts](#shell-scripts) - [run\_all\_unit\_tests.sh](#run_all_unit_testssh) @@ -28,12 +28,12 @@ Miscellaneous Development Scripts Today the shipped helpers are principally **run_all_unit_tests.sh** variants for **JavaScript**, **Python**, and **Ruby**, with further languages and template families planned. When updating a consumer, cite this repository’s **VERSION** in that project’s **CHANGES.md**. -Sibling project: [**misc-config-scripts**](https://github.com/synesissoftware/misc-config-scripts) (**`.commonrc`** and **`.gitconfig`** only after cutover). +Sibling project: [**misc-config-scripts**](https://github.com/synesissoftware/misc-config-scripts) (**`.commonrc`** and **`.gitconfig`** only). -## Ownership and migration (Phase 0) +## Ownership and migration -**Status: Phase 2 complete — `templates/` is populated and is the canonical home for project drop-ins.** Legacy copies may still exist in **misc-config-scripts** until that repo’s Phase 3. +**Status: Phase 3 complete — this repository’s `templates/` is the sole canonical home for project drop-ins.** **misc-config-scripts** **0.8.2+** ships **`.commonrc`** / **`.gitconfig`** only. Distinguish **self** boilerplate (this repository’s own root editor/Git files) from **templates** (copied into other projects). @@ -41,9 +41,7 @@ Distinguish **self** boilerplate (this repository’s own root editor/Git files) | --- | --- | --- | | **Self** **`.editorconfig`**, **`.gitattributes`**, **`.gitignore`**, **`.vimrc`**, **`.vscode/settings.json`** | ✅ | ✅ | | **Templates:** **`.gitconfig`**, **`.commonrc`** | ✅ only | ❌ | -| **Templates:** language-specific **`run_all_unit_tests.sh`**, **`.editorconfig`**, **`.gitattributes`**, **`.gitignore`**, **`.vimrc`**, **`.vscode/settings.json`** | ❌ (legacy frozen) | ✅ only | - -Until **misc-config-scripts** Phase 3 removes its legacy trees, prefer **this** repository’s **`templates/`** for new copies of VS Code settings and **`.gitattributes`**. Do **not** add new language templates under **misc-config-scripts**. +| **Templates:** language-specific **`run_all_unit_tests.sh`**, **`.editorconfig`**, **`.gitattributes`**, **`.gitignore`**, **`.vimrc`**, **`.vscode/settings.json`** | ❌ | ✅ only | ## Catalogue layout @@ -87,18 +85,18 @@ Use `--help` on any variant for the authoritative flag list. See [**templates/README.md**](./templates/README.md). Families: -* [**editorconfig**](./templates/editorconfig/README.md); -* [**gitattributes**](./templates/gitattributes/README.md); -* [**gitignore**](./templates/gitignore/README.md); -* [**vimrc**](./templates/vimrc/README.md); -* [**vscode**](./templates/vscode/README.md); +* [**.editorconfig**](./templates/editorconfig/README.md); +* [**.gitattributes**](./templates/gitattributes/README.md); +* [**.gitignore**](./templates/gitignore/README.md); +* [**.vimrc**](./templates/vimrc/README.md); +* [**.vscode/**](./templates/vscode/README.md); -**Phase 2:** all families populated for every language key — ready to copy. +**Phase 2:** all families populated for every language key — ready to copy. **misc-config-scripts** **0.8.2+** no longer ships legacy catalogs. ## Related projects -A peer project that provides **`.commonrc`** and **`.gitconfig`** (and, until cutover, legacy project settings / gitattributes catalogs) is [**misc-config-scripts**](https://github.com/synesissoftware/misc-config-scripts). +A peer project that provides **`.commonrc`** and **`.gitconfig`** is [**misc-config-scripts**](https://github.com/synesissoftware/misc-config-scripts) (**0.8.2+**). Resources from this project are used in the following projects (case-insensitive lexicographic order): diff --git a/TODO.md b/TODO.md index 26c0909..f4feba2 100644 --- a/TODO.md +++ b/TODO.md @@ -91,7 +91,8 @@ * [x] ~~~Phase 0: declare ownership; scaffold **templates/** catalogue layout + READMEs~~~ - ✅; * [x] ~~~Phase 1: complete **self** boilerplate (**`.editorconfig`**; retarget root **`.vimrc`** as self for this Bash catalog, not C/C++ consumer gold; seed **templates/vimrc/c_cxx/.vimrc**)~~~ - ✅; * [x] ~~~Phase 2: populate **templates/** from freelibs exemplars and migrate **misc-config-scripts** `settings.json/` + `gitattributes/` content~~~ - ✅; -* [ ] Phase 4: refresh this repo’s self **`.vscode/settings.json`** (and related self files) from **templates/vscode/generic/** (or shell-appropriate) once populated; +* [x] ~~~Phase 3 companion: **misc-config-scripts** **0.8.2** removed legacy catalogs; this repo remains sole project-drop-in home~~~ - ✅; +* [ ] Phase 4: refresh this repo’s self **`.vscode/settings.json`** (and related self files) from **templates/vscode/generic/** (or shell-appropriate); * [ ] Later: hoist **build_dist.sh** / **build_dist_uv.sh** (Python), **build_gem.sh** (Ruby), **rustfmt.toml** / **scripts/fmt** (Rust), Go **build.sh** / runners, and further common helpers under **shell-scripts/** or **templates/** as appropriate; * [ ] Optional: sample bootstrap notes for copy-vs-sync adoption; * [ ] Distribution / drift control: `SCRIPT_VERSION` header matching **VERSION**; document consumer CHANGES citation convention; optional sync helper; optional `testdata/` CI fixtures; diff --git a/templates/README.md b/templates/README.md index 9170bde..abe4b96 100644 --- a/templates/README.md +++ b/templates/README.md @@ -19,14 +19,14 @@ This tree is the **canonical catalogue** for project-local config files that con ## Status -**Phase 2 (populated):** all five families × eleven language keys hold copyable templates. Prefer these paths over the legacy catalogs still present (frozen) in **misc-config-scripts** `settings.json/` and `gitattributes/` until that repo’s Phase 3 removal. +**Phase 3 complete:** all five families × eleven language keys hold copyable templates. This tree is the sole canonical home (legacy **misc-config-scripts** `settings.json/` and `gitattributes/` catalogs removed in that repo’s **0.8.2**). ## Self boilerplate vs templates | Kind | Where | Purpose | | --- | --- | --- | -| **Self** | Repository root (e.g. this project’s own **`.vimrc`**, **`.gitignore`**) | Configures *this* repository | +| **Self** | Repository root (e.g. this project's own **`.vimrc`**, **`.gitignore`**) | Configures *this* repository | | **Template** | Under **`templates///`** | Copied into *other* projects | Do not confuse root self files with the catalogue under **`templates/`**. @@ -91,7 +91,7 @@ When updating a consumer, cite this repository’s **VERSION** in that project ## Related * [**shell-scripts/run_all_unit_tests/README.md**](../shell-scripts/run_all_unit_tests/README.md) — test-runner helpers; -* Sibling [**misc-config-scripts**](https://github.com/synesissoftware/misc-config-scripts) — **`.gitconfig`** and **`.commonrc`**; legacy project catalogs frozen until Phase 3. +* Sibling [**misc-config-scripts**](https://github.com/synesissoftware/misc-config-scripts) — **`.gitconfig`** and **`.commonrc`** only (**0.8.2+**); diff --git a/templates/gitattributes/README.md b/templates/gitattributes/README.md index 8bfd9db..3dbf192 100644 --- a/templates/gitattributes/README.md +++ b/templates/gitattributes/README.md @@ -1,7 +1,7 @@ # `.gitattributes` templates -**Status:** Phase 2 — canonical copies live here (migrated from **misc-config-scripts** `gitattributes/`). +**Status:** Canonical copies live here (migrated from former **misc-config-scripts** `gitattributes/` catalogs; that tree was removed in **misc-config-scripts** **0.8.2**). Drop-in root **`.gitattributes`** files for GitHub-hosted repositories, organised by primary language. diff --git a/templates/vscode/README.md b/templates/vscode/README.md index 2f3c74a..0f66eed 100644 --- a/templates/vscode/README.md +++ b/templates/vscode/README.md @@ -1,7 +1,7 @@ # VS Code `settings.json` templates -**Status:** Phase 2 — canonical copies live here (migrated from **misc-config-scripts** `settings.json/`). +**Status:** Canonical copies live here (migrated from former **misc-config-scripts** `settings.json/` catalogs; that tree was removed in **misc-config-scripts** **0.8.2**). Drop-in workspace settings for Synesis / related projects, organised by primary language.