coentrify 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (261) hide show
  1. package/LICENSE +18 -0
  2. package/README.md +5 -4
  3. package/bin/coentrify.js +79 -12
  4. package/package.json +3 -2
  5. package/src/changelog/0.0.1.md +259 -0
  6. package/src/changelog/0.0.2.md +219 -0
  7. package/src/changelog/0.0.3.md +81 -0
  8. package/src/changelog/0.0.4.md +198 -0
  9. package/src/changelog/0.0.5.md +160 -0
  10. package/src/changelog/0.0.6.md +282 -0
  11. package/src/changelog/0.0.7.md +113 -0
  12. package/src/changelog/0.0.8.md +212 -0
  13. package/src/changelog/0.1.0.md +9 -0
  14. package/src/changelog/overview.md +13 -0
  15. package/src/coentrify-json.md +72 -0
  16. package/src/commands.md +48 -0
  17. package/src/glossary.md +132 -0
  18. package/src/how-it-works.md +51 -0
  19. package/src/onboarding.md +140 -0
  20. package/src/origin.md +19 -0
  21. package/src/philosophy.md +99 -0
  22. package/src/proof.md +596 -0
  23. package/src/readme.md +76 -0
  24. package/src/recommendations.md +100 -0
  25. package/src/standards/ai/match-known-commands-deterministically-classify-the-rest.md +22 -0
  26. package/src/standards/ai/overview.md +6 -0
  27. package/src/standards/ai/prompt-small-models-differently.md +21 -0
  28. package/src/standards/angular/canmatch-wildcard-for-route-access.md +22 -0
  29. package/src/standards/angular/interface-not-abstract-class-for-mock-swap.md +37 -0
  30. package/src/standards/angular/no-any-in-templates.md +25 -0
  31. package/src/standards/angular/no-inline-templates.md +14 -0
  32. package/src/standards/angular/one-component-per-folder-flat.md +12 -0
  33. package/src/standards/angular/one-projected-node-per-control-flow-block.md +19 -0
  34. package/src/standards/angular/overview.md +16 -0
  35. package/src/standards/angular/prefer-content-projection-over-props-angular.md +17 -0
  36. package/src/standards/angular/projected-content-is-never-styled-by-the-host.md +23 -0
  37. package/src/standards/angular/static-attribute-not-literal-binding.md +23 -0
  38. package/src/standards/angular/track-timed-items-by-an-id.md +17 -0
  39. package/src/standards/angular/ui-copy-in-template.md +26 -0
  40. package/src/standards/angular/use-modern-angular-template-apis.md +20 -0
  41. package/src/standards/architecture/adopt-configure-override.md +25 -0
  42. package/src/standards/architecture/app-shield.md +57 -0
  43. package/src/standards/architecture/converge-only-once-proven.md +22 -0
  44. package/src/standards/architecture/folder-concerns.md +28 -0
  45. package/src/standards/architecture/overview.md +11 -0
  46. package/src/standards/architecture/per-application-split-over-shared-branching.md +25 -0
  47. package/src/standards/architecture/separation-before-layer-standards.md +17 -0
  48. package/src/standards/architecture/unique-where-it-counts.md +19 -0
  49. package/src/standards/behavior/a-go-before-work-elsewhere.md +17 -0
  50. package/src/standards/behavior/a-maybe-is-a-trigger-to-investigate.md +20 -0
  51. package/src/standards/behavior/a-name-describes-its-unit.md +19 -0
  52. package/src/standards/behavior/a-quiet-tree-while-a-suite-runs.md +19 -0
  53. package/src/standards/behavior/always-make-no-mistakes.md +45 -0
  54. package/src/standards/behavior/always-verify-before-reporting-done.md +18 -0
  55. package/src/standards/behavior/always-work-from-a-plan.md +29 -0
  56. package/src/standards/behavior/anchor-edits-after-formatting.md +17 -0
  57. package/src/standards/behavior/backward-trace-missing-prerequisites.md +20 -0
  58. package/src/standards/behavior/code-review-compounds-into-patterns-and-sweeps.md +21 -0
  59. package/src/standards/behavior/communication-boundary.md +18 -0
  60. package/src/standards/behavior/dev-tiers.md +25 -0
  61. package/src/standards/behavior/docs-hold-only-what-the-director-decided.md +23 -0
  62. package/src/standards/behavior/dont-filter-data-without-a-spec.md +20 -0
  63. package/src/standards/behavior/dont-introduce-tech-debt.md +25 -0
  64. package/src/standards/behavior/feature-workflow.md +31 -0
  65. package/src/standards/behavior/file-a-change-with-coentrify.md +24 -0
  66. package/src/standards/behavior/flag-every-addition-of-your-own.md +22 -0
  67. package/src/standards/behavior/free-text-replies-no-buttons.md +20 -0
  68. package/src/standards/behavior/general-working-rules.md +37 -0
  69. package/src/standards/behavior/non-destructive-documenting-and-test-automation.md +20 -0
  70. package/src/standards/behavior/normal-dashes.md +15 -0
  71. package/src/standards/behavior/note-issues.md +26 -0
  72. package/src/standards/behavior/overview.md +46 -0
  73. package/src/standards/behavior/own-ports-own-processes.md +37 -0
  74. package/src/standards/behavior/project-lifecycle.md +21 -0
  75. package/src/standards/behavior/propagate-renames-and-convention-changes-everywhere.md +16 -0
  76. package/src/standards/behavior/prose-style.md +24 -0
  77. package/src/standards/behavior/prototype-mode-is-speed-first.md +20 -0
  78. package/src/standards/behavior/regular-layered-gap-analysis.md +20 -0
  79. package/src/standards/behavior/reload-the-standards-after-compacting.md +16 -0
  80. package/src/standards/behavior/review-changes-before-reporting-done.md +17 -0
  81. package/src/standards/behavior/review-every-capture-before-reporting.md +21 -0
  82. package/src/standards/behavior/standards-maintenance.md +65 -0
  83. package/src/standards/behavior/standards-over-skills.md +17 -0
  84. package/src/standards/behavior/sweeps-enumerate-into-tech-debt-first.md +20 -0
  85. package/src/standards/behavior/sync-the-docs-after-every-change.md +20 -0
  86. package/src/standards/behavior/the-quality-of-the-question.md +17 -0
  87. package/src/standards/behavior/things-of-one-kind-are-consistent.md +20 -0
  88. package/src/standards/behavior/understand-the-need.md +69 -0
  89. package/src/standards/behavior/use-us-english-everywhere.md +17 -0
  90. package/src/standards/behavior/verify-apis-against-docs-and-the-installed-artifact.md +17 -0
  91. package/src/standards/behavior/verify-control-before-rename.md +11 -0
  92. package/src/standards/code/code-principles.md +32 -0
  93. package/src/standards/code/escape-hatch-comments.md +20 -0
  94. package/src/standards/code/name-by-concept-not-copy.md +20 -0
  95. package/src/standards/code/no-abbreviated-names.md +20 -0
  96. package/src/standards/code/no-describe-what-comments.md +26 -0
  97. package/src/standards/code/overview.md +10 -0
  98. package/src/standards/code/pre-empt-recurring-code-review-nits.md +31 -0
  99. package/src/standards/commits/commits.md +44 -0
  100. package/src/standards/commits/gate-commits-on-exit-codes.md +22 -0
  101. package/src/standards/commits/main-stays-green-work-stays-clean.md +23 -0
  102. package/src/standards/commits/overview.md +8 -0
  103. package/src/standards/commits/verify-staging-before-committing.md +29 -0
  104. package/src/standards/docs/application-template.md +89 -0
  105. package/src/standards/docs/docs-are-hierarchical-explicit-and-short.md +48 -0
  106. package/src/standards/docs/docs-describe-behavior-not-wiring.md +24 -0
  107. package/src/standards/docs/docs-folder-structure.md +38 -0
  108. package/src/standards/docs/docs-state-knowledge.md +23 -0
  109. package/src/standards/docs/documentation-philosophy.md +62 -0
  110. package/src/standards/docs/feature-spec-template.md +89 -0
  111. package/src/standards/docs/feature-template.md +62 -0
  112. package/src/standards/docs/file-names.md +20 -0
  113. package/src/standards/docs/glossary.md +18 -0
  114. package/src/standards/docs/library-feedback.md +20 -0
  115. package/src/standards/docs/no-faux-headers-in-lists.md +18 -0
  116. package/src/standards/docs/overview.md +20 -0
  117. package/src/standards/docs/ui-vocabulary.md +31 -0
  118. package/src/standards/docs/workspace-levels.md +24 -0
  119. package/src/standards/docs/workspace-suite.md +24 -0
  120. package/src/standards/docs/workspace-template.md +41 -0
  121. package/src/standards/e2e/e2e-assert-before-interacting.md +21 -0
  122. package/src/standards/e2e/e2e-mock-contract.md +20 -0
  123. package/src/standards/e2e/e2e-runs-on-the-development-build.md +18 -0
  124. package/src/standards/e2e/e2e-test-conventions.md +61 -0
  125. package/src/standards/e2e/e2e-tests-must-demonstrate-behavior.md +28 -0
  126. package/src/standards/e2e/one-check-for-many-canvas-clicks.md +17 -0
  127. package/src/standards/e2e/overview.md +14 -0
  128. package/src/standards/e2e/per-feature-overview-test.md +30 -0
  129. package/src/standards/e2e/real-input-for-frame-races.md +25 -0
  130. package/src/standards/e2e/substring-locator-collisions.md +23 -0
  131. package/src/standards/e2e/use-the-e2e-pipeline-for-browser-probing.md +18 -0
  132. package/src/standards/electron/electron-packaging-and-suite.md +22 -0
  133. package/src/standards/electron/electron-shell-shape.md +21 -0
  134. package/src/standards/electron/overview.md +6 -0
  135. package/src/standards/gamedev/2d-visual-design.md +22 -0
  136. package/src/standards/gamedev/budget-exceptions.json +6 -0
  137. package/src/standards/gamedev/captures-and-reels.md +39 -0
  138. package/src/standards/gamedev/devbox.md +21 -0
  139. package/src/standards/gamedev/game-design-laws-experience.md +68 -0
  140. package/src/standards/gamedev/game-design-laws-guidance.md +43 -0
  141. package/src/standards/gamedev/game-design-laws-own-style.md +33 -0
  142. package/src/standards/gamedev/game-design-laws-progress.md +54 -0
  143. package/src/standards/gamedev/game-design-laws-quality.md +30 -0
  144. package/src/standards/gamedev/game-design-laws-story.md +45 -0
  145. package/src/standards/gamedev/game-design-laws-ui.md +52 -0
  146. package/src/standards/gamedev/game-design-laws-world.md +38 -0
  147. package/src/standards/gamedev/game-design-laws.md +112 -0
  148. package/src/standards/gamedev/game-phases-concept.md +29 -0
  149. package/src/standards/gamedev/game-phases-design.md +39 -0
  150. package/src/standards/gamedev/game-phases-development.md +30 -0
  151. package/src/standards/gamedev/game-phases-live.md +19 -0
  152. package/src/standards/gamedev/game-phases.md +52 -0
  153. package/src/standards/gamedev/game-work-workflow.md +47 -0
  154. package/src/standards/gamedev/gamedev-working-cadence.md +52 -0
  155. package/src/standards/gamedev/incremental-pacing.md +22 -0
  156. package/src/standards/gamedev/launch-strategy.md +50 -0
  157. package/src/standards/gamedev/measure-sound-never-guess.md +24 -0
  158. package/src/standards/gamedev/overview.md +29 -0
  159. package/src/standards/gamedev/own-icons.md +19 -0
  160. package/src/standards/gamedev/silent-runs.md +26 -0
  161. package/src/standards/gamedev/sprite-sheet-frames.md +23 -0
  162. package/src/standards/overview.md +43 -0
  163. package/src/standards/records/activity-log.md +33 -0
  164. package/src/standards/records/changelog-per-version.md +43 -0
  165. package/src/standards/records/healing-log.md +23 -0
  166. package/src/standards/records/overview.md +10 -0
  167. package/src/standards/records/playtest-files.md +38 -0
  168. package/src/standards/records/request-log.md +30 -0
  169. package/src/standards/records/user-test-files.md +21 -0
  170. package/src/standards/reporting/change-report.md +43 -0
  171. package/src/standards/reporting/overview.md +6 -0
  172. package/src/standards/reporting/reels-and-video-proof.md +32 -0
  173. package/src/standards/scripts/no-npx-in-scripts.md +20 -0
  174. package/src/standards/scripts/npm-script-naming.md +43 -0
  175. package/src/standards/scripts/overview.md +7 -0
  176. package/src/standards/scripts/thin-wrappers-in-ci-and-hooks.md +25 -0
  177. package/src/standards/security/keep-personal-data-out-of-requests.md +16 -0
  178. package/src/standards/security/keep-secrets-away-from-agents.md +21 -0
  179. package/src/standards/security/never-access-the-keychain.md +16 -0
  180. package/src/standards/security/overview.md +7 -0
  181. package/src/standards/simple-workflow/bugs-template.md +38 -0
  182. package/src/standards/simple-workflow/overview.md +12 -0
  183. package/src/standards/simple-workflow/plan-template.md +50 -0
  184. package/src/standards/simple-workflow/plans-vs-persistent-files.md +31 -0
  185. package/src/standards/simple-workflow/remove-completed-items-from-docs.md +19 -0
  186. package/src/standards/simple-workflow/roadmap-template.md +41 -0
  187. package/src/standards/simple-workflow/technical-debt-template.md +44 -0
  188. package/src/standards/simple-workflow/the-simple-workflow.md +48 -0
  189. package/src/standards/simple-workflow/todo-template.md +31 -0
  190. package/src/standards/tests/a-bugs-test-reproduces-with-real-input.md +18 -0
  191. package/src/standards/tests/bracket-state-changes-with-contrast-assertions.md +37 -0
  192. package/src/standards/tests/gestures-in-tests.md +35 -0
  193. package/src/standards/tests/implementation-agnostic-assertions.md +20 -0
  194. package/src/standards/tests/implementation-agnostic-locators.md +18 -0
  195. package/src/standards/tests/overview.md +13 -0
  196. package/src/standards/tests/realistic-test-data-variance.md +24 -0
  197. package/src/standards/tests/seed-surfaces-every-state-on-page-1.md +17 -0
  198. package/src/standards/tests/test-design.md +47 -0
  199. package/src/standards/tests/test-the-system-behind-a-mock.md +21 -0
  200. package/src/standards/tickets-workflow/agent-roles.md +54 -0
  201. package/src/standards/tickets-workflow/budget-exceptions.json +6 -0
  202. package/src/standards/tickets-workflow/building-a-ticket.md +47 -0
  203. package/src/standards/tickets-workflow/overview.md +15 -0
  204. package/src/standards/tickets-workflow/stabilize-before-adding.md +18 -0
  205. package/src/standards/tickets-workflow/the-builder.md +28 -0
  206. package/src/standards/tickets-workflow/the-conductor.md +44 -0
  207. package/src/standards/tickets-workflow/the-done-part.md +23 -0
  208. package/src/standards/tickets-workflow/ticket-template.md +96 -0
  209. package/src/standards/tickets-workflow/work-item-names.md +30 -0
  210. package/src/standards/tickets-workflow/work-tracking.md +177 -0
  211. package/src/standards/tickets-workflow/work-workflow.md +123 -0
  212. package/src/standards/tickets-workflow/writing-a-ticket.md +50 -0
  213. package/src/standards/tooling/browser-captures-go-to-disk.md +20 -0
  214. package/src/standards/tooling/check-where-a-pane-click-landed.md +19 -0
  215. package/src/standards/tooling/defer-tooling-until-the-cost-shows-up.md +19 -0
  216. package/src/standards/tooling/develop-against-mocks.md +19 -0
  217. package/src/standards/tooling/hygiene-tests-run-on-their-own-runner.md +18 -0
  218. package/src/standards/tooling/lightweight-test-reporting-only.md +16 -0
  219. package/src/standards/tooling/node-versions.md +24 -0
  220. package/src/standards/tooling/overview.md +17 -0
  221. package/src/standards/tooling/parallel-agents.md +45 -0
  222. package/src/standards/tooling/playwright-parallel-runs.md +30 -0
  223. package/src/standards/tooling/playwright-video-recording.md +32 -0
  224. package/src/standards/tooling/read-before-you-truncate.md +19 -0
  225. package/src/standards/tooling/start-playwright-on-a-clean-port.md +22 -0
  226. package/src/standards/tooling/vitepress-wiki.md +38 -0
  227. package/src/standards/typescript/always-add-explicit-types.md +32 -0
  228. package/src/standards/typescript/barrel-imports.md +21 -0
  229. package/src/standards/typescript/no-magic-values.md +52 -0
  230. package/src/standards/typescript/one-artifact-per-file.md +19 -0
  231. package/src/standards/typescript/overview.md +8 -0
  232. package/src/standards/ui/communicate-state.md +21 -0
  233. package/src/standards/ui/never-obscure-information-the-user-needs.md +26 -0
  234. package/src/standards/ui/overview.md +16 -0
  235. package/src/standards/ui/pixel-perfect-design-check.md +22 -0
  236. package/src/standards/ui/ui-component-design.md +34 -0
  237. package/src/standards/ui/ui-components-first.md +25 -0
  238. package/src/standards/ui/ui-layout-via-slot-composition.md +33 -0
  239. package/src/standards/ui/ui-library-is-domain-agnostic.md +20 -0
  240. package/src/standards/ui/ui-refactor-preserve-dont-redesign.md +25 -0
  241. package/src/standards/ui/ui-styleguide.md +30 -0
  242. package/src/standards/ui/ui-variants-by-function-not-by-color.md +23 -0
  243. package/src/standards/ui/validation-errors-fire-on-submit.md +20 -0
  244. package/src/standards/ui/walk-the-users-journey.md +29 -0
  245. package/src/standards/web/always-use-design-tokens-for-colors.md +24 -0
  246. package/src/standards/web/dark-mode-through-tokens.md +19 -0
  247. package/src/standards/web/hidden-attribute-loses-to-display.md +22 -0
  248. package/src/standards/web/overview.md +9 -0
  249. package/src/standards/web/scss-shared-partial-imports.md +16 -0
  250. package/src/standards/web/transitions-only-on-user-toggle.md +19 -0
  251. package/src/standards.md +66 -0
  252. package/src/tools/overview.md +22 -0
  253. package/src/tools/scripts/coentrify-update.py +242 -0
  254. package/src/tools/scripts/unlink-missing-standards.py +138 -0
  255. package/src/tools/specs/changelog-append.md +15 -0
  256. package/src/tools/specs/coentrify-json-check.md +21 -0
  257. package/src/tools/specs/commit-gate.md +32 -0
  258. package/src/tools/specs/healing-append.md +15 -0
  259. package/src/tools/specs/landing.md +29 -0
  260. package/src/tools/specs/refuse-wrap-up-questions.md +22 -0
  261. package/src/tools/specs/reload-core-rules.md +20 -0
