@times-design-system/components-wordpress 1.5.3 → 1.7.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.
- package/dist/blocks/ad-container/block.json +10 -0
- package/dist/blocks/ad-container/edit.js +17 -1
- package/dist/blocks/ad-container/render.php +14 -0
- package/dist/blocks/button/block.json +19 -5
- package/dist/blocks/button/edit.js +33 -15
- package/dist/blocks/button/render.php +38 -2
- package/dist/blocks/button/style.css +63 -0
- package/dist/blocks/chip/block.json +12 -7
- package/dist/blocks/chip/edit.js +20 -17
- package/dist/blocks/chip/render.php +25 -3
- package/dist/blocks/dialog-box/block.json +10 -0
- package/dist/blocks/dialog-box/edit.js +17 -0
- package/dist/blocks/dialog-box/render.php +18 -7
- package/dist/blocks/divider/block.json +10 -0
- package/dist/blocks/divider/edit.js +18 -2
- package/dist/blocks/divider/render.php +14 -1
- package/dist/blocks/flag/block.json +10 -0
- package/dist/blocks/flag/edit.js +27 -2
- package/dist/blocks/flag/render.php +25 -1
- package/dist/blocks/icon/block.json +10 -0
- package/dist/blocks/icon/edit.js +17 -0
- package/dist/blocks/icon/render.php +19 -8
- package/dist/blocks/icon-button/block.json +15 -0
- package/dist/blocks/icon-button/edit.js +33 -1
- package/dist/blocks/icon-button/render.php +19 -0
- package/dist/blocks/icon-button/style.css +37 -3
- package/dist/blocks/input/block.json +10 -0
- package/dist/blocks/input/edit.js +27 -1
- package/dist/blocks/input/render.php +17 -1
- package/dist/blocks/input-helper-message/block.json +10 -0
- package/dist/blocks/input-helper-message/edit.js +17 -0
- package/dist/blocks/input-helper-message/render.php +18 -7
- package/dist/blocks/link/block.json +12 -7
- package/dist/blocks/link/edit.js +21 -18
- package/dist/blocks/link/render.php +25 -3
- package/dist/blocks/tab/block.json +10 -0
- package/dist/blocks/tab/edit.js +17 -0
- package/dist/blocks/tab/render.php +18 -7
- package/dist/blocks/tab-group/block.json +10 -0
- package/dist/blocks/tab-group/edit.js +17 -0
- package/dist/blocks/tab-group/render.php +18 -7
- package/dist/blocks/text/block.json +10 -0
- package/dist/blocks/text/edit.js +18 -2
- package/dist/blocks/text/render.php +14 -1
- package/dist/blocks/toast/block.json +10 -0
- package/dist/blocks/toast/edit.js +18 -1
- package/dist/blocks/toast/render.php +14 -0
- package/dist/index.cjs +389 -148
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +389 -148
- package/dist/index.js.map +1 -1
- package/dist/utils/DATA_ATTRIBUTES_USAGE.md +377 -0
- package/dist/utils/sanitize-data-attributes.php +109 -0
- package/package.json +9 -3
- package/BLOCK_CREATION_CHECKLIST.md +0 -385
- package/BUILD.md +0 -411
- package/CHANGELOG.md +0 -85
- package/SCSS_VARIABLES_REFERENCE.md +0 -316
- package/STYLING_SYNC_GUIDE.md +0 -306
- package/TESTING.md +0 -152
- package/TRANSFORMATION_GUIDE.md +0 -908
- package/dist/blocks/button/style-resolved.css +0 -153
- package/lib/wordpress.js +0 -7
- package/rollup.config.js +0 -75
- package/scripts/build-plugin.cjs +0 -121
- package/scripts/create-block.sh +0 -141
- package/scripts/create-wordpress-block-tests.cjs +0 -438
- package/scripts/create-wordpress-block.cjs +0 -681
- package/src/blocks/ad-container/block.json +0 -29
- package/src/blocks/ad-container/edit.js +0 -42
- package/src/blocks/ad-container/index.js +0 -10
- package/src/blocks/ad-container/render.php +0 -27
- package/src/blocks/ad-container/save.js +0 -16
- package/src/blocks/ad-container/style-editor.css +0 -4
- package/src/blocks/ad-container/style.css +0 -30
- package/src/blocks/button/block.json +0 -90
- package/src/blocks/button/edit.js +0 -187
- package/src/blocks/button/index.js +0 -11
- package/src/blocks/button/render.php +0 -71
- package/src/blocks/button/save.js +0 -52
- package/src/blocks/button/style-editor.css +0 -15
- package/src/blocks/button/style-resolved.css +0 -153
- package/src/blocks/button/style.css +0 -157
- package/src/blocks/chip/block.json +0 -58
- package/src/blocks/chip/edit.js +0 -113
- package/src/blocks/chip/index.js +0 -10
- package/src/blocks/chip/render.php +0 -40
- package/src/blocks/chip/save.js +0 -36
- package/src/blocks/chip/style-editor.css +0 -5
- package/src/blocks/chip/style.css +0 -87
- package/src/blocks/dialog-box/block.json +0 -24
- package/src/blocks/dialog-box/edit.js +0 -41
- package/src/blocks/dialog-box/index.js +0 -17
- package/src/blocks/dialog-box/render.php +0 -24
- package/src/blocks/dialog-box/save.js +0 -23
- package/src/blocks/dialog-box/style.css +0 -23
- package/src/blocks/divider/block.json +0 -32
- package/src/blocks/divider/edit.js +0 -42
- package/src/blocks/divider/index.js +0 -10
- package/src/blocks/divider/render.php +0 -31
- package/src/blocks/divider/save.js +0 -18
- package/src/blocks/divider/style-editor.css +0 -4
- package/src/blocks/divider/style.css +0 -37
- package/src/blocks/flag/block.json +0 -49
- package/src/blocks/flag/edit.js +0 -82
- package/src/blocks/flag/index.js +0 -10
- package/src/blocks/flag/render.php +0 -34
- package/src/blocks/flag/save.js +0 -25
- package/src/blocks/flag/style-editor.css +0 -5
- package/src/blocks/flag/style.css +0 -54
- package/src/blocks/icon/block.json +0 -24
- package/src/blocks/icon/edit.js +0 -41
- package/src/blocks/icon/index.js +0 -17
- package/src/blocks/icon/render.php +0 -24
- package/src/blocks/icon/save.js +0 -23
- package/src/blocks/icon/style.css +0 -23
- package/src/blocks/icon-button/block.json +0 -44
- package/src/blocks/icon-button/edit.js +0 -82
- package/src/blocks/icon-button/index.js +0 -10
- package/src/blocks/icon-button/render.php +0 -46
- package/src/blocks/icon-button/save.js +0 -29
- package/src/blocks/icon-button/style-editor.css +0 -5
- package/src/blocks/icon-button/style.css +0 -31
- package/src/blocks/input/block.json +0 -48
- package/src/blocks/input/edit.js +0 -78
- package/src/blocks/input/index.js +0 -10
- package/src/blocks/input/render.php +0 -39
- package/src/blocks/input/save.js +0 -27
- package/src/blocks/input/style-editor.css +0 -8
- package/src/blocks/input/style.css +0 -53
- package/src/blocks/input-helper-message/block.json +0 -24
- package/src/blocks/input-helper-message/edit.js +0 -42
- package/src/blocks/input-helper-message/index.js +0 -17
- package/src/blocks/input-helper-message/render.php +0 -24
- package/src/blocks/input-helper-message/save.js +0 -23
- package/src/blocks/input-helper-message/style.css +0 -23
- package/src/blocks/link/block.json +0 -72
- package/src/blocks/link/edit.js +0 -151
- package/src/blocks/link/index.js +0 -10
- package/src/blocks/link/render.php +0 -44
- package/src/blocks/link/save.js +0 -46
- package/src/blocks/link/style-editor.css +0 -5
- package/src/blocks/link/style.css +0 -119
- package/src/blocks/tab/block.json +0 -24
- package/src/blocks/tab/edit.js +0 -41
- package/src/blocks/tab/index.js +0 -17
- package/src/blocks/tab/render.php +0 -24
- package/src/blocks/tab/save.js +0 -23
- package/src/blocks/tab/style.css +0 -23
- package/src/blocks/tab-group/block.json +0 -24
- package/src/blocks/tab-group/edit.js +0 -41
- package/src/blocks/tab-group/index.js +0 -17
- package/src/blocks/tab-group/render.php +0 -24
- package/src/blocks/tab-group/save.js +0 -23
- package/src/blocks/tab-group/style.css +0 -23
- package/src/blocks/text/block.json +0 -33
- package/src/blocks/text/edit.js +0 -56
- package/src/blocks/text/index.js +0 -10
- package/src/blocks/text/render.php +0 -26
- package/src/blocks/text/save.js +0 -18
- package/src/blocks/text/style-editor.css +0 -4
- package/src/blocks/text/style.css +0 -7
- package/src/blocks/toast/block.json +0 -40
- package/src/blocks/toast/edit.js +0 -85
- package/src/blocks/toast/index.js +0 -10
- package/src/blocks/toast/render.php +0 -37
- package/src/blocks/toast/save.js +0 -29
- package/src/blocks/toast/style-editor.css +0 -4
- package/src/blocks/toast/style.css +0 -67
- package/src/index.js +0 -16
- package/src/utils/classBuilder.js +0 -53
- package/tsconfig.json +0 -116
- package/vitest.config.js +0 -28
- package/vitest.config.ts +0 -28
- package/vitest.setup.ts +0 -129
package/TESTING.md
DELETED
|
@@ -1,152 +0,0 @@
|
|
|
1
|
-
# WordPress Block Testing Framework
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
Comprehensive test suite for `@times-design-system/components-wordpress` ensuring parity with React components and WordPress block specification compliance.
|
|
6
|
-
|
|
7
|
-
## Test Results
|
|
8
|
-
|
|
9
|
-
- **Total Tests**: 182
|
|
10
|
-
- **Passing**: 163
|
|
11
|
-
- **Failing**: 19 (in attribute-parity reference mapping - expected and informative)
|
|
12
|
-
|
|
13
|
-
## Test Coverage
|
|
14
|
-
|
|
15
|
-
### ✅ Common Tests (43 passing)
|
|
16
|
-
|
|
17
|
-
- **Class Builder** (13 tests)
|
|
18
|
-
- Button class generation with all variants (intent, size, behaviour, state)
|
|
19
|
-
- BEM naming convention validation
|
|
20
|
-
- Modifier combination handling
|
|
21
|
-
|
|
22
|
-
- **Accessibility** (17 tests)
|
|
23
|
-
- ARIA attributes (aria-label, aria-disabled, role)
|
|
24
|
-
- Semantic HTML (button, anchor, input elements)
|
|
25
|
-
- Form accessibility (required, disabled states)
|
|
26
|
-
- Interactive element focus management
|
|
27
|
-
- Visual state indicators through CSS classes
|
|
28
|
-
- High contrast mode support
|
|
29
|
-
|
|
30
|
-
- **Attribute Parity** (13+ tests per block)
|
|
31
|
-
- block.json file existence and validity
|
|
32
|
-
- Attributes object structure
|
|
33
|
-
- Expected attributes presence and types
|
|
34
|
-
- Enum value matching
|
|
35
|
-
- Block naming conventions (tds/\*)
|
|
36
|
-
- Default value configuration
|
|
37
|
-
|
|
38
|
-
### ✅ Block Tests (32 passing - Button)
|
|
39
|
-
|
|
40
|
-
- Basic rendering (button vs. anchor elements)
|
|
41
|
-
- Label text rendering
|
|
42
|
-
- Intent variants (primary, secondary, negative)
|
|
43
|
-
- Size variants (small, medium, large)
|
|
44
|
-
- Behaviour variants (hug, full)
|
|
45
|
-
- State variants (base, hover, pressed, loading, disabled, focus)
|
|
46
|
-
- Disabled state handling
|
|
47
|
-
- Link attributes (href, target, rel)
|
|
48
|
-
- Accessibility (aria-label, proper HTML structure)
|
|
49
|
-
- Combined variant rendering
|
|
50
|
-
- Default value validation
|
|
51
|
-
|
|
52
|
-
### ✅ Integration Tests (30 passing)
|
|
53
|
-
|
|
54
|
-
**Edit/Save Parity** (10 tests)
|
|
55
|
-
|
|
56
|
-
- Identical HTML rendering in edit and save modes
|
|
57
|
-
- Variant preservation across modes
|
|
58
|
-
- Link attributes consistency
|
|
59
|
-
- Disabled state handling
|
|
60
|
-
- Attribute serialization/deserialization
|
|
61
|
-
- Default value consistency
|
|
62
|
-
- Block wrapper consistency
|
|
63
|
-
|
|
64
|
-
**Variant Exhaustion** (20 tests)
|
|
65
|
-
|
|
66
|
-
- All button variant combinations (primary/secondary/negative + small/medium/large + hug/full + all states)
|
|
67
|
-
- Text typography variants
|
|
68
|
-
- Input type variants with state modifiers
|
|
69
|
-
- Chip intent and size combinations
|
|
70
|
-
- Link intent variants
|
|
71
|
-
- Cross-component variant independence validation
|
|
72
|
-
|
|
73
|
-
## Attribute Parity Findings
|
|
74
|
-
|
|
75
|
-
The attribute-parity test identified expected attributes that need validation/updating across blocks:
|
|
76
|
-
|
|
77
|
-
**To resolve failing attribute-parity tests:**
|
|
78
|
-
|
|
79
|
-
1. Review each block's actual attributes in `src/blocks/*/block.json`
|
|
80
|
-
2. Update the `expectedAttributeMap` in `__tests__/common/attribute-parity.test.js`
|
|
81
|
-
3. These failures help ensure synchronization between React and WordPress implementations
|
|
82
|
-
|
|
83
|
-
## Test Infrastructure
|
|
84
|
-
|
|
85
|
-
**Configuration Files:**
|
|
86
|
-
|
|
87
|
-
- `vitest.config.ts` - Vitest runner configuration with jsdom environment
|
|
88
|
-
- `vitest.setup.ts` - Global mocks for WordPress Block Editor APIs
|
|
89
|
-
- `package.json` - Test scripts (test, test:watch, test:ui)
|
|
90
|
-
|
|
91
|
-
**Test Scripts:**
|
|
92
|
-
|
|
93
|
-
- `npm test` - Run all tests once (exit on completion)
|
|
94
|
-
- `npm run test:watch` - Watch mode for development
|
|
95
|
-
- `npm run test:ui` - Visual test UI dashboard
|
|
96
|
-
|
|
97
|
-
**Test Organization:**
|
|
98
|
-
|
|
99
|
-
```
|
|
100
|
-
__tests__/
|
|
101
|
-
├── common/
|
|
102
|
-
│ ├── class-builder.test.js # Utility function validation
|
|
103
|
-
│ ├── attribute-parity.test.js # Block metadata validation
|
|
104
|
-
│ └── accessibility.test.js # A11y pattern validation
|
|
105
|
-
├── blocks/
|
|
106
|
-
│ └── button.test.js # Component-specific tests
|
|
107
|
-
└── integration/
|
|
108
|
-
├── edit-save-parity.test.js # Editor consistency
|
|
109
|
-
└── variant-exhaustion.test.js # Comprehensive variant coverage
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
## Recommended Next Steps
|
|
113
|
-
|
|
114
|
-
1. **Fix Attribute Parity** (15-30 min)
|
|
115
|
-
- Review failing blocks' block.json files
|
|
116
|
-
- Update expectedAttributeMap with actual attributes
|
|
117
|
-
- Re-run tests to verify all attributes are correct
|
|
118
|
-
|
|
119
|
-
2. **Add Block-Specific Tests** (1-2 hours)
|
|
120
|
-
- Create `__tests__/blocks/text.test.js`
|
|
121
|
-
- Create `__tests__/blocks/input.test.js`
|
|
122
|
-
- Create `__tests__/blocks/link.test.js`
|
|
123
|
-
- Create `__tests__/blocks/chip.test.js`
|
|
124
|
-
- Follow button.test.js pattern for consistency
|
|
125
|
-
|
|
126
|
-
3. **Add Inspector Control Tests** (1 hour)
|
|
127
|
-
- Validate Edit components render correct inspector panels
|
|
128
|
-
- Test control interactions update attributes
|
|
129
|
-
- Verify control validation matches component requirements
|
|
130
|
-
|
|
131
|
-
4. **Integration with CI/CD** (30 min)
|
|
132
|
-
- Add test step to GitHub Actions workflow
|
|
133
|
-
- Generate coverage reports
|
|
134
|
-
- Set minimum coverage thresholds
|
|
135
|
-
|
|
136
|
-
5. **Documentation** (30 min)
|
|
137
|
-
- Add testing guidelines to components-wordpress README
|
|
138
|
-
- Document block development workflow with testing
|
|
139
|
-
- Create troubleshooting guide for common test failures
|
|
140
|
-
|
|
141
|
-
## Testing Best Practices Established
|
|
142
|
-
|
|
143
|
-
1. **Parity Testing**: React and WordPress blocks maintain feature parity through test validation
|
|
144
|
-
2. **Variant Coverage**: Exhaustive testing of all enum combinations prevents missing edge cases
|
|
145
|
-
3. **Accessibility First**: All tests validate ARIA attributes and semantic HTML
|
|
146
|
-
4. **Edit/Save Consistency**: Editor and frontend outputs are validated for consistency
|
|
147
|
-
5. **Utility Function Testing**: Shared utilities (classBuilder) have isolated tests
|
|
148
|
-
|
|
149
|
-
## Execution Time
|
|
150
|
-
|
|
151
|
-
- Full suite: ~1.5-2 seconds
|
|
152
|
-
- Suitable for CI/CD pipelines and pre-commit hooks
|