jorgex-stack 1.0.1 → 1.0.2

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 (91) hide show
  1. package/PRD.md +297 -297
  2. package/README.md +56 -56
  3. package/dist/cli.js +7 -2
  4. package/package.json +1 -1
  5. package/stack/agents/orchestrator.md +192 -192
  6. package/stack/agents/tester.md +71 -71
  7. package/stack/commands/xreview.md +80 -80
  8. package/stack/hooks/hooks.json +18 -18
  9. package/stack/scripts/post-pr-review.cjs +156 -156
  10. package/stack/skills/diagnose/SKILL.md +117 -117
  11. package/stack/skills/diagnose/scripts/hitl-loop.template.sh +41 -41
  12. package/stack/skills/find-skills/SKILL.md +133 -133
  13. package/stack/skills/mcp-builder/LICENSE.txt +201 -201
  14. package/stack/skills/mcp-builder/SKILL.md +236 -236
  15. package/stack/skills/mcp-builder/reference/evaluation.md +601 -601
  16. package/stack/skills/mcp-builder/reference/mcp_best_practices.md +249 -249
  17. package/stack/skills/mcp-builder/reference/node_mcp_server.md +969 -969
  18. package/stack/skills/mcp-builder/reference/python_mcp_server.md +718 -718
  19. package/stack/skills/mcp-builder/scripts/connections.py +151 -151
  20. package/stack/skills/mcp-builder/scripts/evaluation.py +373 -373
  21. package/stack/skills/mcp-builder/scripts/example_evaluation.xml +22 -22
  22. package/stack/skills/mcp-builder/scripts/requirements.txt +2 -2
  23. package/stack/skills/obsidian-cli/SKILL.md +106 -106
  24. package/stack/skills/obsidian-markdown/SKILL.md +196 -196
  25. package/stack/skills/obsidian-markdown/references/CALLOUTS.md +58 -58
  26. package/stack/skills/obsidian-markdown/references/EMBEDS.md +63 -63
  27. package/stack/skills/obsidian-markdown/references/PROPERTIES.md +61 -61
  28. package/stack/skills/react-doctor/SKILL.md +19 -19
  29. package/stack/skills/skill-creator/LICENSE.txt +201 -201
  30. package/stack/skills/skill-creator/agents/analyzer.md +274 -274
  31. package/stack/skills/skill-creator/agents/comparator.md +202 -202
  32. package/stack/skills/skill-creator/agents/grader.md +223 -223
  33. package/stack/skills/skill-creator/assets/eval_review.html +146 -146
  34. package/stack/skills/skill-creator/eval-viewer/generate_review.py +471 -471
  35. package/stack/skills/skill-creator/eval-viewer/viewer.html +1325 -1325
  36. package/stack/skills/skill-creator/references/schemas.md +430 -430
  37. package/stack/skills/skill-creator/scripts/aggregate_benchmark.py +401 -401
  38. package/stack/skills/skill-creator/scripts/generate_report.py +326 -326
  39. package/stack/skills/skill-creator/scripts/improve_description.py +248 -248
  40. package/stack/skills/skill-creator/scripts/package_skill.py +136 -136
  41. package/stack/skills/skill-creator/scripts/quick_validate.py +102 -102
  42. package/stack/skills/skill-creator/scripts/run_eval.py +310 -310
  43. package/stack/skills/skill-creator/scripts/run_loop.py +332 -332
  44. package/stack/skills/skill-creator/scripts/utils.py +47 -47
  45. package/stack/skills/supabase/SKILL.md +135 -135
  46. package/stack/skills/supabase/assets/feedback-issue-template.md +17 -17
  47. package/stack/skills/supabase/references/skill-feedback.md +17 -17
  48. package/stack/skills/supabase-postgres-best-practices/SKILL.md +64 -64
  49. package/stack/skills/supabase-postgres-best-practices/references/_contributing.md +170 -170
  50. package/stack/skills/supabase-postgres-best-practices/references/_sections.md +39 -39
  51. package/stack/skills/supabase-postgres-best-practices/references/_template.md +34 -34
  52. package/stack/skills/supabase-postgres-best-practices/references/advanced-full-text-search.md +55 -55
  53. package/stack/skills/supabase-postgres-best-practices/references/advanced-jsonb-indexing.md +49 -49
  54. package/stack/skills/supabase-postgres-best-practices/references/conn-idle-timeout.md +46 -46
  55. package/stack/skills/supabase-postgres-best-practices/references/conn-limits.md +44 -44
  56. package/stack/skills/supabase-postgres-best-practices/references/conn-pooling.md +41 -41
  57. package/stack/skills/supabase-postgres-best-practices/references/conn-prepared-statements.md +46 -46
  58. package/stack/skills/supabase-postgres-best-practices/references/data-batch-inserts.md +54 -54
  59. package/stack/skills/supabase-postgres-best-practices/references/data-n-plus-one.md +53 -53
  60. package/stack/skills/supabase-postgres-best-practices/references/data-pagination.md +50 -50
  61. package/stack/skills/supabase-postgres-best-practices/references/data-upsert.md +50 -50
  62. package/stack/skills/supabase-postgres-best-practices/references/lock-advisory.md +56 -56
  63. package/stack/skills/supabase-postgres-best-practices/references/lock-deadlock-prevention.md +68 -68
  64. package/stack/skills/supabase-postgres-best-practices/references/lock-short-transactions.md +50 -50
  65. package/stack/skills/supabase-postgres-best-practices/references/lock-skip-locked.md +54 -54
  66. package/stack/skills/supabase-postgres-best-practices/references/monitor-explain-analyze.md +45 -45
  67. package/stack/skills/supabase-postgres-best-practices/references/monitor-pg-stat-statements.md +55 -55
  68. package/stack/skills/supabase-postgres-best-practices/references/monitor-vacuum-analyze.md +55 -55
  69. package/stack/skills/supabase-postgres-best-practices/references/query-composite-indexes.md +44 -44
  70. package/stack/skills/supabase-postgres-best-practices/references/query-covering-indexes.md +40 -40
  71. package/stack/skills/supabase-postgres-best-practices/references/query-index-types.md +48 -48
  72. package/stack/skills/supabase-postgres-best-practices/references/query-missing-indexes.md +43 -43
  73. package/stack/skills/supabase-postgres-best-practices/references/query-partial-indexes.md +45 -45
  74. package/stack/skills/supabase-postgres-best-practices/references/schema-constraints.md +80 -80
  75. package/stack/skills/supabase-postgres-best-practices/references/schema-data-types.md +46 -46
  76. package/stack/skills/supabase-postgres-best-practices/references/schema-foreign-key-indexes.md +59 -59
  77. package/stack/skills/supabase-postgres-best-practices/references/schema-lowercase-identifiers.md +55 -55
  78. package/stack/skills/supabase-postgres-best-practices/references/schema-partitioning.md +55 -55
  79. package/stack/skills/supabase-postgres-best-practices/references/schema-primary-keys.md +61 -61
  80. package/stack/skills/supabase-postgres-best-practices/references/security-privileges.md +54 -54
  81. package/stack/skills/supabase-postgres-best-practices/references/security-rls-basics.md +50 -50
  82. package/stack/skills/supabase-postgres-best-practices/references/security-rls-performance.md +63 -63
  83. package/stack/skills/tdd/SKILL.md +109 -109
  84. package/stack/skills/tdd/deep-modules.md +33 -33
  85. package/stack/skills/tdd/interface-design.md +31 -31
  86. package/stack/skills/tdd/mocking.md +59 -59
  87. package/stack/skills/tdd/refactoring.md +10 -10
  88. package/stack/skills/tdd/tests.md +61 -61
  89. package/stack/skills/to-issues/SKILL.md +83 -83
  90. package/stack/skills/to-prd/SKILL.md +72 -72
  91. package/upstreams.json +96 -96
