create-koppajs 1.2.2 → 1.2.3

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 (78) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/README.md +12 -10
  3. package/bin/create-koppajs.js +0 -14
  4. package/package.json +4 -4
  5. package/template/README.md +19 -206
  6. package/template/_gitignore +0 -3
  7. package/template/index.html +1 -1
  8. package/template/package.json +9 -46
  9. package/template/public/favicon.png +0 -0
  10. package/template/public/koppajs-logo.png +0 -0
  11. package/template/src/app-view.kpa +1 -3
  12. package/template/tsconfig.json +2 -9
  13. package/template-overlays/router/README.md +25 -200
  14. package/template-overlays/router/index.html +1 -1
  15. package/template-overlays/router/package.json +10 -47
  16. package/template-overlays/router/src/app-view.kpa +21 -78
  17. package/template-overlays/router/src/home-page.kpa +23 -60
  18. package/template-overlays/router/src/main.ts +0 -9
  19. package/template-overlays/router/src/not-found-page.kpa +16 -48
  20. package/template-overlays/router/src/router-page.kpa +34 -69
  21. package/template-overlays/router/src/style.css +5 -29
  22. package/template/AI_CONSTITUTION.md +0 -50
  23. package/template/ARCHITECTURE.md +0 -84
  24. package/template/CHANGELOG.md +0 -35
  25. package/template/CONTRIBUTING.md +0 -89
  26. package/template/DECISION_HIERARCHY.md +0 -32
  27. package/template/DEVELOPMENT_RULES.md +0 -57
  28. package/template/LICENSE +0 -201
  29. package/template/RELEASE.md +0 -227
  30. package/template/ROADMAP.md +0 -34
  31. package/template/TESTING_STRATEGY.md +0 -96
  32. package/template/_editorconfig +0 -12
  33. package/template/_github/instructions/ai-workflow.md +0 -33
  34. package/template/_github/workflows/ci.yml +0 -41
  35. package/template/_github/workflows/release.yml +0 -58
  36. package/template/_husky/commit-msg +0 -8
  37. package/template/_husky/pre-commit +0 -1
  38. package/template/_prettierignore +0 -7
  39. package/template/commitlint.config.mjs +0 -6
  40. package/template/docs/adr/0001-keep-the-starter-minimal.md +0 -32
  41. package/template/docs/adr/0002-adopt-a-living-meta-layer.md +0 -30
  42. package/template/docs/adr/0003-rely-on-upstream-kpa-es-module-output.md +0 -32
  43. package/template/docs/adr/0004-adopt-an-automated-quality-baseline.md +0 -31
  44. package/template/docs/adr/0005-adopt-a-tag-driven-release-baseline.md +0 -45
  45. package/template/docs/adr/0006-adopt-commit-message-conventions.md +0 -39
  46. package/template/docs/adr/README.md +0 -37
  47. package/template/docs/adr/TEMPLATE.md +0 -18
  48. package/template/docs/architecture/module-boundaries.md +0 -47
  49. package/template/docs/meta/maintenance.md +0 -40
  50. package/template/docs/quality/quality-gates.md +0 -39
  51. package/template/docs/specs/README.md +0 -36
  52. package/template/docs/specs/TEMPLATE.md +0 -34
  53. package/template/docs/specs/app-bootstrap.md +0 -46
  54. package/template/docs/specs/counter-component.md +0 -48
  55. package/template/docs/specs/quality-workflow.md +0 -62
  56. package/template/eslint.config.mjs +0 -54
  57. package/template/playwright.config.ts +0 -31
  58. package/template/pnpm-lock.yaml +0 -3777
  59. package/template/prettier.config.mjs +0 -6
  60. package/template/public/favicon.svg +0 -15
  61. package/template/tests/e2e/app.spec.ts +0 -18
  62. package/template/tests/integration/main-bootstrap.test.ts +0 -33
  63. package/template/vite.config.d.mts +0 -5
  64. package/template/vitest.config.mjs +0 -19
  65. package/template-overlays/router/ARCHITECTURE.md +0 -86
  66. package/template-overlays/router/CHANGELOG.md +0 -50
  67. package/template-overlays/router/DEVELOPMENT_RULES.md +0 -57
  68. package/template-overlays/router/ROADMAP.md +0 -34
  69. package/template-overlays/router/TESTING_STRATEGY.md +0 -67
  70. package/template-overlays/router/docs/adr/0001-keep-the-starter-minimal.md +0 -32
  71. package/template-overlays/router/docs/architecture/module-boundaries.md +0 -39
  72. package/template-overlays/router/docs/meta/maintenance.md +0 -38
  73. package/template-overlays/router/docs/specs/README.md +0 -19
  74. package/template-overlays/router/docs/specs/app-bootstrap.md +0 -42
  75. package/template-overlays/router/docs/specs/router-navigation.md +0 -41
  76. package/template-overlays/router/pnpm-lock.yaml +0 -3786
  77. package/template-overlays/router/tests/e2e/app.spec.ts +0 -38
  78. package/template-overlays/router/tests/integration/main-bootstrap.test.ts +0 -150
