public/code-crispies
2
1
Fork 0
Code Issues 7 Pull Requests Actions Activity

fix: rewrite validation messages to guide learning instead of revealing answers (#4)

Browse Source
This commit is contained in:
Michael Czechowski
2026-03-28 20:10:04 +01:00
parent 372320b807
commit 8d567390e5
10 changed files with 218 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
specs/004-validation-messages/plan.md Normal file
View File

@@ -0,0 +1,77 @@
# Implementation Plan
## Objective
Rewrite validation error messages in the box-model and colors lesson modules (and their localizations) so they guide learners toward the answer instead of revealing it. This breaks the "fail-then-copy" loop identified in the pedagogy audit.
## Approach
1. Rewrite each validation `message` field in the English box-model and colors JSON files using question/hint phrasing that describes the *concept* without stating the exact property-value pair
2. Use the flexbox module's existing messages as the style guide
3. Apply equivalent translations to all 5 localized box-model files (ar, de, es, pl, uk)
4. Run the format-lessons script and tests to verify nothing breaks
5. Commit as a docs/content fix (`fix:` conventional commit)
## File Mapping
### Files to Modify
| File | Action | Changes |
|------|--------|---------|
| `lessons/01-box-model.json` | modify | Rewrite 11 validation messages |
| `lessons/03-colors.json` | modify | Rewrite 4 validation messages |
| `lessons/ar/01-box-model.json` | modify | Translate 11 new guiding messages to Arabic |
| `lessons/de/01-box-model.json` | modify | Translate 11 new guiding messages to German |
| `lessons/es/01-box-model.json` | modify | Translate 11 new guiding messages to Spanish |
| `lessons/pl/01-box-model.json` | modify | Translate 11 new guiding messages to Polish |
| `lessons/uk/01-box-model.json` | modify | Translate 11 new guiding messages to Ukrainian |
### Files NOT Changed
- `lessons/flexbox.json` — already uses guiding messages
- All localized flexbox files — already correct
- No colors localizations exist
## Architecture Decisions
1. **Message style**: Use the same imperative hint style as flexbox ("Use the property that...", "Try the property that...") rather than pure questions. This is consistent with the existing codebase and gives just enough direction without revealing the answer.
2. **No `<kbd>` tags in new messages**: The current answer-revealing messages use `<kbd>` to format exact code. The new guiding messages should avoid `<kbd>` since they won't contain code literals — they describe concepts.
3. **Preserve validation logic**: Only the `message` field changes. The `type`, `value`, `options`, and all other fields remain untouched.
4. **Localization approach**: Translate the English guiding messages into each target language, maintaining the same hint/question style. Keep CSS property names untranslated (they are code).
## Message Mapping (English)
| Lesson | Current Message | New Message |
|--------|----------------|-------------|
| box-model-1 | Set `padding: 1rem` | Which property adds space between content and the element's edge? |
| box-model-2 | Set `border-left: 4px solid steelblue` | Use the shorthand that sets a border on just one side |
| box-model-3 | Set `margin-bottom: 1rem` | Which property pushes neighboring elements away from the bottom? |
| box-model-4 | Set `box-sizing: border-box` | Which sizing mode includes padding and border in the element's width? |
| box-model-5 | Set `padding: 8px 1rem` | Use the two-value shorthand: vertical first, then horizontal |
| box-model-6 | Set `margin: 0 auto` | Use the shorthand that auto-calculates equal horizontal margins |
| box-model-7 | Set `border-radius: 50%` | Which property rounds corners? Think about what percentage makes a circle |
| box-model-8 v1 | Set `padding: 1rem` | Add inner spacing to the notification |
| box-model-8 v2 | Set `border-left: 4px solid coral` | Add a colored accent on the left edge |
| box-model-8 v3 | Set `border-radius: 4px` | Soften the corners of the notification |
| colors-1 | Set `background-color: seashell` | Which property fills the area behind the content? |
| colors-2 | Set `color: coral` | Which property changes the text color? |
| colors-3 | Set `border-color: coral` | Which property changes just the border's color without redefining the whole border? |
| colors-4 | Set `background-color: #ffd700` | Use the same background property, but with a hex code this time |
## Risks
| Risk | Likelihood | Mitigation |
|------|-----------|------------|
| Translation quality for 5 languages | Medium | Use consistent patterns; CSS property names stay in English; keep messages short |
| Messages too vague, frustrating learners | Low | Each message still hints at the concept/direction; task descriptions already contain the answer for early lessons |
| Schema validation failure | Very Low | Only `message` string changes; no structural changes |
## Testing Strategy
1. **Automated**: Run `npm run test` — existing unit tests validate the validator logic, not message content, so they should pass unchanged
2. **Automated**: Run `npm run format.lessons` — ensures JSON formatting is correct
3. **Manual verification**: Spot-check that each new message conceptually matches its lesson without revealing the answer
4. **Schema validation**: JSON files reference the schema; any structural errors would be caught by the editor/tooling

57
specs/004-validation-messages/spec.md Normal file
View File

@@ -0,0 +1,57 @@
# fix: validation error messages reveal the solution instead of guiding learning
**Issue:** [#4](https://git.librete.ch/libretech/code-crispies/issues/4)
**Repository:** libretech/code-crispies
**Author:** libretech
**State:** open
**Labels:** none
## Issue Body
Pedagogy audit: 88% of exercises reveal the answer in error messages, creating a fail-then-copy loop. Change validation messages from 'Set padding: 1rem' to 'Which property adds space between content and the element edge?' This applies across all modules — start with flexbox, box-model, and colors (the 3 worst offenders).
## Scope
The three priority modules:
1. **Flexbox** (`lessons/flexbox.json`) — already uses guiding messages (0 messages need changes)
2. **Box Model** (`lessons/01-box-model.json`) — 11 validation messages reveal exact answers
3. **Colors** (`lessons/03-colors.json`) — 4 validation messages reveal exact answers
Localized versions that need corresponding updates:
- `lessons/ar/01-box-model.json`
- `lessons/de/01-box-model.json`
- `lessons/es/01-box-model.json`
- `lessons/pl/01-box-model.json`
- `lessons/uk/01-box-model.json`
No localized versions exist for colors.
## Acceptance Criteria
- [ ] All validation messages in box-model module guide the learner instead of revealing the answer
- [ ] All validation messages in colors module guide the learner instead of revealing the answer
- [ ] Messages use question or hint phrasing (e.g., "Which property..." or "Try the property that...")
- [ ] Messages never include the exact property-value pair that solves the exercise
- [ ] All 5 localized box-model files receive equivalent translated guiding messages
- [ ] Existing tests continue to pass (message content is not tested, only validation logic)
- [ ] Lesson JSON files remain valid against the module schema
## Current vs Desired Pattern
**Current (answer-revealing):**
```
"message": "Set <kbd>padding: 1rem</kbd>"
```
**Desired (guiding):**
```
"message": "Which property adds space between the content and the element's edge?"
```
## Prior Art
The flexbox module already follows the desired pattern. Its messages serve as the style reference:
- "Try changing the display mode to create a flex container"
- "Use the property that adds spacing between flex items"
- "Use the property that distributes items along the main axis"

20
specs/004-validation-messages/tasks.md Normal file
View File

@@ -0,0 +1,20 @@
# Tasks
## Phase 1: English Lesson Files
- [X] Task 1.1: Rewrite 11 validation messages in `lessons/01-box-model.json`
- [X] Task 1.2: Rewrite 4 validation messages in `lessons/03-colors.json`
## Phase 2: Localized Box-Model Files
- [X] Task 2.1: Update validation messages in `lessons/ar/01-box-model.json` (Arabic) [P]
- [X] Task 2.2: Update validation messages in `lessons/de/01-box-model.json` (German) [P]
- [X] Task 2.3: Update validation messages in `lessons/es/01-box-model.json` (Spanish) [P]
- [X] Task 2.4: Update validation messages in `lessons/pl/01-box-model.json` (Polish) [P]
- [X] Task 2.5: Update validation messages in `lessons/uk/01-box-model.json` (Ukrainian) [P]
## Phase 3: Validation
- [X] Task 3.1: Run `npm run format.lessons` to normalize JSON formatting
- [X] Task 3.2: Run `npm run test` to verify no regressions
- [X] Task 3.3: Spot-check that no message reveals the exact answer
## Phase 4: Commit
- [X] Task 4.1: Commit all changes with conventional commit message