@@ -1,109 +1,109 @@
1
- ---
2
- name: tdd
3
- description: Test-driven development with red-green-refactor loop. Use when user wants to build features or fix bugs using TDD, mentions "red-green-refactor", wants integration tests, or asks for test-first development.
4
- ---
5
-
6
- # Test-Driven Development
7
-
8
- ## Philosophy
9
-
10
- **Core principle**: Tests should verify behavior through public interfaces, not implementation details. Code can change entirely; tests shouldn't.
11
-
12
- **Good tests** are integration-style: they exercise real code paths through public APIs. They describe _what_ the system does, not _how_ it does it. A good test reads like a specification - "user can checkout with valid cart" tells you exactly what capability exists. These tests survive refactors because they don't care about internal structure.
13
-
14
- **Bad tests** are coupled to implementation. They mock internal collaborators, test private methods, or verify through external means (like querying a database directly instead of using the interface). The warning sign: your test breaks when you refactor, but behavior hasn't changed. If you rename an internal function and tests fail, those tests were testing implementation, not behavior.
15
-
16
- See [tests.md](tests.md) for examples and [mocking.md](mocking.md) for mocking guidelines.
17
-
18
- ## Anti-Pattern: Horizontal Slices
19
-
20
- **DO NOT write all tests first, then all implementation.** This is "horizontal slicing" - treating RED as "write all tests" and GREEN as "write all code."
21
-
22
- This produces **crap tests**:
23
-
24
- - Tests written in bulk test _imagined_ behavior, not _actual_ behavior
25
- - You end up testing the _shape_ of things (data structures, function signatures) rather than user-facing behavior
26
- - Tests become insensitive to real changes - they pass when behavior breaks, fail when behavior is fine
27
- - You outrun your headlights, committing to test structure before understanding the implementation
28
-
29
- **Correct approach**: Vertical slices via tracer bullets. One test → one implementation → repeat. Each test responds to what you learned from the previous cycle. Because you just wrote the code, you know exactly what behavior matters and how to verify it.
30
-
31
- ```
32
- WRONG (horizontal):
33
- RED: test1, test2, test3, test4, test5
34
- GREEN: impl1, impl2, impl3, impl4, impl5
35
-
36
- RIGHT (vertical):
37
- RED→GREEN: test1→impl1
38
- RED→GREEN: test2→impl2
39
- RED→GREEN: test3→impl3
40
- ...
41
- ```
42
-
43
- ## Workflow
44
-
45
- ### 1. Planning
46
-
47
- When exploring the codebase, use the project's domain glossary so that test names and interface vocabulary match the project's language, and respect ADRs in the area you're touching.
48
-
49
- Before writing any code:
50
-
51
- - [ ] Confirm with user what interface changes are needed
52
- - [ ] Confirm with user which behaviors to test (prioritize)
53
- - [ ] Identify opportunities for [deep modules](deep-modules.md) (small interface, deep implementation)
54
- - [ ] Design interfaces for [testability](interface-design.md)
55
- - [ ] List the behaviors to test (not implementation steps)
56
- - [ ] Get user approval on the plan
57
-
58
- Ask: "What should the public interface look like? Which behaviors are most important to test?"
59
-
60
- **You can't test everything.** Confirm with the user exactly which behaviors matter most. Focus testing effort on critical paths and complex logic, not every possible edge case.
61
-
62
- ### 2. Tracer Bullet
63
-
64
- Write ONE test that confirms ONE thing about the system:
65
-
66
- ```
67
- RED: Write test for first behavior → test fails
68
- GREEN: Write minimal code to pass → test passes
69
- ```
70
-
71
- This is your tracer bullet - proves the path works end-to-end.
72
-
73
- ### 3. Incremental Loop
74
-
75
- For each remaining behavior:
76
-
77
- ```
78
- RED: Write next test → fails
79
- GREEN: Minimal code to pass → passes
80
- ```
81
-
82
- Rules:
83
-
84
- - One test at a time
85
- - Only enough code to pass current test
86
- - Don't anticipate future tests
87
- - Keep tests focused on observable behavior
88
-
89
- ### 4. Refactor
90
-
91
- After all tests pass, look for [refactor candidates](refactoring.md):
92
-
93
- - [ ] Extract duplication
94
- - [ ] Deepen modules (move complexity behind simple interfaces)
95
- - [ ] Apply SOLID principles where natural
96
- - [ ] Consider what new code reveals about existing code
97
- - [ ] Run tests after each refactor step
98
-
99
- **Never refactor while RED.** Get to GREEN first.
100
-
101
- ## Checklist Per Cycle
102
-
103
- ```
104
- [ ] Test describes behavior, not implementation
105
- [ ] Test uses public interface only
106
- [ ] Test would survive internal refactor
107
- [ ] Code is minimal for this test
108
- [ ] No speculative features added
109
- ```
1
+ ---
2
+ name: tdd
3
+ description: Test-driven development with red-green-refactor loop. Use when user wants to build features or fix bugs using TDD, mentions "red-green-refactor", wants integration tests, or asks for test-first development.
4
+ ---
5
+
6
+ # Test-Driven Development
7
+
8
+ ## Philosophy
9
+
10
+ **Core principle**: Tests should verify behavior through public interfaces, not implementation details. Code can change entirely; tests shouldn't.
11
+
12
+ **Good tests** are integration-style: they exercise real code paths through public APIs. They describe _what_ the system does, not _how_ it does it. A good test reads like a specification - "user can checkout with valid cart" tells you exactly what capability exists. These tests survive refactors because they don't care about internal structure.
13
+
14
+ **Bad tests** are coupled to implementation. They mock internal collaborators, test private methods, or verify through external means (like querying a database directly instead of using the interface). The warning sign: your test breaks when you refactor, but behavior hasn't changed. If you rename an internal function and tests fail, those tests were testing implementation, not behavior.
15
+
16
+ See [tests.md](tests.md) for examples and [mocking.md](mocking.md) for mocking guidelines.
17
+
18
+ ## Anti-Pattern: Horizontal Slices
19
+
20
+ **DO NOT write all tests first, then all implementation.** This is "horizontal slicing" - treating RED as "write all tests" and GREEN as "write all code."
21
+
22
+ This produces **crap tests**:
23
+
24
+ - Tests written in bulk test _imagined_ behavior, not _actual_ behavior
25
+ - You end up testing the _shape_ of things (data structures, function signatures) rather than user-facing behavior
26
+ - Tests become insensitive to real changes - they pass when behavior breaks, fail when behavior is fine
27
+ - You outrun your headlights, committing to test structure before understanding the implementation
28
+
29
+ **Correct approach**: Vertical slices via tracer bullets. One test → one implementation → repeat. Each test responds to what you learned from the previous cycle. Because you just wrote the code, you know exactly what behavior matters and how to verify it.
30
+
31
+ ```
32
+ WRONG (horizontal):
33
+ RED: test1, test2, test3, test4, test5
34
+ GREEN: impl1, impl2, impl3, impl4, impl5
35
+
36
+ RIGHT (vertical):
37
+ RED→GREEN: test1→impl1
38
+ RED→GREEN: test2→impl2
39
+ RED→GREEN: test3→impl3
40
+ ...
41
+ ```
42
+
43
+ ## Workflow
44
+
45
+ ### 1. Planning
46
+
47
+ When exploring the codebase, use the project's domain glossary so that test names and interface vocabulary match the project's language, and respect ADRs in the area you're touching.
48
+
49
+ Before writing any code:
50
+
51
+ - [ ] Confirm with user what interface changes are needed
52
+ - [ ] Confirm with user which behaviors to test (prioritize)
53
+ - [ ] Identify opportunities for [deep modules](deep-modules.md) (small interface, deep implementation)
54
+ - [ ] Design interfaces for [testability](interface-design.md)
55
+ - [ ] List the behaviors to test (not implementation steps)
56
+ - [ ] Get user approval on the plan
57
+
58
+ Ask: "What should the public interface look like? Which behaviors are most important to test?"
59
+
60
+ **You can't test everything.** Confirm with the user exactly which behaviors matter most. Focus testing effort on critical paths and complex logic, not every possible edge case.
61
+
62
+ ### 2. Tracer Bullet
63
+
64
+ Write ONE test that confirms ONE thing about the system:
65
+
66
+ ```
67
+ RED: Write test for first behavior → test fails
68
+ GREEN: Write minimal code to pass → test passes
69
+ ```
70
+
71
+ This is your tracer bullet - proves the path works end-to-end.
72
+
73
+ ### 3. Incremental Loop
74
+
75
+ For each remaining behavior:
76
+
77
+ ```
78
+ RED: Write next test → fails
79
+ GREEN: Minimal code to pass → passes
80
+ ```
81
+
82
+ Rules:
83
+
84
+ - One test at a time
85
+ - Only enough code to pass current test
86
+ - Don't anticipate future tests
87
+ - Keep tests focused on observable behavior
88
+
89
+ ### 4. Refactor
90
+
91
+ After all tests pass, look for [refactor candidates](refactoring.md):
92
+
93
+ - [ ] Extract duplication
94
+ - [ ] Deepen modules (move complexity behind simple interfaces)
95
+ - [ ] Apply SOLID principles where natural
96
+ - [ ] Consider what new code reveals about existing code
97
+ - [ ] Run tests after each refactor step
98
+
99
+ **Never refactor while RED.** Get to GREEN first.
100
+
101
+ ## Checklist Per Cycle
102
+
103
+ ```
104
+ [ ] Test describes behavior, not implementation
105
+ [ ] Test uses public interface only
106
+ [ ] Test would survive internal refactor
107
+ [ ] Code is minimal for this test
108
+ [ ] No speculative features added
109
+ ```
@@ -1,33 +1,33 @@
1
- # Deep Modules
2
-
3
- From "A Philosophy of Software Design":
4
-
5
- **Deep module** = small interface + lots of implementation
6
-
7
- ```
8
- ┌─────────────────────┐
9
- │ Small Interface │ ← Few methods, simple params
10
- ├─────────────────────┤
11
- │ │
12
- │ │
13
- │ Deep Implementation│ ← Complex logic hidden
14
- │ │
15
- │ │
16
- └─────────────────────┘
17
- ```
18
-
19
- **Shallow module** = large interface + little implementation (avoid)
20
-
21
- ```
22
- ┌─────────────────────────────────┐
23
- │ Large Interface │ ← Many methods, complex params
24
- ├─────────────────────────────────┤
25
- │ Thin Implementation │ ← Just passes through
26
- └─────────────────────────────────┘
27
- ```
28
-
29
- When designing interfaces, ask:
30
-
31
- - Can I reduce the number of methods?
32
- - Can I simplify the parameters?
33
- - Can I hide more complexity inside?
1
+ # Deep Modules
2
+
3
+ From "A Philosophy of Software Design":
4
+
5
+ **Deep module** = small interface + lots of implementation
6
+
7
+ ```
8
+ ┌─────────────────────┐
9
+ │ Small Interface │ ← Few methods, simple params
10
+ ├─────────────────────┤
11
+ │ │
12
+ │ │
13
+ │ Deep Implementation│ ← Complex logic hidden
14
+ │ │
15
+ │ │
16
+ └─────────────────────┘
17
+ ```
18
+
19
+ **Shallow module** = large interface + little implementation (avoid)
20
+
21
+ ```
22
+ ┌─────────────────────────────────┐
23
+ │ Large Interface │ ← Many methods, complex params
24
+ ├─────────────────────────────────┤
25
+ │ Thin Implementation │ ← Just passes through
26
+ └─────────────────────────────────┘
27
+ ```
28
+
29
+ When designing interfaces, ask:
30
+
31
+ - Can I reduce the number of methods?
32
+ - Can I simplify the parameters?
33
+ - Can I hide more complexity inside?
@@ -1,31 +1,31 @@
1
- # Interface Design for Testability
2
-
3
- Good interfaces make testing natural:
4
-
5
- 1. **Accept dependencies, don't create them**
6
-
7
- ```typescript
8
- // Testable
9
- function processOrder(order, paymentGateway) {}
10
-
11
- // Hard to test
12
- function processOrder(order) {
13
- const gateway = new StripeGateway();
14
- }
15
- ```
16
-
17
- 2. **Return results, don't produce side effects**
18
-
19
- ```typescript
20
- // Testable
21
- function calculateDiscount(cart): Discount {}
22
-
23
- // Hard to test
24
- function applyDiscount(cart): void {
25
- cart.total -= discount;
26
- }
27
- ```
28
-
29
- 3. **Small surface area**
30
- - Fewer methods = fewer tests needed
31
- - Fewer params = simpler test setup
1
+ # Interface Design for Testability
2
+
3
+ Good interfaces make testing natural:
4
+
5
+ 1. **Accept dependencies, don't create them**
6
+
7
+ ```typescript
8
+ // Testable
9
+ function processOrder(order, paymentGateway) {}
10
+
11
+ // Hard to test
12
+ function processOrder(order) {
13
+ const gateway = new StripeGateway();
14
+ }
15
+ ```
16
+
17
+ 2. **Return results, don't produce side effects**
18
+
19
+ ```typescript
20
+ // Testable
21
+ function calculateDiscount(cart): Discount {}
22
+
23
+ // Hard to test
24
+ function applyDiscount(cart): void {
25
+ cart.total -= discount;
26
+ }
27
+ ```
28
+
29
+ 3. **Small surface area**
30
+ - Fewer methods = fewer tests needed
31
+ - Fewer params = simpler test setup
@@ -1,59 +1,59 @@
1
- # When to Mock
2
-
3
- Mock at **system boundaries** only:
4
-
5
- - External APIs (payment, email, etc.)
6
- - Databases (sometimes - prefer test DB)
7
- - Time/randomness
8
- - File system (sometimes)
9
-
10
- Don't mock:
11
-
12
- - Your own classes/modules
13
- - Internal collaborators
14
- - Anything you control
15
-
16
- ## Designing for Mockability
17
-
18
- At system boundaries, design interfaces that are easy to mock:
19
-
20
- **1. Use dependency injection**
21
-
22
- Pass external dependencies in rather than creating them internally:
23
-
24
- ```typescript
25
- // Easy to mock
26
- function processPayment(order, paymentClient) {
27
- return paymentClient.charge(order.total);
28
- }
29
-
30
- // Hard to mock
31
- function processPayment(order) {
32
- const client = new StripeClient(process.env.STRIPE_KEY);
33
- return client.charge(order.total);
34
- }
35
- ```
36
-
37
- **2. Prefer SDK-style interfaces over generic fetchers**
38
-
39
- Create specific functions for each external operation instead of one generic function with conditional logic:
40
-
41
- ```typescript
42
- // GOOD: Each function is independently mockable
43
- const api = {
44
- getUser: (id) => fetch(`/users/${id}`),
45
- getOrders: (userId) => fetch(`/users/${userId}/orders`),
46
- createOrder: (data) => fetch('/orders', { method: 'POST', body: data }),
47
- };
48
-
49
- // BAD: Mocking requires conditional logic inside the mock
50
- const api = {
51
- fetch: (endpoint, options) => fetch(endpoint, options),
52
- };
53
- ```
54
-
55
- The SDK approach means:
56
- - Each mock returns one specific shape
57
- - No conditional logic in test setup
58
- - Easier to see which endpoints a test exercises
59
- - Type safety per endpoint
1
+ # When to Mock
2
+
3
+ Mock at **system boundaries** only:
4
+
5
+ - External APIs (payment, email, etc.)
6
+ - Databases (sometimes - prefer test DB)
7
+ - Time/randomness
8
+ - File system (sometimes)
9
+
10
+ Don't mock:
11
+
12
+ - Your own classes/modules
13
+ - Internal collaborators
14
+ - Anything you control
15
+
16
+ ## Designing for Mockability
17
+
18
+ At system boundaries, design interfaces that are easy to mock:
19
+
20
+ **1. Use dependency injection**
21
+
22
+ Pass external dependencies in rather than creating them internally:
23
+
24
+ ```typescript
25
+ // Easy to mock
26
+ function processPayment(order, paymentClient) {
27
+ return paymentClient.charge(order.total);
28
+ }
29
+
30
+ // Hard to mock
31
+ function processPayment(order) {
32
+ const client = new StripeClient(process.env.STRIPE_KEY);
33
+ return client.charge(order.total);
34
+ }
35
+ ```
36
+
37
+ **2. Prefer SDK-style interfaces over generic fetchers**
38
+
39
+ Create specific functions for each external operation instead of one generic function with conditional logic:
40
+
41
+ ```typescript
42
+ // GOOD: Each function is independently mockable
43
+ const api = {
44
+ getUser: (id) => fetch(`/users/${id}`),
45
+ getOrders: (userId) => fetch(`/users/${userId}/orders`),
46
+ createOrder: (data) => fetch('/orders', { method: 'POST', body: data }),
47
+ };
48
+
49
+ // BAD: Mocking requires conditional logic inside the mock
50
+ const api = {
51
+ fetch: (endpoint, options) => fetch(endpoint, options),
52
+ };
53
+ ```
54
+
55
+ The SDK approach means:
56
+ - Each mock returns one specific shape
57
+ - No conditional logic in test setup
58
+ - Easier to see which endpoints a test exercises
59
+ - Type safety per endpoint
@@ -1,10 +1,10 @@
1
- # Refactor Candidates
2
-
3
- After TDD cycle, look for:
4
-
5
- - **Duplication** → Extract function/class
6
- - **Long methods** → Break into private helpers (keep tests on public interface)
7
- - **Shallow modules** → Combine or deepen
8
- - **Feature envy** → Move logic to where data lives
9
- - **Primitive obsession** → Introduce value objects
10
- - **Existing code** the new code reveals as problematic
1
+ # Refactor Candidates
2
+
3
+ After TDD cycle, look for:
4
+
5
+ - **Duplication** → Extract function/class
6
+ - **Long methods** → Break into private helpers (keep tests on public interface)
7
+ - **Shallow modules** → Combine or deepen
8
+ - **Feature envy** → Move logic to where data lives
9
+ - **Primitive obsession** → Introduce value objects
10
+ - **Existing code** the new code reveals as problematic
@@ -1,61 +1,61 @@
1
- # Good and Bad Tests
2
-
3
- ## Good Tests
4
-
5
- **Integration-style**: Test through real interfaces, not mocks of internal parts.
6
-
7
- ```typescript
8
- // GOOD: Tests observable behavior
9
- test("user can checkout with valid cart", async () => {
10
- const cart = createCart();
11
- cart.add(product);
12
- const result = await checkout(cart, paymentMethod);
13
- expect(result.status).toBe("confirmed");
14
- });
15
- ```
16
-
17
- Characteristics:
18
-
19
- - Tests behavior users/callers care about
20
- - Uses public API only
21
- - Survives internal refactors
22
- - Describes WHAT, not HOW
23
- - One logical assertion per test
24
-
25
- ## Bad Tests
26
-
27
- **Implementation-detail tests**: Coupled to internal structure.
28
-
29
- ```typescript
30
- // BAD: Tests implementation details
31
- test("checkout calls paymentService.process", async () => {
32
- const mockPayment = jest.mock(paymentService);
33
- await checkout(cart, payment);
34
- expect(mockPayment.process).toHaveBeenCalledWith(cart.total);
35
- });
36
- ```
37
-
38
- Red flags:
39
-
40
- - Mocking internal collaborators
41
- - Testing private methods
42
- - Asserting on call counts/order
43
- - Test breaks when refactoring without behavior change
44
- - Test name describes HOW not WHAT
45
- - Verifying through external means instead of interface
46
-
47
- ```typescript
48
- // BAD: Bypasses interface to verify
49
- test("createUser saves to database", async () => {
50
- await createUser({ name: "Alice" });
51
- const row = await db.query("SELECT * FROM users WHERE name = ?", ["Alice"]);
52
- expect(row).toBeDefined();
53
- });
54
-
55
- // GOOD: Verifies through interface
56
- test("createUser makes user retrievable", async () => {
57
- const user = await createUser({ name: "Alice" });
58
- const retrieved = await getUser(user.id);
59
- expect(retrieved.name).toBe("Alice");
60
- });
61
- ```
1
+ # Good and Bad Tests
2
+
3
+ ## Good Tests
4
+
5
+ **Integration-style**: Test through real interfaces, not mocks of internal parts.
6
+
7
+ ```typescript
8
+ // GOOD: Tests observable behavior
9
+ test("user can checkout with valid cart", async () => {
10
+ const cart = createCart();
11
+ cart.add(product);
12
+ const result = await checkout(cart, paymentMethod);
13
+ expect(result.status).toBe("confirmed");
14
+ });
15
+ ```
16
+
17
+ Characteristics:
18
+
19
+ - Tests behavior users/callers care about
20
+ - Uses public API only
21
+ - Survives internal refactors
22
+ - Describes WHAT, not HOW
23
+ - One logical assertion per test
24
+
25
+ ## Bad Tests
26
+
27
+ **Implementation-detail tests**: Coupled to internal structure.
28
+
29
+ ```typescript
30
+ // BAD: Tests implementation details
31
+ test("checkout calls paymentService.process", async () => {
32
+ const mockPayment = jest.mock(paymentService);
33
+ await checkout(cart, payment);
34
+ expect(mockPayment.process).toHaveBeenCalledWith(cart.total);
35
+ });
36
+ ```
37
+
38
+ Red flags:
39
+
40
+ - Mocking internal collaborators
41
+ - Testing private methods
42
+ - Asserting on call counts/order
43
+ - Test breaks when refactoring without behavior change
44
+ - Test name describes HOW not WHAT
45
+ - Verifying through external means instead of interface
46
+
47
+ ```typescript
48
+ // BAD: Bypasses interface to verify
49
+ test("createUser saves to database", async () => {
50
+ await createUser({ name: "Alice" });
51
+ const row = await db.query("SELECT * FROM users WHERE name = ?", ["Alice"]);
52
+ expect(row).toBeDefined();
53
+ });
54
+
55
+ // GOOD: Verifies through interface
56
+ test("createUser makes user retrievable", async () => {
57
+ const user = await createUser({ name: "Alice" });
58
+ const retrieved = await getUser(user.id);
59
+ expect(retrieved.name).toBe("Alice");
60
+ });
61
+ ```