package/template/LICENSE DELETED
@@ -1,201 +0,0 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- http://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- 1. Definitions.
8
-
9
- "License" shall mean the terms and conditions for use, reproduction,
10
- and distribution as defined by Sections 1 through 9 of this document.
11
-
12
- "Licensor" shall mean the copyright owner or entity authorized by
13
- the copyright owner that is granting the License.
14
-
15
- "Legal Entity" shall mean the union of the acting entity and all
16
- other entities that control, are controlled by, or are under common
17
- control with that entity. For the purposes of this definition,
18
- "control" means (i) the power, direct or indirect, to cause the
19
- direction or management of such entity, whether by contract or
20
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
- outstanding shares, or (iii) beneficial ownership of such entity.
22
-
23
- "You" (or "Your") shall mean an individual or Legal Entity
24
- exercising permissions granted by this License.
25
-
26
- "Source" form shall mean the preferred form for making modifications,
27
- including but not limited to software source code, documentation
28
- source, and configuration files.
29
-
30
- "Object" form shall mean any form resulting from mechanical
31
- transformation or translation of a Source form, including but
32
- not limited to compiled object code, generated documentation,
33
- and conversions to other media types.
34
-
35
- "Work" shall mean the work of authorship, whether in Source or
36
- Object form, made available under the License, as indicated by a
37
- copyright notice that is included in or attached to the work
38
- (an example is provided in the Appendix below).
39
-
40
- "Derivative Works" shall mean any work, whether in Source or Object
41
- form, that is based on (or derived from) the Work and for which the
42
- editorial revisions, annotations, elaborations, or other modifications
43
- represent, as a whole, an original work of authorship. For the purposes
44
- of this License, Derivative Works shall not include works that remain
45
- separable from, or merely link (or bind by name) to the interfaces of,
46
- the Work and Derivative Works thereof.
47
-
48
- "Contribution" shall mean any work of authorship, including
49
- the original version of the Work and any modifications or additions
50
- to that Work or Derivative Works thereof, that is intentionally
51
- submitted to Licensor for inclusion in the Work by the copyright owner
52
- or by an individual or Legal Entity authorized to submit on behalf of
53
- the copyright owner. For the purposes of this definition, "submitted"
54
- means any form of electronic, verbal, or written communication sent
55
- to the Licensor or its representatives, including but not limited to
56
- communication on electronic mailing lists, source code control systems,
57
- and issue tracking systems that are managed by, or on behalf of, the
58
- Licensor for the purpose of discussing and improving the Work, but
59
- excluding communication that is conspicuously marked or otherwise
60
- designated in writing by the copyright owner as "Not a Contribution."
61
-
62
- "Contributor" shall mean Licensor and any individual or Legal Entity
63
- on behalf of whom a Contribution has been received by Licensor and
64
- subsequently incorporated within the Work.
65
-
66
- 2. Grant of Copyright License. Subject to the terms and conditions of
67
- this License, each Contributor hereby grants to You a perpetual,
68
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
- copyright license to reproduce, prepare Derivative Works of,
70
- publicly display, publicly perform, sublicense, and distribute the
71
- Work and such Derivative Works in Source or Object form.
72
-
73
- 3. Grant of Patent License. Subject to the terms and conditions of
74
- this License, each Contributor hereby grants to You a perpetual,
75
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
- (except as stated in this section) patent license to make, have made,
77
- use, offer to sell, sell, import, and otherwise transfer the Work,
78
- where such license applies only to those patent claims licensable
79
- by such Contributor that are necessarily infringed by their
80
- Contribution(s) alone or by combination of their Contribution(s)
81
- with the Work to which such Contribution(s) was submitted. If You
82
- institute patent litigation against any entity (including a
83
- cross-claim or counterclaim in a lawsuit) alleging that the Work
84
- or a Contribution incorporated within the Work constitutes direct
85
- or contributory patent infringement, then any patent licenses
86
- granted to You under this License for that Work shall terminate
87
- as of the date such litigation is filed.
88
-
89
- 4. Redistribution. You may reproduce and distribute copies of the
90
- Work or Derivative Works thereof in any medium, with or without
91
- modifications, and in Source or Object form, provided that You
92
- meet the following conditions:
93
-
94
- (a) You must give any other recipients of the Work or
95
- Derivative Works a copy of this License; and
96
-
97
- (b) You must cause any modified files to carry prominent notices
98
- stating that You changed the files; and
99
-
100
- (c) You must retain, in the Source form of any Derivative Works
101
- that You distribute, all copyright, patent, trademark, and
102
- attribution notices from the Source form of the Work,
103
- excluding those notices that do not pertain to any part of
104
- the Derivative Works; and
105
-
106
- (d) If the Work includes a "NOTICE" text file as part of its
107
- distribution, then any Derivative Works that You distribute must
108
- include a readable copy of the attribution notices contained
109
- within such NOTICE file, excluding those notices that do not
110
- pertain to any part of the Derivative Works, in at least one
111
- of the following places: within a NOTICE text file distributed
112
- as part of the Derivative Works; within the Source form or
113
- documentation, if provided along with the Derivative Works; or,
114
- within a display generated by the Derivative Works, if and
115
- wherever such third-party notices normally appear. The contents
116
- of the NOTICE file are for informational purposes only and
117
- do not modify the License. You may add Your own attribution
118
- notices within Derivative Works that You distribute, alongside
119
- or as an addendum to the NOTICE text from the Work, provided
120
- that such additional attribution notices cannot be construed
121
- as modifying the License.
122
-
123
- You may add Your own copyright statement to Your modifications and
124
- may provide additional or different license terms and conditions
125
- for use, reproduction, or distribution of Your modifications, or
126
- for any such Derivative Works as a whole, provided Your use,
127
- reproduction, and distribution of the Work otherwise complies with
128
- the conditions stated in this License.
129
-
130
- 5. Submission of Contributions. Unless You explicitly state otherwise,
131
- any Contribution intentionally submitted for inclusion in the Work
132
- by You to the Licensor shall be under the terms and conditions of
133
- this License, without any additional terms or conditions.
134
- Notwithstanding the above, nothing herein shall supersede or modify
135
- the terms of any separate license agreement you may have executed
136
- with Licensor regarding such Contributions.
137
-
138
- 6. Trademarks. This License does not grant permission to use the trade
139
- names, trademarks, service marks, or product names of the Licensor,
140
- except as required for reasonable and customary use in describing the
141
- origin of the Work and reproducing the content of the NOTICE file.
142
-
143
- 7. Disclaimer of Warranty. Unless required by applicable law or
144
- agreed to in writing, Licensor provides the Work (and each
145
- Contributor provides its Contributions) on an "AS IS" BASIS,
146
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
- implied, including, without limitation, any warranties or conditions
148
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
- PARTICULAR PURPOSE. You are solely responsible for determining the
150
- appropriateness of using or redistributing the Work and assume any
151
- risks associated with Your exercise of permissions under this License.
152
-
153
- 8. Limitation of Liability. In no event and under no legal theory,
154
- whether in tort (including negligence), contract, or otherwise,
155
- unless required by applicable law (such as deliberate and grossly
156
- negligent acts) or agreed to in writing, shall any Contributor be
157
- liable to You for damages, including any direct, indirect, special,
158
- incidental, or consequential damages of any character arising as a
159
- result of this License or out of the use or inability to use the
160
- Work (including but not limited to damages for loss of goodwill,
161
- work stoppage, computer failure or malfunction, or any and all
162
- other commercial damages or losses), even if such Contributor
163
- has been advised of the possibility of such damages.
164
-
165
- 9. Accepting Warranty or Additional Liability. While redistributing
166
- the Work or Derivative Works thereof, You may choose to offer,
167
- and charge a fee for, acceptance of support, warranty, indemnity,
168
- or other liability obligations and/or rights consistent with this
169
- License. However, in accepting such obligations, You may act only
170
- on Your own behalf and on Your sole responsibility, not on behalf
171
- of any other Contributor, and only if You agree to indemnify,
172
- defend, and hold each Contributor harmless for any liability
173
- incurred by, or claims asserted against, such Contributor by reason
174
- of your accepting any such warranty or additional liability.
175
-
176
- END OF TERMS AND CONDITIONS
177
-
178
- APPENDIX: How to apply the Apache License to your work.
179
-
180
- To apply the Apache License to your work, attach the following
181
- boilerplate notice, with the fields enclosed by brackets "[]"
182
- replaced with your own identifying information. (Don't include
183
- the brackets!) The text should be enclosed in the appropriate
184
- comment syntax for the file format. We also recommend that a
185
- file or class name and description of purpose be included on the
186
- same "printed page" as the copyright notice for easier
187
- identification within third-party archives.
188
-
189
- Copyright 2026 Bastian Bensch
190
-
191
- Licensed under the Apache License, Version 2.0 (the "License");
192
- you may not use this file except in compliance with the License.
193
- You may obtain a copy of the License at
194
-
195
- http://www.apache.org/licenses/LICENSE-2.0
196
-
197
- Unless required by applicable law or agreed to in writing, software
198
- distributed under the License is distributed on an "AS IS" BASIS,
199
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
- See the License for the specific language governing permissions and
201
- limitations under the License.
@@ -1,227 +0,0 @@
1
- # Release Process for `__PROJECT_NAME__`
2
-
3
- This document describes the repository-specific release workflow for
4
- `__PROJECT_NAME__`.
5
-
6
- The project uses a manual, tag-driven release process.
7
- Only tagged versions are official releases.
8
-
9
- The effective flow is:
10
-
11
- 1. Finalize the release content on `develop`
12
- 2. Update `package.json` and `CHANGELOG.md`
13
- 3. Validate the release candidate locally
14
- 4. Create a `release/*` branch from that state
15
- 5. Merge the release branch into `main`
16
- 6. Tag the release commit on `main` as `vX.Y.Z`
17
- 7. Push the tag
18
- 8. Let GitHub Actions validate and create the GitHub Release
19
- 9. Merge the updated `main` back into `develop`
20
-
21
- ---
22
-
23
- ## Release Model
24
-
25
- This repository does not use automated versioning tools such as Changesets or
26
- semantic-release.
27
-
28
- The release is controlled by:
29
-
30
- - the version in `package.json`
31
- - the release entry in `CHANGELOG.md`
32
- - the merge of the release-ready state into `main`
33
- - the Git tag in the form `vX.Y.Z`
34
- - the GitHub Actions workflow in `.github/workflows/release.yml`
35
-
36
- Important consequences:
37
-
38
- - A merge to `main` alone does not create a release
39
- - A tag triggers the release workflow
40
- - The tag version must exactly match `package.json`
41
- - The tag must point to the release commit on `main`
42
- - After a successful release, `main` should be merged back into `develop`
43
-
44
- The included release workflow creates GitHub Releases only and does not publish
45
- to npm by default.
46
-
47
- If this project later needs npm publishing or another release target, update
48
- this file, `package.json`, and `.github/workflows/release.yml` in the same
49
- change.
50
-
51
- Do not tag `develop`.
52
- Do not tag the `release/*` branch.
53
- Tag only the release commit that is already on `main`.
54
-
55
- ---
56
-
57
- ## Preconditions
58
-
59
- Before cutting a release, ensure all of the following are true:
60
-
61
- - The intended release scope is already complete on `develop`
62
- - `package.json` contains the target version
63
- - `CHANGELOG.md` contains the corresponding release notes
64
- - The lockfile is up to date
65
- - The release content has been reviewed
66
-
67
- Tooling expectations for local verification:
68
-
69
- - Node.js 22 or newer
70
- - pnpm 10 or newer
71
-
72
- This repository also enforces `engine-strict=true` in `.npmrc`, so incompatible
73
- Node.js or pnpm versions should be treated as a release blocker.
74
-
75
- ---
76
-
77
- ## Local Validation Before Branching
78
-
79
- Before creating the release branch, validate the exact release candidate
80
- locally.
81
-
82
- Recommended commands:
83
-
84
- ```bash
85
- pnpm install
86
- pnpm release:check
87
- ```
88
-
89
- `pnpm release:check` runs the same full validation path used by the release
90
- workflow, including Playwright.
91
-
92
- If Chromium is not installed locally yet, install it once:
93
-
94
- ```bash
95
- pnpm exec playwright install chromium
96
- ```
97
-
98
- ---
99
-
100
- ## Step-by-Step Release Workflow
101
-
102
- ### 1. Finalize the release on `develop`
103
-
104
- Ensure `develop` already contains the exact release content.
105
-
106
- Typical release preparation includes:
107
-
108
- - updating `package.json` from the previous version to the next release version
109
- - moving the relevant notes into the final section in `CHANGELOG.md`
110
- - committing any last release fixes
111
-
112
- Make sure the release-ready state is committed before creating `release/*`.
113
-
114
- ### 2. Create the `release/*` branch
115
-
116
- Create a release branch from the validated `develop` state.
117
-
118
- Example:
119
-
120
- ```bash
121
- git checkout develop
122
- git pull
123
- git checkout -b release/X.Y.Z
124
- ```
125
-
126
- ### 3. Merge the release branch into `main`
127
-
128
- Merge `release/*` into `main` using the repository's normal process.
129
-
130
- The critical requirement is:
131
-
132
- - `main` must contain the final release commit before tagging
133
-
134
- Conceptually:
135
-
136
- ```bash
137
- git checkout main
138
- git pull
139
- git merge --no-ff release/X.Y.Z
140
- ```
141
-
142
- ### 4. Tag the release commit on `main`
143
-
144
- After the release branch has been merged, create the Git tag on the release
145
- commit that is now on `main`.
146
-
147
- Example:
148
-
149
- ```bash
150
- git checkout main
151
- git pull
152
- git tag vX.Y.Z
153
- ```
154
-
155
- The tag format is mandatory:
156
-
157
- - `vX.Y.Z` is valid
158
- - `X.Y.Z` is not valid for this workflow
159
-
160
- ### 5. Push `main` and the tag
161
-
162
- Push the merged `main` branch and then the tag.
163
-
164
- Example:
165
-
166
- ```bash
167
- git push origin main
168
- git push origin vX.Y.Z
169
- ```
170
-
171
- ### 6. Wait for the release workflow to finish
172
-
173
- Verify that:
174
-
175
- - the GitHub Actions release workflow passed
176
- - the GitHub Release was created
177
- - the version-check step confirmed tag and `package.json` alignment
178
-
179
- ### 7. Merge `main` back into `develop`
180
-
181
- After the release has completed successfully, merge the updated `main` back
182
- into `develop`.
183
-
184
- Conceptually:
185
-
186
- ```bash
187
- git checkout develop
188
- git pull
189
- git merge --no-ff main
190
- ```
191
-
192
- ---
193
-
194
- ## GitHub Workflow Behavior
195
-
196
- The workflow `.github/workflows/release.yml` runs on pushed tags matching
197
- `vX.Y.Z`.
198
-
199
- For each matching tag it will:
200
-
201
- 1. install dependencies
202
- 2. install the Playwright Chromium browser
203
- 3. run `pnpm validate`
204
- 4. verify that the tag version matches `package.json`
205
- 5. create a GitHub Release with generated release notes
206
-
207
- If any step fails, the release job stops immediately.
208
-
209
- ---
210
-
211
- ## Maintainer Checklist
212
-
213
- Use this as the maintainer checklist for every release:
214
-
215
- 1. Verify the release scope on `develop`
216
- 2. Update `package.json`
217
- 3. Update `CHANGELOG.md`
218
- 4. Run `pnpm release:check`
219
- 5. Create `release/*` from `develop`
220
- 6. Merge `release/*` into `main`
221
- 7. Confirm the merged commit on `main` has the correct version and changelog
222
- 8. Create the `vX.Y.Z` tag on `main`
223
- 9. Push `main`
224
- 10. Push the tag
225
- 11. Watch the GitHub Actions release workflow
226
- 12. Verify the GitHub Release exists
227
- 13. Merge `main` back into `develop`
@@ -1,34 +0,0 @@
1
- # Roadmap
2
-
3
- This roadmap describes intended directions, not guaranteed delivery dates.
4
-
5
- ## Current priorities
6
-
7
- - Keep the starter minimal and production-like.
8
- - Preserve a clear bootstrap path for new KoppaJS users.
9
- - Keep the meta layer synchronized with the actual repository.
10
-
11
- ## Near-term opportunities
12
-
13
- - Add a lightweight automated test runner when the repository gains logic that warrants it.
14
- - Replace or harden any documentation that still assumes old monorepo-linked dependencies.
15
- - Add more feature specs only when new starter capabilities are intentionally introduced.
16
-
17
- ## Longer-term expansion triggers
18
-
19
- These should happen only with a spec and ADR:
20
-
21
- - routing
22
- - async data fetching
23
- - persistence
24
- - richer component examples
25
- - CI automation
26
-
27
- ## Meta-layer maintenance
28
-
29
- Every release or architecture-changing change should answer:
30
-
31
- - Does the architecture document still match the code?
32
- - Did any new decision deserve an ADR?
33
- - Did testing expectations change?
34
- - Did contributor instructions stay accurate?
@@ -1,96 +0,0 @@
1
- # Testing Strategy
2
-
3
- ## Current state
4
-
5
- This repository now has a small automated testing stack aligned with the actual starter risk profile:
6
-
7
- - `pnpm test:run` for unit and integration tests in Vitest
8
- - `pnpm test:coverage` for local coverage reporting
9
- - `pnpm test:e2e` for a Playwright smoke test against `vite preview`
10
- - `pnpm check` for the fast repository baseline
11
- - `pnpm validate` for the full local and CI validation path
12
- - `pnpm release:check` for tagged release candidates
13
- - `commitlint` through `.husky/commit-msg` for commit message validation
14
- - `pnpm typecheck`
15
- - `pnpm build`
16
-
17
- ## Philosophy
18
-
19
- - Test the smallest meaningful unit that gives confidence.
20
- - Prefer extracting logic into `.ts` modules when it becomes complex enough to warrant focused unit tests.
21
- - Add test infrastructure only when the repository's behavior justifies it; do not add tools for ceremony alone.
22
- - Avoid brittle tests that mirror implementation details instead of observable behavior.
23
- - Reuse the real Vite loading path in automated tests whenever `.kpa` handling is part of the risk surface.
24
-
25
- ## Test pyramid for this repository
26
-
27
- ### Unit tests
28
-
29
- Use unit tests for isolated logic that can fail independently of the browser runtime.
30
-
31
- Today the starter does not ship dedicated extracted helper modules, so unit-only
32
- coverage is optional until new isolated logic actually exists.
33
-
34
- Typical triggers:
35
-
36
- - value transformations
37
- - branching business rules
38
- - reusable helpers
39
- - local tooling helpers
40
-
41
- ### Integration or component tests
42
-
43
- Use integration tests when multiple local boundaries must be verified together but a full browser run would be disproportionate.
44
-
45
- Typical triggers:
46
-
47
- - bootstrap registration in `src/main.ts`
48
- - build-time behavior that depends on the Vite plugin
49
- - shared state or lifecycle interactions that are not yet broad enough for end-to-end coverage
50
-
51
- ### End-to-end tests
52
-
53
- This repository has a real interactive UI, so it carries one Playwright smoke test already. Keep that layer intentionally small and user-facing.
54
-
55
- Typical triggers:
56
-
57
- - root UI rendering
58
- - critical starter interactions such as the counter behavior
59
- - preview/build regressions that would not be caught by Vitest alone
60
-
61
- Escalate E2E coverage beyond smoke scope only when the starter gains broader workflows such as routing, async data flows, persistence, or deployment-sensitive behavior.
62
-
63
- ## Mocking policy
64
-
65
- - Prefer testing pure extracted logic without mocks.
66
- - Mock only at external boundaries such as HTTP, storage, or browser APIs that are expensive or nondeterministic.
67
- - Use selective mocks in integration tests only to observe bootstrap boundaries that would otherwise be opaque.
68
-
69
- ## Coverage expectations
70
-
71
- - There is no blanket repository percentage target right now.
72
- - New non-trivial logic should come with focused tests.
73
- - When a subsystem introduces branching logic, asynchronous behavior, or state shared across components, test automation stops being optional.
74
- - Coverage reports are a decision aid, not a target game. Raise thresholds only when the code surface justifies them.
75
-
76
- ## Quality gates by change size
77
-
78
- - Documentation-only change: verify links and document consistency.
79
- - Small style or copy change: run `pnpm check`.
80
- - Source or config change: run `pnpm check`.
81
- - UI, bootstrap, or browser-sensitive change: run `pnpm validate`.
82
- - Version, changelog, or release workflow change: run `pnpm release:check`.
83
- - Commit convention change: validate `commitlint.config.mjs` and `.husky/commit-msg` together.
84
- - New subsystem or new state model: add tests appropriate to the risk level and update this strategy.
85
-
86
- ## Style linting position
87
-
88
- Stylelint is intentionally not part of the current baseline.
89
-
90
- - The meaningful styling surface lives inside `.kpa` files.
91
- - Adding Stylelint only for `src/style.css` would mostly lint the global reset and miss the component-local styles that matter.
92
- - Revisit this decision only when KoppaJS gains a low-friction way to lint embedded `.kpa` CSS blocks or when the repository starts moving substantial styles into standalone CSS files.
93
-
94
- ## Maintenance rule
95
-
96
- Whenever test tooling, quality gates, or expected confidence levels change, update this file and [docs/quality/quality-gates.md](./docs/quality/quality-gates.md) in the same change.
@@ -1,12 +0,0 @@
1
- root = true
2
-
3
- [*]
4
- charset = utf-8
5
- end_of_line = lf
6
- indent_size = 2
7
- indent_style = space
8
- insert_final_newline = true
9
- trim_trailing_whitespace = true
10
-
11
- [*.md]
12
- trim_trailing_whitespace = false
@@ -1,33 +0,0 @@
1
- # AI Workflow Instructions
2
-
3
- ## Read before editing
4
-
5
- For any non-trivial change, read these documents in order:
6
-
7
- 1. `DECISION_HIERARCHY.md`
8
- 2. `AI_CONSTITUTION.md`
9
- 3. `ARCHITECTURE.md`
10
- 4. the relevant spec in `docs/specs/`
11
- 5. the relevant ADR in `docs/adr/`
12
- 6. `DEVELOPMENT_RULES.md`
13
- 7. `TESTING_STRATEGY.md`
14
-
15
- For release-related work also read `CHANGELOG.md` and `RELEASE.md`.
16
-
17
- ## Required behavior
18
-
19
- - Prefer existing repository patterns over new abstractions.
20
- - Do not silently change public component tags, startup flow, or dependency sourcing.
21
- - Use `spec -> quality plan -> implementation -> documentation`.
22
- - Update the meta layer in the same change when architecture, rules, or workflows change.
23
- - Record durable technical decisions in ADRs.
24
- - Keep hooks fast and put heavier validation into `pnpm validate` and CI.
25
- - If versioning, changelog, or release automation changes, update `CHANGELOG.md`, `RELEASE.md`, and the affected workflow in the same change.
26
- - If you create commits, use Conventional Commits that satisfy `commitlint`.
27
-
28
- ## Required validation
29
-
30
- - Run `pnpm check` for source, config, test, or tooling changes.
31
- - Run `pnpm validate` when UI behavior, bootstrap wiring, browser-facing assets, or quality tooling changes.
32
- - Run `pnpm release:check` when versioning, changelog, or release workflow behavior changes.
33
- - If a local browser check cannot be run, say so explicitly instead of implying it passed.
@@ -1,41 +0,0 @@
1
- name: CI
2
-
3
- on:
4
- pull_request:
5
- branches:
6
- - develop
7
- - main
8
- push:
9
- branches:
10
- - main
11
-
12
- jobs:
13
- validate:
14
- runs-on: ubuntu-latest
15
- strategy:
16
- matrix:
17
- node: [22, 24]
18
-
19
- steps:
20
- - name: Check out repository
21
- uses: actions/checkout@v4
22
-
23
- - name: Set up pnpm
24
- uses: pnpm/action-setup@v4
25
- with:
26
- version: 10.12.1
27
-
28
- - name: Set up Node.js
29
- uses: actions/setup-node@v4
30
- with:
31
- node-version: ${{ matrix.node }}
32
- cache: pnpm
33
-
34
- - name: Install dependencies
35
- run: pnpm install --frozen-lockfile
36
-
37
- - name: Install Playwright browser
38
- run: pnpm exec playwright install --with-deps chromium
39
-
40
- - name: Run repository validation
41
- run: pnpm validate