@@ -0,0 +1,30 @@
1
+ # UI Styleguide
2
+
3
+ Every workspace with a ui layer carries a styleguide: one place to check all the ui components quickly, the way a component library's site does (Vuetify, Bootstrap).
4
+
5
+ ## Why
6
+
7
+ Every component is judged on its own, edges included.
8
+
9
+ ## How To Apply
10
+
11
+ - Every ui component gets its page as it is built. A new variant lands with its entry.
12
+ - A component's page shows at least:
13
+ - The name
14
+ - A description of what it is: a pure component, agnostic of the feature it serves, with no business logic
15
+ - The main variants at a glance
16
+ - A testbox, a playground to set each variant and try odd combinations, to spot complexities and edge cases
17
+ - Pick the tooling per workspace: Storybook, a gallery route in the app, a sandbox widget in the wiki.
18
+ - A complex dynamic piece, such as a canvas scene or an animated avatar, gets a page too, so it is judged and played with apart from its context first.
19
+ - The description stays feature-agnostic. One that needs the feature to make sense means the component is not pure enough.
20
+ - The canvas is the app: load the app's global styles, palette, theme defaults and root rem into the preview, and give it the app's own background. A story on a bare canvas looks broken even when the component is fine.
21
+ - Verify a styleguide by a sweep, never by clicking around: a Playwright probe lists every entry of the styleguide, from the story index where it is Storybook, screenshots each and tiles the shots into contact sheets to review.
22
+ - A story that shows nothing on its own, such as a one-shot animation or a closed pop-up, gets a version that shows its thing, with a play function or a repeating render.
23
+ - A component judged through its feature hides its edges, since the feature only ever reaches a few combinations.
24
+
25
+ ## Related
26
+
27
+ - [App-Shield](../architecture/app-shield.md)
28
+ - [UI Component Design](ui-component-design.md)
29
+ - [Workspace Suite](../docs/workspace-suite.md)
30
+ - [Test Design](../tests/test-design.md)
@@ -0,0 +1,23 @@
1
+ # UI Variants By Function, Not By Color
2
+
3
+ When a UI component supports multiple visual variants, the input describes the function of the variant, not the color. The component decides what the variant looks like.
4
+
5
+ ```
6
+ <alert variant="warning" /> // function-named input; component picks the color
7
+ <alert color="orange" /> // visual leak; caller dictates implementation
8
+ ```
9
+
10
+ ## Why
11
+
12
+ The look stays the UI layer's to decide, so a rebrand touches one place.
13
+
14
+ ## How To Apply
15
+
16
+ - Name inputs after intent: `severity`, `tone`, `variant`, `state`, `type`.
17
+ - Accept a closed set of semantic values in generic presentation vocabulary, such as info, warning, error and success, held in an `as const` object ([No Magic Values](../typescript/no-magic-values.md)), never domain values such as active and ended. The consumer maps a domain value to a variant ([UI Library Is Domain-Agnostic](ui-library-is-domain-agnostic.md)).
18
+ - Keep color, font and shadow choices inside the component's styles.
19
+ - A variant with only one visual treatment today is still worth typing functionally. Future variants slot in without a rename.
20
+
21
+ ## Related
22
+
23
+ - [UI Component Design](ui-component-design.md)
@@ -0,0 +1,20 @@
1
+ # Validation Errors Fire On Submit
2
+
3
+ Inline validation errors (max-length, required, format) should appear when the user attempts to submit an invalid input, whatever the gesture. The submit handler reveals the error. A blur event alone is not enough.
4
+
5
+ ## Why
6
+
7
+ Every attempt to submit gets feedback.
8
+
9
+ ## How To Apply
10
+
11
+ - With a reveal on blur alone, Enter routes into a handler that bails without a word, and a send button disabled on `!valid` swallows the click.
12
+ - Submit handler: on invalid input, an empty required field included, call `markAsTouched()`, then return without emitting.
13
+ - Submit button: disable on loading or locked, never on `!formControl.valid`.
14
+ - Whether an empty form disables the button is a choice. A button that stays clickable shows what is required on the first click, which is often clearer.
15
+ - Tests: bracket the validation (error not visible after fill, visible after the submit gesture). One gesture is enough per [Gestures In Tests](../tests/gestures-in-tests.md).
16
+
17
+ ## Related
18
+
19
+ - [UI Component Design](ui-component-design.md)
20
+ - [UI Copy In Template](../angular/ui-copy-in-template.md)
@@ -0,0 +1,29 @@
1
+ # Walk The User's Journey
2
+
3
+ Every screen is designed and checked as the user's journey through it: who the user is at that point, what the user is experiencing, what the immediate goals are, and then each question and each click, step by step. What the screen shows supports the user's decisions: it answers the next question, guiding the user's thoughts without steering them.
4
+
5
+ ## Why
6
+
7
+ Every screen answers the questions the user has.
8
+
9
+ ## How To Apply
10
+
11
+ - Write the journey before the screen: who, experiencing what, wanting what, then the user's thoughts in order.
12
+ - Walk it for both ways of thinking: the explorer asking what can I do here, and the follower asking what does the product want me to do. A screen serves both: it shows what is possible, and it sets a goal, an empty cart beside the products, say.
13
+ - At each step ask what the user wonders and whether the screen answers it. A word or number that answers nothing the user asks goes.
14
+ - A number needs a reference: for a value with steps, such as a plan or a level, show where the user stands, where it goes and the difference, and what it comes to.
15
+ - No spoilers: copy never names an event, a reward or a step the user has not reached yet, though the docs and tickets already hold it.
16
+ - What lies ahead can still show, locked or disabled, such as a step locked until the one before it is done, and it is told in words the user already knows.
17
+ - Foreshadowing is the exception: a hint placed on purpose, vague enough to pass now and plain on a second visit. It is designed in the product's narrative, never leaked from a ticket.
18
+ - Walk the journey in the running app before calling the change done.
19
+
20
+ ## Examples
21
+
22
+ - A price of 0 means nothing on its own. "Free" says this is a purchase, that things here normally cost something and that this one costs nothing, and naming what it includes says where to look next.
23
+ - A screen can be fully consistent with the code and still answer nothing the user asks.
24
+
25
+ ## Related
26
+
27
+ - [Communicate State](communicate-state.md)
28
+ - [Never Obscure Information The User Needs](never-obscure-information-the-user-needs.md)
29
+ - [Work Workflow](../tickets-workflow/work-workflow.md)
@@ -0,0 +1,24 @@
1
+ # Always Use Design Tokens For Colors
2
+
3
+ Every color comes from the project's own token layer, which wraps the design system's tokens in one place: its SCSS namespace, the custom properties it documents as public, or a token object in code. Components use that layer, such as `color.$bg-brand-default`. Never hardcode a hex or rgb literal, never invent your own color, and never reach past the layer to the design system's own variables.
4
+
5
+ ## Why
6
+
7
+ Every color follows the design system, its themes and its renames included.
8
+
9
+ ## How To Apply
10
+
11
+ - Where the layer is SCSS, color is pulled from its `@use`'d namespace: `@use '...scss/color'; stroke: color.$bg-brand-default;`. The same discipline covers spacing, radius and typography tokens.
12
+ - When the color is dynamic or chosen in TS, the component emits a key or variant, never a hex or a `var(--...)` string, and the SCSS maps that key to the token (a modifier class, an `@each` over a `$key: color.$token` map). SVG `stroke=`/`fill=` presentation attributes can't resolve tokens, so bind a class instead of a style string.
13
+ - A scene drawn in code, such as a canvas, reads its colors from the token layer's object in code.
14
+ - Pick an existing color as it is before any new one: no lightened, darkened or blended shade of a token for a new element when an existing color reads well.
15
+ - A missing token is added to the project's own token layer, never a raw value in its place. Where the design system is large and mature enough to have owners, the gap is surfaced for them ([Library Feedback](../docs/library-feedback.md)).
16
+ - Lint against raw hex and the design system's own variables in component code outside the token layer ([Pre-Empt Recurring Code-Review Nits](../code/pre-empt-recurring-code-review-nits.md)).
17
+ - A design system variable used directly bypasses the token layer, and breaks when the design system renames it.
18
+ - A color literal, even one that equals a token, is a magic value per color mode: it drifts from the palette, has to be found again for every new mode, and skips theming.
19
+
20
+ ## Related
21
+
22
+ - [UI Refactor: Preserve, Don't Redesign](../ui/ui-refactor-preserve-dont-redesign.md)
23
+ - [Dark Mode Through Tokens](dark-mode-through-tokens.md)
24
+ - [Don't Introduce Tech Debt](../behavior/dont-introduce-tech-debt.md)
@@ -0,0 +1,19 @@
1
+ # Dark Mode Through Tokens
2
+
3
+ A fill that follows the color mode, such as a mask, a scroll fade or a shadow, comes from a token with a dark value ([Always Use Design Tokens For Colors](always-use-design-tokens-for-colors.md)), or is a transparent cutout.
4
+
5
+ ## Why
6
+
7
+ Every color flips with the mode, everywhere it is used.
8
+
9
+ ## How To Apply
10
+
11
+ - When adding or auditing dark mode, find the hardcoded color literals used as opaque fills and replace each with a token.
12
+ - Give a token without a dark value one, derived from the composite the element sits on: the surface's alpha over the dark page background. It is added like any missing token ([Always Use Design Tokens For Colors](always-use-design-tokens-for-colors.md)).
13
+ - An element that can render over more than one surface has no single fill that matches every surface. Carve its cutout transparently instead (a mask over the gradient), so the gap shows whatever background is behind it and needs no color at all.
14
+ - A design system's surface and shadow tokens may carry no dark-mode value, and code then tends to hardcode light literals as opaque fills. In dark mode those stay bright.
15
+
16
+ ## Related
17
+
18
+ - [Always Use Design Tokens For Colors](always-use-design-tokens-for-colors.md)
19
+ - [SCSS Shared Partial Imports](scss-shared-partial-imports.md)
@@ -0,0 +1,22 @@
1
+ # Hidden Attribute Loses To Display
2
+
3
+ An element toggled with the hidden attribute carries no display rule of its own, or its display rule yields to `[hidden]`. Its closed state is verified by what is painted.
4
+
5
+ ## Why
6
+
7
+ A closed state is judged by what the user sees.
8
+
9
+ ## How To Apply
10
+
11
+ - Verify the closed state with the computed display, a negated visibility assertion or a screenshot on load. A boolean read back from the element proves only the flag.
12
+ - The first time a new overlay ships, take one screenshot of the page with it closed before calling it done.
13
+ - The browser's `[hidden]` rule loses to any display rule of the element's own, so the element renders anyway.
14
+
15
+ ## Examples
16
+
17
+ - An overlay with its own flex display and the hidden flag set covers the whole page. A check that reads the flag back from the DOM calls it closed, while the computed display stays flex.
18
+
19
+ ## Related
20
+
21
+ - [Bracket State Changes With Contrast Assertions](../tests/bracket-state-changes-with-contrast-assertions.md)
22
+ - [Review Every Capture Before Reporting](../behavior/review-every-capture-before-reporting.md)
@@ -0,0 +1,9 @@
1
+ # Overview
2
+
3
+ The Web standards: rules for HTML and CSS.
4
+
5
+ - [Always Use Design Tokens For Colors](always-use-design-tokens-for-colors.md) - colors only from the project's token layer, which wraps the design system in one place, never raw hex, prefer existing colors
6
+ - [Dark Mode Through Tokens](dark-mode-through-tokens.md) - a fill that follows the color mode comes from a token with a dark value, or is a transparent cutout, never a literal override
7
+ - [Hidden Attribute Loses To Display](hidden-attribute-loses-to-display.md) - a hidden-toggled element's display rule yields to `[hidden]`, and its closed state is verified by what is painted
8
+ - [SCSS Shared Partial Imports](scss-shared-partial-imports.md) - shared SCSS partials via `@use '@styles/<name>'`, no alias
9
+ - [Transitions Only On User Toggle](transitions-only-on-user-toggle.md) - transitions only on user toggles, never on load or resize
@@ -0,0 +1,16 @@
1
+ # SCSS Shared Partial Imports
2
+
3
+ Cross-cutting SCSS partials (breakpoints, z-index and the like) live under a styles folder named after its alias, `@ui` by default or `@<app>` for an app's own, whose parent sits on the Sass preprocessor's load path. Consume them with `@use '@<alias>/<name>'`, such as `@use '@ui/colors'`, and never alias with `as`. Reach members through the namespace derived from the filename (`breakpoints.mobile`, `breakpoints.$mobile-max-width`, `z-index.tier(...)`).
4
+
5
+ ## Why
6
+
7
+ A shared partial is imported the same way everywhere, short and stable.
8
+
9
+ ## How To Apply
10
+
11
+ - Put a new shared partial in its styles folder, and keep that folder's parent on the build's style-preprocessor include paths. Which alias a project picks is its own setup.
12
+ - The default namespace already says which module a member came from, so an alias only adds noise and lets two files disagree on the short name.
13
+
14
+ ## Related
15
+
16
+ - [App-Shield](../architecture/app-shield.md)
@@ -0,0 +1,19 @@
1
+ # Transitions Only On User Toggle
2
+
3
+ A transition lives on a class that is set only when the user toggles. Initial render and a viewport switch never animate.
4
+
5
+ ## Why
6
+
7
+ An animation plays only for what the user did.
8
+
9
+ ## How To Apply
10
+
11
+ - Move the transition off the always-applied modifier and onto a dedicated `--animating` (or similarly named) class.
12
+ - Set that class from a watcher on the user-toggleable state that skips its first run, such as an Angular `effect()` over the toggle signals, then clear it after the transition's duration.
13
+ - Apply the same split to any always-applied modifier whose property changes are partly user-driven and partly state-driven.
14
+ - A `transition: ... 0.2s ease` on a class that is set during initial render, or added and removed on a viewport switch, fires in both situations. The user sees a flicker on page load and during resize, neither of which the user initiated.
15
+ - The skipped first run tells initialization apart from a real toggle, so initial render and viewport-driven class swaps never see a transition.
16
+
17
+ ## Related
18
+
19
+ - [UI Component Design](../ui/ui-component-design.md)
@@ -0,0 +1,66 @@
1
+ # Standards
2
+
3
+ The rules, conventions and templates a project adopts.
4
+
5
+ ## Always Make No Mistakes
6
+
7
+ [Always Make No Mistakes](standards/behavior/always-make-no-mistakes.md) is the core of the standards. `make no mistakes` is a meme, and coentrify gave the words a job: every mistake that is caught becomes a standard or a check.
8
+
9
+ The system heals itself. A caught mistake gets fixed twice: once in the work, and once in the harness.
10
+
11
+ The system personalizes itself. Every fix comes from the project's own mistakes, so the standards grow toward the project.
12
+
13
+ The system learns. With every fix more is automated, and the project becomes more autonomous, more stable and higher in quality.
14
+
15
+ ## Modules
16
+
17
+ Standards come in modules. A module holds the standards on one subject, such as Behavior, Docs or Tests. The [overview](standards/overview.md) lists every module and its standards.
18
+
19
+ A module joins once a project has proven its standards: a framework, an engine, a kind of product.
20
+
21
+ A standard for one kind of project says so in its title. Where a title cannot, a `Relevant for:` line under the rule names it, and the overview line repeats it.
22
+
23
+ ## Skills
24
+
25
+ A skill is a standard for one task: a file of instructions an agent follows when the task comes up. A skill lives in the module it belongs to, and a project prefers a skill over working from scratch. A skill from outside the project, such as a plugin's, can be used freely, and where it conflicts with the project's standards, the standards win ([Standards Over Skills](standards/behavior/standards-over-skills.md)).
26
+
27
+ ## Versions
28
+
29
+ Coentrify has one version. The [changelog](changelog/overview.md) names every standard that a version changed, so a project updates what moved and skips the rest.
30
+
31
+ ## Template
32
+
33
+ Every standard follows one template.
34
+
35
+ - The rule, in one or two sentences
36
+ - What the rule is relevant for, where the title does not say
37
+ - Why: why the rule is needed, in a line or two
38
+ - How to apply the rule, under How To Apply, or under sections named after its parts where the rules fall into parts
39
+ - An example, where a story helps
40
+ - Related standards, as links
41
+
42
+ A Why lets an agent judge a case the rule did not foresee. The Why of a part page, such as Game Design Laws: Experience, stands on its parent.
43
+
44
+ A standard follows the standards. Every page is an example of the rules the page states.
45
+
46
+ ## A Foundation
47
+
48
+ The standards are a foundation. A project is meant to pick, override and extend.
49
+
50
+ - Pick a whole module, or single standards.
51
+ - Override a standard where the project differs.
52
+ - Add standards of the project's own.
53
+
54
+ Anyone can build a version of coentrify of their own on the same foundation.
55
+
56
+ ### Other Sources
57
+
58
+ A project can take standards and skills from other sources too, and files each in the module it belongs to.
59
+
60
+ ### Contributions
61
+
62
+ A project keeps what it learns, as a customization or a standard of its own. Coentrify takes changes from its maintainers only, and a project files a change only when its `coentrify.json` says the project is a contributor.
63
+
64
+ ### Example
65
+
66
+ Nick took an early version of coentrify and made it his own: Nicktrify.
@@ -0,0 +1,22 @@
1
+ # Tools
2
+
3
+ What coentrify provides beside the standards: the scripts behind its own commands, and a spec for every check or helper a project builds for itself.
4
+
5
+ ## Scripts
6
+
7
+ These run from the installed package, in `node_modules/coentrify/src/tools/scripts`, never copied into a project, so they follow every change to coentrify's own format.
8
+
9
+ - `scripts/coentrify-update.py` - works out an update from the installed package and the project's version on npm: replaces the tracked standards that changed with their overview lines, and reports the rest for the agent, the changed specs included ([Commands](../commands.md#coentrify-update))
10
+ - `scripts/unlink-missing-standards.py` - removes every link to a standard the project did not adopt, and keeps the words, but drops its line from an overview, after the setup and after every update
11
+
12
+ ## Specs
13
+
14
+ A project's agent builds these in the project's own stack, since each project runs a different app, shell and toolchain. A spec says where the tool runs, what it does, and the cases an implementation has to pass.
15
+
16
+ - [Commit Gate](specs/commit-gate.md) - refuses a commit that does not hang on its check, and one that follows a `git add` in the same command
17
+ - [Reload Core Rules](specs/reload-core-rules.md) - prints the Core Rules after a compaction
18
+ - [Refuse Wrap-Up Questions](specs/refuse-wrap-up-questions.md) - refuses answer buttons at the end of a turn
19
+ - [Landing](specs/landing.md) - a guarded merge of a story, the checks on main and a gated docs commit, for several agents at once
20
+ - [Changelog Append](specs/changelog-append.md) - one line in a version's changelog, in a fixed shape
21
+ - [Healing Append](specs/healing-append.md) - one entry in the healing log, in a fixed shape
22
+ - [Coentrify JSON Check](specs/coentrify-json-check.md) - keeps `coentrify.json` true, and refuses a hand edit of a tracked standard
@@ -0,0 +1,242 @@
1
+ #!/usr/bin/env python3
2
+ """Works out a coentrify update from the installed package, so the agent only handles what needs judgment.
3
+
4
+ usage: coentrify-update.py [--apply]
5
+
6
+ Run from the root of the project, once the package that coentrify.json names is raised to the new
7
+ version. The update runs from the project's version to the installed one. The script fetches the
8
+ project's version of the package from npm to compare, and keeps it in node_modules/.cache.
9
+
10
+ Without --apply it prints the plan. With --apply it also replaces every tracked standard that changed,
11
+ and its line in the module's overview, and writes the new version to coentrify.json. The rest stays with the agent, as the plan says:
12
+ - a customized standard that changed, to show the director
13
+ - a standard that was renamed, moved or removed at the source
14
+ - a new standard in a module the project adopted, worth considering
15
+ - the overview line of a customized standard that changed, to show the director
16
+ - a tool spec that changed, so the project rebuilds what it built from it
17
+ - the unlink script, once the replaced standards bring their links back
18
+ """
19
+ from __future__ import annotations
20
+
21
+ import json
22
+ import re
23
+ import subprocess
24
+ import sys
25
+ import tarfile
26
+ from pathlib import Path
27
+
28
+ FILE = "coentrify.json"
29
+ APPLY_FLAG = "--apply"
30
+ DEFAULT_PACKAGE = "coentrify"
31
+ NODE_MODULES = Path("node_modules")
32
+ CACHE = NODE_MODULES / ".cache"
33
+ PACKAGE_MANIFEST = "package.json"
34
+ SOURCE_FOLDER = "src"
35
+ TARBALL_ROOT = "package"
36
+ STANDARDS = "standards"
37
+ SPECS = "tools/specs"
38
+ INDEX_PAGE = "overview.md"
39
+ MODULE_SOURCE = "source"
40
+ TRACKED = "tracked"
41
+ FIRST_VERSION_ON_NPM = "0.1.0"
42
+ STANDARD_PATH = re.compile(r"^standards/([^/]+)/([^/]+)\.md$")
43
+ TITLE = re.compile(r"^# (.+)$", re.M)
44
+ OVERVIEW_LINE = re.compile(r"^- \[[^\]]+\]\(([^)/]+)\.md\)")
45
+
46
+
47
+ def version_key(version: str) -> tuple[int, ...]:
48
+ return tuple(int(part) for part in version.split("."))
49
+
50
+
51
+ def is_safe(member: tarfile.TarInfo) -> bool:
52
+ """A plain file or folder that stays inside the folder it is unpacked into."""
53
+ path = Path(member.name)
54
+ return (member.isfile() or member.isdir()) and not path.is_absolute() and ".." not in path.parts
55
+
56
+
57
+ def fetch(package: str, version: str) -> Path:
58
+ """The source of the project's version, unpacked from npm into the cache once."""
59
+ folder = CACHE / package / version
60
+ source = folder / TARBALL_ROOT / SOURCE_FOLDER
61
+ if source.is_dir():
62
+ return source
63
+ folder.mkdir(parents=True, exist_ok=True)
64
+ result = subprocess.run(
65
+ ["npm", "pack", f"{package}@{version}", "--pack-destination", str(folder), "--json"],
66
+ capture_output=True,
67
+ text=True,
68
+ )
69
+ if result.returncode != 0:
70
+ sys.exit(f"update: npm pack {package}@{version} failed: {result.stderr.strip()}")
71
+ with tarfile.open(folder / json.loads(result.stdout)[0]["filename"]) as tarball:
72
+ if hasattr(tarfile, "data_filter"):
73
+ tarball.extractall(folder, filter="data")
74
+ else:
75
+ tarball.extractall(folder, members=[member for member in tarball.getmembers() if is_safe(member)])
76
+ if not source.is_dir():
77
+ sys.exit(f"update: {package}@{version} holds no source to compare with.")
78
+ return source
79
+
80
+
81
+ def changes(old: Path, new: Path, folder: str, *options: str) -> list[str]:
82
+ """Rows of git diff between two copies of a folder, with paths relative to the source."""
83
+ result = subprocess.run(
84
+ ["git", "diff", "--no-index", "--no-color", "--no-ext-diff", *options, str(old / folder), str(new / folder)],
85
+ capture_output=True,
86
+ text=True,
87
+ )
88
+ if result.returncode > 1:
89
+ sys.exit(f"update: git diff failed: {result.stderr.strip()}")
90
+ prefixes = sorted((f"{old.as_posix()}/", f"{new.as_posix()}/"), key=len, reverse=True)
91
+
92
+ def relative(path: str) -> str:
93
+ return next((path.removeprefix(prefix) for prefix in prefixes if path.startswith(prefix)), path)
94
+
95
+ return ["\t".join(relative(part) for part in row.split("\t")) for row in result.stdout.splitlines()]
96
+
97
+
98
+ def title(source: Path, path: str) -> str:
99
+ match = TITLE.search((source / path).read_text())
100
+ return match.group(1) if match else path
101
+
102
+
103
+ def overview_lines(text: str) -> dict[str, str]:
104
+ lines = {}
105
+ for line in text.splitlines():
106
+ match = OVERVIEW_LINE.match(line)
107
+ if match:
108
+ lines[match.group(1)] = line
109
+ return lines
110
+
111
+
112
+ def overview(source: Path, module: str) -> dict[str, str]:
113
+ path = source / STANDARDS / module / INDEX_PAGE
114
+ return overview_lines(path.read_text()) if path.exists() else {}
115
+
116
+
117
+ def standard_of(path: str) -> tuple[str, str] | None:
118
+ match = STANDARD_PATH.match(path)
119
+ if not match or match.group(2) + ".md" == INDEX_PAGE:
120
+ return None
121
+ return match.group(1), match.group(2)
122
+
123
+
124
+ def main() -> int:
125
+ args = sys.argv[1:]
126
+ if any(arg != APPLY_FLAG for arg in args):
127
+ print(__doc__.strip().splitlines()[2], file=sys.stderr)
128
+ return 2
129
+ apply = APPLY_FLAG in args
130
+ config = json.loads(Path(FILE).read_text())
131
+ package = config.get("package", DEFAULT_PACKAGE)
132
+ manifest = NODE_MODULES / package / PACKAGE_MANIFEST
133
+ if not manifest.exists():
134
+ sys.exit(f"update: {package} is not installed, raise it first: npm install --save-dev {package}@latest")
135
+ start = config["version"]
136
+ end = json.loads(manifest.read_text())["version"]
137
+ if version_key(end) <= version_key(start):
138
+ print(f"update: the project is at {start}, and the installed {package} {end} is no newer. Raise it first: npm install --save-dev {package}@latest")
139
+ return 0
140
+ if version_key(start) < version_key(FIRST_VERSION_ON_NPM):
141
+ sys.exit(f"update: the project is at {start}, from before {FIRST_VERSION_ON_NPM}. It sets coentrify up again, the way the onboarding says for an earlier coentrify.")
142
+ new = NODE_MODULES / package / SOURCE_FOLDER
143
+ old = fetch(package, start)
144
+ folder = Path(config["folders"][STANDARDS])
145
+ modules = {
146
+ name: {standard: state for standard, state in module.items() if standard != MODULE_SOURCE}
147
+ for name, module in config["modules"].items()
148
+ if MODULE_SOURCE not in module
149
+ }
150
+ own_source = sorted(name for name, module in config["modules"].items() if MODULE_SOURCE in module)
151
+
152
+ changed, renamed, removed, added = [], [], [], []
153
+ for row in changes(old, new, STANDARDS, "-M", "--name-status"):
154
+ status, *paths = row.split("\t")
155
+ old_standard = standard_of(paths[0])
156
+ new_standard = standard_of(paths[-1])
157
+ if status.startswith("R") and old_standard and new_standard:
158
+ renamed.append((old_standard, new_standard))
159
+ elif status == "M" and old_standard:
160
+ changed.append(old_standard)
161
+ elif status == "D" and old_standard:
162
+ removed.append(old_standard)
163
+ elif status == "A" and new_standard:
164
+ added.append(new_standard)
165
+ for new_standard in list(added):
166
+ match = next((gone for gone in removed if gone[1] == new_standard[1]), None)
167
+ if match:
168
+ removed.remove(match)
169
+ added.remove(new_standard)
170
+ renamed.append((match, new_standard))
171
+
172
+ def adopted(module: str, name: str) -> str | None:
173
+ return modules.get(module, {}).get(name)
174
+
175
+ replace = [(module, name) for module, name in changed if adopted(module, name) == TRACKED]
176
+ report = [(module, name) for module, name in changed if adopted(module, name) not in (None, TRACKED)]
177
+ moves = [(before, after) for before, after in renamed if adopted(*before)]
178
+ gone = [before for before in removed if adopted(*before)]
179
+ fresh = [after for after in added if after[0] in modules]
180
+
181
+ line_replace, line_report = [], []
182
+ for module in sorted(modules):
183
+ before, after = overview(old, module), overview(new, module)
184
+ for name, line in after.items():
185
+ if name in before and before[name] != line and adopted(module, name):
186
+ (line_replace if adopted(module, name) == TRACKED else line_report).append((module, name, line))
187
+ specs = changes(old, new, SPECS, "--name-only")
188
+
189
+ def diff(path: str) -> str:
190
+ return f"git diff --no-index {old.as_posix()}/{path} {new.as_posix()}/{path}"
191
+
192
+ print(f"# Update from {start} to {end}\n")
193
+ print(f"Replace, tracked and changed: {len(replace)}")
194
+ for module, name in replace:
195
+ print(f"- {module}/{name}")
196
+ print(f"\nShow the director, customized and changed: {len(report)}")
197
+ for module, name in report:
198
+ print(f"- {module}/{name}: {diff(f'{STANDARDS}/{module}/{name}.md')}")
199
+ print(f"\nRenamed or moved at the source: {len(moves)}")
200
+ for (old_module, old_name), (new_module, new_name) in moves:
201
+ print(f"- {old_module}/{old_name} is now {new_module}/{new_name}, {title(new, f'{STANDARDS}/{new_module}/{new_name}.md')}")
202
+ print(f"\nRemoved at the source: {len(gone)}")
203
+ for module, name in gone:
204
+ print(f"- {module}/{name}")
205
+ print(f"\nNew in an adopted module, worth considering: {len(fresh)}")
206
+ for module, name in fresh:
207
+ print(f"- {module}/{name}, {title(new, f'{STANDARDS}/{module}/{name}.md')}")
208
+ print(f"\nOverview lines, tracked and changed: {len(line_replace)}")
209
+ for module, name, _ in line_replace:
210
+ print(f"- {module}/{name}")
211
+ print(f"\nOverview lines to show the director, customized and changed: {len(line_report)}")
212
+ for module, name, _ in line_report:
213
+ print(f"- {module}/{name}: {diff(f'{STANDARDS}/{module}/{INDEX_PAGE}')}")
214
+ print(f"\nSpecs that changed, rebuild what the project built from them: {len(specs)}")
215
+ for spec in specs:
216
+ print(f"- {spec}: {diff(spec)}")
217
+ if own_source:
218
+ print(f"\nModules with a source of their own, left out: {', '.join(own_source)}")
219
+
220
+ if apply:
221
+ for module, name in replace:
222
+ target = folder / module / f"{name}.md"
223
+ target.write_text((new / STANDARDS / module / f"{name}.md").read_text())
224
+ missing = []
225
+ for module, name, line in line_replace:
226
+ target = folder / module / INDEX_PAGE
227
+ text = target.read_text() if target.exists() else ""
228
+ current = overview_lines(text).get(name)
229
+ if current is None:
230
+ missing.append(f"{module}/{name}")
231
+ continue
232
+ target.write_text(text.replace(current, line, 1))
233
+ config["version"] = end
234
+ Path(FILE).write_text(json.dumps(config, indent=2) + "\n")
235
+ print(f"\nReplaced {len(replace)} standards and {len(line_replace) - len(missing)} overview lines, and wrote {end} to {FILE}.")
236
+ for standard in missing:
237
+ print(f"- The overview line of {standard} was not found, update it by hand.")
238
+ print("Run the unlink script next.")
239
+ return 0
240
+
241
+
242
+ sys.exit(main())