Compare commits
9
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
  damjan_savicandClaude Sonnet 4.5
|
54b0984348 | ||
|
damjan_savicandClaude Sonnet 4.5
|
8cdc8705bf | ||
|
damjan_savicandClaude Sonnet 4.5
|
f6fc9779db | ||
|
damjan_savicandClaude Sonnet 4.5
|
3b6035c349 | ||
|
damjan_savic
|
ef62a67534 | ||
|
damjan_savic
|
30d2b76056 | ||
|
damjan_savicandClaude Sonnet 4.5
|
aaaa60f5db | ||
|
damjan_savicandClaude Sonnet 4.5
|
3377744111 | ||
|
damjan_savicandClaude Sonnet 4.5
|
f0490db544 |
+10
-10
@@ -1,25 +1,25 @@
|
||||
{
|
||||
"active": true,
|
||||
"spec": "021-document-the-scripts-directory-utilities-for-devel",
|
||||
"state": "complete",
|
||||
"spec": "030-add-unit-tests-vitest-configured-but-no-tests-exis",
|
||||
"state": "building",
|
||||
"subtasks": {
|
||||
"completed": 4,
|
||||
"total": 4,
|
||||
"in_progress": 0,
|
||||
"completed": 2,
|
||||
"total": 8,
|
||||
"in_progress": 1,
|
||||
"failed": 0
|
||||
},
|
||||
"phase": {
|
||||
"current": "Create Comprehensive Script Documentation",
|
||||
"current": "Utility Functions Tests",
|
||||
"id": null,
|
||||
"total": 4
|
||||
"total": 2
|
||||
},
|
||||
"workers": {
|
||||
"active": 0,
|
||||
"max": 1
|
||||
},
|
||||
"session": {
|
||||
"number": 5,
|
||||
"started_at": "2026-01-25T06:23:32.966201"
|
||||
"number": 4,
|
||||
"started_at": "2026-01-25T06:18:19.433683"
|
||||
},
|
||||
"last_update": "2026-01-25T06:38:28.009563"
|
||||
"last_update": "2026-01-25T06:32:23.146357"
|
||||
}
|
||||
-69
@@ -1,69 +0,0 @@
|
||||
# Manual Test Plan - 021-document-the-scripts-directory-utilities-for-devel
|
||||
|
||||
**Generated**: 2026-01-25T05:38:27.949357+00:00
|
||||
**Reason**: No automated test framework detected
|
||||
|
||||
## Overview
|
||||
|
||||
This project does not have automated testing infrastructure. Please perform
|
||||
manual verification of the implementation using the checklist below.
|
||||
|
||||
## Pre-Test Setup
|
||||
|
||||
1. [ ] Ensure all dependencies are installed
|
||||
2. [ ] Start any required services
|
||||
3. [ ] Set up test environment variables
|
||||
|
||||
## Acceptance Criteria Verification
|
||||
|
||||
1. [ ] Core functionality works as expected
|
||||
2. [ ] Edge cases are handled
|
||||
3. [ ] Error states are handled gracefully
|
||||
4. [ ] UI/UX meets requirements (if applicable)
|
||||
|
||||
|
||||
## Functional Tests
|
||||
|
||||
### Happy Path
|
||||
- [ ] Primary use case works correctly
|
||||
- [ ] Expected outputs are generated
|
||||
- [ ] No console errors
|
||||
|
||||
### Edge Cases
|
||||
- [ ] Empty input handling
|
||||
- [ ] Invalid input handling
|
||||
- [ ] Boundary conditions
|
||||
|
||||
### Error Handling
|
||||
- [ ] Errors display appropriate messages
|
||||
- [ ] System recovers gracefully from errors
|
||||
- [ ] No data loss on failure
|
||||
|
||||
## Non-Functional Tests
|
||||
|
||||
### Performance
|
||||
- [ ] Response time is acceptable
|
||||
- [ ] No memory leaks observed
|
||||
- [ ] No excessive resource usage
|
||||
|
||||
### Security
|
||||
- [ ] Input is properly sanitized
|
||||
- [ ] No sensitive data exposed
|
||||
- [ ] Authentication works correctly (if applicable)
|
||||
|
||||
## Browser/Environment Testing (if applicable)
|
||||
|
||||
- [ ] Chrome
|
||||
- [ ] Firefox
|
||||
- [ ] Safari
|
||||
- [ ] Mobile viewport
|
||||
|
||||
## Sign-off
|
||||
|
||||
**Tester**: _______________
|
||||
**Date**: _______________
|
||||
**Result**: [ ] PASS [ ] FAIL
|
||||
|
||||
### Notes
|
||||
_Add any observations or issues found during testing_
|
||||
|
||||
-83
@@ -1,83 +0,0 @@
|
||||
=== AUTO-BUILD PROGRESS ===
|
||||
|
||||
Project: Portfolio - Document scripts directory utilities
|
||||
Workspace: C:\Users\damja\WebstormProjects\Portfolio\.auto-claude\worktrees\tasks\021-document-the-scripts-directory-utilities-for-devel
|
||||
Started: 2026-01-25
|
||||
|
||||
Workflow Type: simple
|
||||
Rationale: Documentation-only task with no complex multi-phase coordination required. This involves documenting 11 existing utility scripts without modifying their functionality.
|
||||
|
||||
Session 1 (Planner):
|
||||
- Created implementation_plan.json
|
||||
- Phases: 1
|
||||
- Total subtasks: 4
|
||||
- Created init.sh
|
||||
- Created project_index.json
|
||||
- Created context.json
|
||||
|
||||
Phase Summary:
|
||||
- Phase 1 - Create Comprehensive Script Documentation: 4 subtasks, no dependencies
|
||||
* Subtask 1-1: Create scripts/README.md with documentation for all 11 scripts
|
||||
* Subtask 1-2: Add Scripts section to main README.md
|
||||
* Subtask 1-3: Update package.json with npm script aliases
|
||||
* Subtask 1-4: Document missing scripts
|
||||
|
||||
Services Involved:
|
||||
- frontend: Next.js project (single service)
|
||||
|
||||
Parallelism Analysis:
|
||||
- Max parallel phases: 1
|
||||
- Recommended workers: 1
|
||||
- Parallel groups: None (sequential documentation tasks)
|
||||
|
||||
Investigation Findings:
|
||||
- Found 11 working utility scripts in scripts/ directory
|
||||
- Only 3 scripts exposed in package.json (build:images, generate:images, generate:images:dry)
|
||||
- Scripts categorized into:
|
||||
* Image Processing: optimize-images.js/mjs, generate-icons.mjs/simple
|
||||
* Content Generation: generate-sitemap.js, generate-github-readme.js, generate-og-image.html
|
||||
* Asset Management: download-fonts.js/mjs
|
||||
* Localization: convert-translations.js
|
||||
* Performance Testing: pagespeed-check.js
|
||||
|
||||
Missing Scripts (referenced but don't exist):
|
||||
- generate-blog-images.mjs (in package.json but file missing)
|
||||
- lighthouse-audit-all-locales.js (mentioned in spec)
|
||||
- axe-accessibility-audit.js (mentioned in spec)
|
||||
|
||||
=== STARTUP COMMAND ===
|
||||
|
||||
To continue building this spec, run:
|
||||
|
||||
source auto-claude/.venv/bin/activate && python auto-claude/run.py --spec 021
|
||||
|
||||
Example:
|
||||
source auto-claude/.venv/bin/activate && python auto-claude/run.py --spec 021
|
||||
|
||||
=== END SESSION 1 ===
|
||||
|
||||
=== SESSION 2 (Implementation) - 2026-01-25 ===
|
||||
|
||||
Phase 1: Create Comprehensive Script Documentation
|
||||
|
||||
[✓] Subtask 1-1: Create scripts/README.md with comprehensive documentation
|
||||
- Created scripts/README.md (8.9KB, 322 lines)
|
||||
- Documented all 11 utility scripts:
|
||||
* Image Optimization: optimize-images.js, optimize-images.mjs
|
||||
* SEO & Performance: generate-sitemap.js, pagespeed-check.js
|
||||
* Internationalization: convert-translations.js
|
||||
* Assets & Resources: download-fonts.js, download-fonts.mjs
|
||||
* Icon Generation: generate-icons.mjs, generate-icons-simple.mjs
|
||||
* Documentation: generate-github-readme.js, generate-og-image.html
|
||||
- Each script documented with: purpose, usage, requirements, outputs
|
||||
- Added sections: Overview, Dependencies, NPM Scripts, Best Practices, Common Issues
|
||||
- Committed: e8431af
|
||||
|
||||
Progress: 1/4 subtasks completed (25%)
|
||||
|
||||
Next Steps:
|
||||
- [ ] Subtask 1-2: Add Scripts section to main README.md
|
||||
- [ ] Subtask 1-3: Update package.json with npm script aliases
|
||||
- [ ] Subtask 1-4: Document missing scripts in scripts/README.md
|
||||
|
||||
=== END SESSION 2 ===
|
||||
-51
@@ -1,51 +0,0 @@
|
||||
{
|
||||
"files_to_modify": {
|
||||
"frontend": ["README.md", "package.json"]
|
||||
},
|
||||
"files_to_create": ["scripts/README.md"],
|
||||
"files_to_reference": [
|
||||
"README.md",
|
||||
"scripts/convert-translations.js",
|
||||
"scripts/pagespeed-check.js",
|
||||
"scripts/optimize-images.js"
|
||||
],
|
||||
"patterns": {
|
||||
"documentation_pattern": "Project uses markdown files for documentation with clear section headers (##)",
|
||||
"readme_sections": "README.md has sections for Development, Features, Tech Stack, Project Structure",
|
||||
"script_comments": "Some scripts have JSDoc-style comments at the top explaining purpose and usage"
|
||||
},
|
||||
"existing_implementations": {
|
||||
"description": "Found 11 working utility scripts in scripts/ directory, but only 3 are exposed in package.json. Scripts include image optimization, sitemap generation, font downloads, icon generation, translation conversion, GitHub README generation, and PageSpeed testing.",
|
||||
"relevant_files": [
|
||||
"scripts/optimize-images.js",
|
||||
"scripts/optimize-images.mjs",
|
||||
"scripts/generate-sitemap.js",
|
||||
"scripts/pagespeed-check.js",
|
||||
"scripts/convert-translations.js",
|
||||
"scripts/download-fonts.js",
|
||||
"scripts/download-fonts.mjs",
|
||||
"scripts/generate-icons.mjs",
|
||||
"scripts/generate-icons-simple.mjs",
|
||||
"scripts/generate-github-readme.js",
|
||||
"scripts/generate-og-image.html"
|
||||
],
|
||||
"missing_scripts": [
|
||||
"generate-blog-images.mjs (referenced in package.json but doesn't exist)",
|
||||
"lighthouse-audit-all-locales.js (mentioned in spec but doesn't exist)",
|
||||
"axe-accessibility-audit.js (mentioned in spec but doesn't exist)"
|
||||
]
|
||||
},
|
||||
"investigation_findings": {
|
||||
"script_categories": {
|
||||
"image_processing": ["optimize-images.js", "optimize-images.mjs", "generate-icons.mjs", "generate-icons-simple.mjs"],
|
||||
"content_generation": ["generate-sitemap.js", "generate-github-readme.js", "generate-og-image.html"],
|
||||
"asset_management": ["download-fonts.js", "download-fonts.mjs"],
|
||||
"localization": ["convert-translations.js"],
|
||||
"performance_testing": ["pagespeed-check.js"]
|
||||
},
|
||||
"package_json_scripts": {
|
||||
"documented": ["build:images", "generate:images", "generate:images:dry"],
|
||||
"undocumented_count": 8
|
||||
}
|
||||
}
|
||||
}
|
||||
-204
@@ -1,204 +0,0 @@
|
||||
{
|
||||
"feature": "Document the scripts directory utilities for development workflows",
|
||||
"workflow_type": "simple",
|
||||
"workflow_rationale": "This is a documentation-only task that doesn't require complex multi-phase coordination. It involves documenting existing utility scripts without modifying their functionality. A simple linear workflow is appropriate.",
|
||||
"phases": [
|
||||
{
|
||||
"id": "phase-1-documentation",
|
||||
"name": "Create Comprehensive Script Documentation",
|
||||
"type": "implementation",
|
||||
"description": "Document all utility scripts in the scripts/ directory with usage examples, prerequisites, and integration with package.json",
|
||||
"depends_on": [],
|
||||
"parallel_safe": true,
|
||||
"subtasks": [
|
||||
{
|
||||
"id": "subtask-1-1",
|
||||
"description": "Create scripts/README.md with comprehensive documentation for all 11 utility scripts",
|
||||
"service": "frontend",
|
||||
"files_to_modify": [],
|
||||
"files_to_create": [
|
||||
"scripts/README.md"
|
||||
],
|
||||
"patterns_from": [
|
||||
"README.md"
|
||||
],
|
||||
"verification": {
|
||||
"type": "manual",
|
||||
"instructions": "Verify scripts/README.md exists and documents all scripts: optimize-images (js/mjs), generate-sitemap, pagespeed-check, convert-translations, download-fonts (js/mjs), generate-icons (mjs/simple), generate-github-readme, generate-og-image.html"
|
||||
},
|
||||
"status": "completed",
|
||||
"notes": "Created comprehensive scripts/README.md documenting all 11 utility scripts with purpose, usage, requirements, and examples. Includes sections for image optimization, SEO/performance, i18n, assets, icon generation, and documentation tools."
|
||||
},
|
||||
{
|
||||
"id": "subtask-1-2",
|
||||
"description": "Add Scripts section to main README.md linking to scripts/README.md",
|
||||
"service": "frontend",
|
||||
"files_to_modify": [
|
||||
"README.md"
|
||||
],
|
||||
"files_to_create": [],
|
||||
"patterns_from": [
|
||||
"README.md"
|
||||
],
|
||||
"verification": {
|
||||
"type": "manual",
|
||||
"instructions": "Verify README.md has a new ## Development Scripts section that links to scripts/README.md and lists the main utility categories"
|
||||
},
|
||||
"status": "completed",
|
||||
"notes": "Added Development Scripts section to README.md with link to scripts/README.md and all 6 utility categories (Image Optimization, SEO & Performance, Internationalization, Assets & Resources, Icon Generation, Documentation) plus quick start commands",
|
||||
"updated_at": "2026-01-25T05:33:17.932492+00:00"
|
||||
},
|
||||
{
|
||||
"id": "subtask-1-3",
|
||||
"description": "Update package.json to add npm script commands for undocumented utilities",
|
||||
"service": "frontend",
|
||||
"files_to_modify": [
|
||||
"package.json"
|
||||
],
|
||||
"files_to_create": [],
|
||||
"patterns_from": [
|
||||
"package.json"
|
||||
],
|
||||
"verification": {
|
||||
"type": "command",
|
||||
"command": "npm run --silent 2>&1 | grep -E '(sitemap|fonts|icons|github|translations)' && echo 'OK' || echo 'FAIL'",
|
||||
"expected": "OK"
|
||||
},
|
||||
"status": "completed",
|
||||
"notes": "Added 5 npm script commands to package.json: generate:sitemap, generate:icons, generate:github, download:fonts, and convert:translations. All scripts follow the existing naming patterns (action:target format).",
|
||||
"updated_at": "2026-01-25T05:36:13.342461+00:00"
|
||||
},
|
||||
{
|
||||
"id": "subtask-1-4",
|
||||
"description": "Document missing scripts referenced in package.json and spec",
|
||||
"service": "frontend",
|
||||
"files_to_modify": [
|
||||
"scripts/README.md"
|
||||
],
|
||||
"files_to_create": [],
|
||||
"patterns_from": [],
|
||||
"verification": {
|
||||
"type": "manual",
|
||||
"instructions": "Verify scripts/README.md includes a section noting that generate-blog-images.mjs is referenced in package.json but doesn't exist, and suggests removing or implementing it"
|
||||
},
|
||||
"status": "completed",
|
||||
"notes": "Added 'Missing Scripts' section to scripts/README.md documenting generate-blog-images.mjs (referenced in package.json at lines 11-12 but not implemented). Section includes status, package.json references, description from spec, recommended actions (remove or implement), and impact explanation.",
|
||||
"updated_at": "2026-01-25T05:37:59.451549+00:00"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"summary": {
|
||||
"total_phases": 1,
|
||||
"total_subtasks": 4,
|
||||
"services_involved": [
|
||||
"frontend"
|
||||
],
|
||||
"parallelism": {
|
||||
"max_parallel_phases": 1,
|
||||
"parallel_groups": [],
|
||||
"recommended_workers": 1,
|
||||
"speedup_estimate": "Sequential execution appropriate for documentation task"
|
||||
},
|
||||
"startup_command": "source auto-claude/.venv/bin/activate && python auto-claude/run.py --spec 021"
|
||||
},
|
||||
"verification_strategy": {
|
||||
"risk_level": "trivial",
|
||||
"skip_validation": true,
|
||||
"test_creation_phase": "none",
|
||||
"test_types_required": [],
|
||||
"security_scanning_required": false,
|
||||
"staging_deployment_required": false,
|
||||
"acceptance_criteria": [
|
||||
"scripts/README.md exists and documents all 11 utility scripts",
|
||||
"README.md links to scripts/README.md",
|
||||
"package.json includes convenient npm aliases for major utilities",
|
||||
"Missing scripts are documented"
|
||||
],
|
||||
"verification_steps": [],
|
||||
"reasoning": "Documentation-only change with no functional code modifications. No tests required."
|
||||
},
|
||||
"qa_acceptance": {
|
||||
"unit_tests": {
|
||||
"required": false,
|
||||
"commands": [],
|
||||
"minimum_coverage": null
|
||||
},
|
||||
"integration_tests": {
|
||||
"required": false,
|
||||
"commands": [],
|
||||
"services_to_test": []
|
||||
},
|
||||
"e2e_tests": {
|
||||
"required": false,
|
||||
"commands": [],
|
||||
"flows": []
|
||||
},
|
||||
"browser_verification": {
|
||||
"required": false,
|
||||
"pages": []
|
||||
},
|
||||
"database_verification": {
|
||||
"required": false,
|
||||
"checks": []
|
||||
},
|
||||
"manual_verification": {
|
||||
"required": true,
|
||||
"checklist": [
|
||||
"All 11 existing scripts are documented in scripts/README.md",
|
||||
"Each script has: purpose, usage, prerequisites, examples",
|
||||
"README.md includes Development Scripts section",
|
||||
"package.json has convenient npm aliases added",
|
||||
"Missing scripts are noted with recommendations"
|
||||
]
|
||||
}
|
||||
},
|
||||
"qa_signoff": null,
|
||||
"status": "pr_created",
|
||||
"planStatus": "pr_created",
|
||||
"updated_at": "2026-01-25T18:21:03.572Z",
|
||||
"last_updated": "2026-01-25T05:37:59.451549+00:00",
|
||||
"qa_iteration_history": [
|
||||
{
|
||||
"iteration": 1,
|
||||
"status": "error",
|
||||
"timestamp": "2026-01-25T05:42:32.431706+00:00",
|
||||
"issues": [
|
||||
{
|
||||
"title": "QA error",
|
||||
"description": "QA agent did not update implementation_plan.json"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"iteration": 2,
|
||||
"status": "error",
|
||||
"timestamp": "2026-01-25T05:42:41.471061+00:00",
|
||||
"issues": [
|
||||
{
|
||||
"title": "QA error",
|
||||
"description": "QA agent did not update implementation_plan.json (No tools were used by agent)"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"iteration": 3,
|
||||
"status": "error",
|
||||
"timestamp": "2026-01-25T05:42:53.788470+00:00",
|
||||
"issues": [
|
||||
{
|
||||
"title": "QA error",
|
||||
"description": "QA agent did not update implementation_plan.json (No tools were used by agent)"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"qa_stats": {
|
||||
"total_iterations": 3,
|
||||
"last_iteration": 3,
|
||||
"last_status": "error",
|
||||
"issues_by_type": {
|
||||
"unknown": 3
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,82 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Auto-Build Environment Setup
|
||||
# Generated by Planner Agent for Task 021
|
||||
|
||||
set -e
|
||||
|
||||
echo "========================================"
|
||||
echo "Starting Development Environment"
|
||||
echo "========================================"
|
||||
|
||||
# Colors
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
NC='\033[0m'
|
||||
|
||||
# Wait for service function
|
||||
wait_for_service() {
|
||||
local port=$1
|
||||
local name=$2
|
||||
local max=30
|
||||
local count=0
|
||||
|
||||
echo "Waiting for $name on port $port..."
|
||||
while ! nc -z localhost $port 2>/dev/null; do
|
||||
count=$((count + 1))
|
||||
if [ $count -ge $max ]; then
|
||||
echo -e "${RED}$name failed to start${NC}"
|
||||
return 1
|
||||
fi
|
||||
sleep 1
|
||||
done
|
||||
echo -e "${GREEN}$name ready${NC}"
|
||||
}
|
||||
|
||||
# ============================================
|
||||
# DOCUMENTATION TASK - NO SERVICES TO START
|
||||
# ============================================
|
||||
|
||||
echo ""
|
||||
echo "This is a documentation-only task."
|
||||
echo "No services need to be started."
|
||||
echo ""
|
||||
echo "The task will:"
|
||||
echo " 1. Create scripts/README.md"
|
||||
echo " 2. Update main README.md"
|
||||
echo " 3. Update package.json with script aliases"
|
||||
echo " 4. Document missing scripts"
|
||||
echo ""
|
||||
|
||||
# ============================================
|
||||
# OPTIONAL: Start dev server for testing
|
||||
# ============================================
|
||||
|
||||
read -p "Do you want to start the Next.js dev server? (y/n) " -n 1 -r
|
||||
echo
|
||||
if [[ $REPLY =~ ^[Yy]$ ]]
|
||||
then
|
||||
echo "Starting Next.js development server..."
|
||||
npm run dev &
|
||||
wait_for_service 3000 "Next.js"
|
||||
|
||||
echo ""
|
||||
echo "========================================"
|
||||
echo "Environment Ready!"
|
||||
echo "========================================"
|
||||
echo ""
|
||||
echo "Services:"
|
||||
echo " Next.js: http://localhost:3000"
|
||||
echo ""
|
||||
else
|
||||
echo ""
|
||||
echo "========================================"
|
||||
echo "Ready to document scripts!"
|
||||
echo "========================================"
|
||||
echo ""
|
||||
fi
|
||||
|
||||
echo "To continue building this spec, run:"
|
||||
echo " source auto-claude/.venv/bin/activate && python auto-claude/run.py --spec 021"
|
||||
echo ""
|
||||
-57
@@ -1,57 +0,0 @@
|
||||
{
|
||||
"subtasks": {
|
||||
"subtask-1-1": {
|
||||
"attempts": [
|
||||
{
|
||||
"session": 2,
|
||||
"timestamp": "2026-01-25T06:31:41.237139",
|
||||
"approach": "Implemented: Create scripts/README.md with comprehensive documentation for all 11 utility scripts",
|
||||
"success": true,
|
||||
"error": null
|
||||
}
|
||||
],
|
||||
"status": "completed"
|
||||
},
|
||||
"subtask-1-2": {
|
||||
"attempts": [
|
||||
{
|
||||
"session": 3,
|
||||
"timestamp": "2026-01-25T06:33:26.030867",
|
||||
"approach": "Implemented: Add Scripts section to main README.md linking to scripts/README.md",
|
||||
"success": true,
|
||||
"error": null
|
||||
}
|
||||
],
|
||||
"status": "completed"
|
||||
},
|
||||
"subtask-1-3": {
|
||||
"attempts": [
|
||||
{
|
||||
"session": 4,
|
||||
"timestamp": "2026-01-25T06:36:18.972627",
|
||||
"approach": "Implemented: Update package.json to add npm script commands for undocumented utilities",
|
||||
"success": true,
|
||||
"error": null
|
||||
}
|
||||
],
|
||||
"status": "completed"
|
||||
},
|
||||
"subtask-1-4": {
|
||||
"attempts": [
|
||||
{
|
||||
"session": 5,
|
||||
"timestamp": "2026-01-25T06:38:16.808641",
|
||||
"approach": "Implemented: Document missing scripts referenced in package.json and spec",
|
||||
"success": true,
|
||||
"error": null
|
||||
}
|
||||
],
|
||||
"status": "completed"
|
||||
}
|
||||
},
|
||||
"stuck_subtasks": [],
|
||||
"metadata": {
|
||||
"created_at": "2026-01-25T06:23:32.964712",
|
||||
"last_updated": "2026-01-25T06:38:16.808641"
|
||||
}
|
||||
}
|
||||
-29
@@ -1,29 +0,0 @@
|
||||
{
|
||||
"commits": [
|
||||
{
|
||||
"hash": "e8431af213b4fd778268028b74dbe9e242f04dfb",
|
||||
"subtask_id": "subtask-1-1",
|
||||
"timestamp": "2026-01-25T06:31:41.238144"
|
||||
},
|
||||
{
|
||||
"hash": "240a9f7c4a47c7fa3a832b873cf31c1ca7f8a7e6",
|
||||
"subtask_id": "subtask-1-2",
|
||||
"timestamp": "2026-01-25T06:33:26.031872"
|
||||
},
|
||||
{
|
||||
"hash": "0ed3e317dd60422577fe36b8b238167c264880d7",
|
||||
"subtask_id": "subtask-1-3",
|
||||
"timestamp": "2026-01-25T06:36:18.973633"
|
||||
},
|
||||
{
|
||||
"hash": "ead5b893e7f0e7c7d33e9d8c8d598734b903aca6",
|
||||
"subtask_id": "subtask-1-4",
|
||||
"timestamp": "2026-01-25T06:38:17.116968"
|
||||
}
|
||||
],
|
||||
"last_good_commit": "ead5b893e7f0e7c7d33e9d8c8d598734b903aca6",
|
||||
"metadata": {
|
||||
"created_at": "2026-01-25T06:23:32.964712",
|
||||
"last_updated": "2026-01-25T06:38:17.116968"
|
||||
}
|
||||
}
|
||||
-134
@@ -1,134 +0,0 @@
|
||||
{
|
||||
"session_number": 2,
|
||||
"timestamp": "2026-01-25T05:31:54.372954+00:00",
|
||||
"subtasks_completed": [
|
||||
"subtask-1-1"
|
||||
],
|
||||
"discoveries": {
|
||||
"file_insights": [
|
||||
{
|
||||
"file": "scripts/README.md",
|
||||
"type": "documentation",
|
||||
"size_lines": 322,
|
||||
"purpose": "Comprehensive documentation for 11 utility scripts in the scripts directory",
|
||||
"key_sections": [
|
||||
"Overview (11 scripts documented)",
|
||||
"Image Optimization (2 scripts)",
|
||||
"SEO & Performance (2 scripts)",
|
||||
"Internationalization (1 script)",
|
||||
"Assets & Resources (2 scripts)",
|
||||
"Icon Generation (2 scripts)",
|
||||
"Documentation (2 scripts)",
|
||||
"Dependencies listing",
|
||||
"NPM Scripts aliases",
|
||||
"Best Practices",
|
||||
"Common Issues and solutions"
|
||||
],
|
||||
"structure_quality": "Well-organized with consistent formatting, clear headings, usage examples, and detailed descriptions"
|
||||
}
|
||||
],
|
||||
"patterns_discovered": [
|
||||
{
|
||||
"pattern": "Dual module format implementation",
|
||||
"description": "Scripts exist in both CommonJS (.js) and ES Module (.mjs) formats for compatibility (download-fonts, optimize-images)",
|
||||
"frequency": 2,
|
||||
"impact": "Supports different Node.js environments and module systems"
|
||||
},
|
||||
{
|
||||
"pattern": "Comprehensive documentation template",
|
||||
"description": "Each script documented with Purpose, Usage, What it does, Requirements, and Output sections",
|
||||
"frequency": "all scripts",
|
||||
"impact": "Ensures consistency and discoverability across documentation"
|
||||
},
|
||||
{
|
||||
"pattern": "Multi-language support",
|
||||
"description": "Sitemap generation supports 3 languages (German, English, Serbian) with hreflang SEO support",
|
||||
"frequency": 1,
|
||||
"impact": "Reflects internationalized application architecture"
|
||||
},
|
||||
{
|
||||
"pattern": "Fallback implementations",
|
||||
"description": "Icon generation has both sharp-based and simple SVG fallback versions",
|
||||
"frequency": 2,
|
||||
"impact": "Reduces dependency on external libraries, improves robustness"
|
||||
}
|
||||
],
|
||||
"gotchas_discovered": [
|
||||
{
|
||||
"gotcha": "SSL verification disabled in pagespeed-check.js",
|
||||
"location": "pagespeed-check.js line 10",
|
||||
"severity": "medium",
|
||||
"note": "Development-specific configuration that disables SSL verification for local testing - should be documented and controlled"
|
||||
},
|
||||
{
|
||||
"gotcha": "generate-icons-simple.mjs outputs SVG instead of PNG",
|
||||
"location": "generate-icons-simple.mjs documentation",
|
||||
"severity": "medium",
|
||||
"note": "Manifest.json may expect PNG format, requiring configuration updates when using this fallback"
|
||||
},
|
||||
{
|
||||
"gotcha": "HTML file requires manual processing",
|
||||
"location": "generate-og-image.html",
|
||||
"severity": "low",
|
||||
"note": "Unlike other scripts, this is an HTML template requiring browser screenshot or headless browser tool, not directly executable"
|
||||
},
|
||||
{
|
||||
"gotcha": "Font download dependencies",
|
||||
"location": "download-fonts scripts",
|
||||
"severity": "low",
|
||||
"note": "External dependency on rsms.me/inter - network availability required, no offline fallback documented"
|
||||
}
|
||||
],
|
||||
"approach_outcome": {
|
||||
"subtask": "Create scripts/README.md with comprehensive documentation for all 11 utility scripts",
|
||||
"status": "SUCCESS",
|
||||
"deliverables_completed": 1,
|
||||
"completeness": "100%",
|
||||
"methodology": "Created single comprehensive README documenting all 11 scripts with consistent structure, detailed usage examples, and troubleshooting guide",
|
||||
"documentation_coverage": "All 11 scripts documented with Purpose, Usage, Functionality, Requirements, and Output information"
|
||||
},
|
||||
"recommendations": [
|
||||
{
|
||||
"category": "Security",
|
||||
"recommendation": "Remove or conditionally gate SSL verification bypass in pagespeed-check.js",
|
||||
"priority": "medium",
|
||||
"rationale": "NODE_TLS_REJECT_UNAUTHORIZED='0' is a development-specific security issue that should be clearly documented or replaced with safer alternatives"
|
||||
},
|
||||
{
|
||||
"category": "Maintenance",
|
||||
"recommendation": "Add last-run timestamps and validation checks to scripts",
|
||||
"priority": "low",
|
||||
"rationale": "Would help track when scripts were last executed and identify stale outputs"
|
||||
},
|
||||
{
|
||||
"category": "Documentation",
|
||||
"recommendation": "Create script execution checklist or workflow documentation",
|
||||
"priority": "low",
|
||||
"rationale": "README documents individual scripts well; a guide for execution order/dependencies between scripts would be valuable"
|
||||
},
|
||||
{
|
||||
"category": "Tooling",
|
||||
"recommendation": "Consider unifying module formats to ES modules only",
|
||||
"priority": "low",
|
||||
"rationale": "Current dual CommonJS/ESM approach works but adds maintenance overhead; migrating entirely to .mjs would simplify"
|
||||
},
|
||||
{
|
||||
"category": "Error Handling",
|
||||
"recommendation": "Document expected error conditions and recovery steps for each script",
|
||||
"priority": "medium",
|
||||
"rationale": "Common Issues section is excellent; extending this for each script would improve developer experience"
|
||||
}
|
||||
],
|
||||
"subtask_id": "subtask-1-1",
|
||||
"session_num": 2,
|
||||
"success": true,
|
||||
"changed_files": [
|
||||
"scripts/README.md"
|
||||
]
|
||||
},
|
||||
"what_worked": [
|
||||
"Implemented subtask: subtask-1-1"
|
||||
],
|
||||
"what_failed": [],
|
||||
"recommendations_for_next_session": []
|
||||
}
|
||||
-86
@@ -1,86 +0,0 @@
|
||||
{
|
||||
"session_number": 3,
|
||||
"timestamp": "2026-01-25T05:33:34.437176+00:00",
|
||||
"subtasks_completed": [
|
||||
"subtask-1-2"
|
||||
],
|
||||
"discoveries": {
|
||||
"file_insights": [
|
||||
{
|
||||
"file": "README.md",
|
||||
"changes": "Added comprehensive 'Development Scripts' section (21 lines)",
|
||||
"type": "documentation_enhancement",
|
||||
"scope": "Added new section between 'Getting Started' and 'Key Technologies Used'",
|
||||
"content_added": {
|
||||
"summary": "Scripts section with overview, categories, and quick start examples",
|
||||
"categories_documented": 6,
|
||||
"quick_start_examples": 3,
|
||||
"link_added": "scripts/README.md"
|
||||
}
|
||||
}
|
||||
],
|
||||
"patterns_discovered": [
|
||||
{
|
||||
"pattern": "Documentation Structure",
|
||||
"description": "Section organized with header, overview with script count, categorized list, and code examples",
|
||||
"evidence": "Clear hierarchy with bold categories, descriptions, and bash code block"
|
||||
},
|
||||
{
|
||||
"pattern": "Link Strategy",
|
||||
"description": "Main README references detailed documentation in scripts/README.md rather than duplicating content",
|
||||
"evidence": "Single link: '[scripts/README.md](scripts/README.md)' with clear indication of full documentation"
|
||||
},
|
||||
{
|
||||
"pattern": "Quick Reference Format",
|
||||
"description": "Quick start section provides most common commands for rapid developer access",
|
||||
"evidence": "Three most-used commands highlighted in bash code block with inline comments"
|
||||
}
|
||||
],
|
||||
"gotchas_discovered": [
|
||||
{
|
||||
"gotcha": "Single attempt success",
|
||||
"description": "Task completed on first attempt without revisions or iterations",
|
||||
"significance": "Indicates either well-defined requirements or straightforward implementation"
|
||||
}
|
||||
],
|
||||
"approach_outcome": {
|
||||
"status": "SUCCESS",
|
||||
"description": "Successfully added Scripts section to README.md linking to detailed documentation",
|
||||
"execution": "Single attempt implementation",
|
||||
"quality_indicators": [
|
||||
"Proper markdown formatting with headers and code blocks",
|
||||
"Well-organized with categories matching actual script purposes",
|
||||
"Balance between overview and detailed documentation reference",
|
||||
"Practical quick start examples for developers"
|
||||
]
|
||||
},
|
||||
"recommendations": [
|
||||
{
|
||||
"type": "documentation_maintenance",
|
||||
"suggestion": "Keep scripts/README.md in sync with Development Scripts section as new scripts are added",
|
||||
"priority": "medium"
|
||||
},
|
||||
{
|
||||
"type": "developer_experience",
|
||||
"suggestion": "Consider adding script prerequisites or setup requirements in the quick start section",
|
||||
"priority": "low"
|
||||
},
|
||||
{
|
||||
"type": "consistency",
|
||||
"suggestion": "Ensure all 11 scripts mentioned are documented in scripts/README.md with examples",
|
||||
"priority": "medium"
|
||||
}
|
||||
],
|
||||
"subtask_id": "subtask-1-2",
|
||||
"session_num": 3,
|
||||
"success": true,
|
||||
"changed_files": [
|
||||
"README.md"
|
||||
]
|
||||
},
|
||||
"what_worked": [
|
||||
"Implemented subtask: subtask-1-2"
|
||||
],
|
||||
"what_failed": [],
|
||||
"recommendations_for_next_session": []
|
||||
}
|
||||
-122
@@ -1,122 +0,0 @@
|
||||
{
|
||||
"session_number": 4,
|
||||
"timestamp": "2026-01-25T05:36:28.451643+00:00",
|
||||
"subtasks_completed": [
|
||||
"subtask-1-3"
|
||||
],
|
||||
"discoveries": {
|
||||
"file_insights": [
|
||||
{
|
||||
"file_path": "package.json",
|
||||
"changes_made": "Added 5 new npm script commands",
|
||||
"lines_modified": 5,
|
||||
"change_type": "enhancement",
|
||||
"details": [
|
||||
{
|
||||
"script_name": "generate:sitemap",
|
||||
"command": "node scripts/generate-sitemap.js",
|
||||
"purpose": "Generate sitemap for SEO"
|
||||
},
|
||||
{
|
||||
"script_name": "generate:icons",
|
||||
"command": "node scripts/generate-icons.mjs",
|
||||
"purpose": "Generate icon assets"
|
||||
},
|
||||
{
|
||||
"script_name": "generate:github",
|
||||
"command": "node scripts/generate-github-readme.js",
|
||||
"purpose": "Generate GitHub README documentation"
|
||||
},
|
||||
{
|
||||
"script_name": "download:fonts",
|
||||
"command": "node scripts/download-fonts.mjs",
|
||||
"purpose": "Download font files"
|
||||
},
|
||||
{
|
||||
"script_name": "convert:translations",
|
||||
"command": "node scripts/convert-translations.js",
|
||||
"purpose": "Convert translation files"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"patterns_discovered": [
|
||||
{
|
||||
"pattern": "Utility script organization",
|
||||
"description": "Undocumented utility scripts exist in scripts/ directory and were made discoverable via npm scripts"
|
||||
},
|
||||
{
|
||||
"pattern": "Consistent naming convention",
|
||||
"description": "Scripts follow verb:noun convention (generate:*, download:*, convert:*) for clarity"
|
||||
},
|
||||
{
|
||||
"pattern": "Mixed file extensions",
|
||||
"description": "Scripts use both .js and .mjs extensions, indicating mixed module system usage"
|
||||
},
|
||||
{
|
||||
"pattern": "Documentation gap closure",
|
||||
"description": "Previously undocumented utilities are now accessible through standardized npm script interface"
|
||||
}
|
||||
],
|
||||
"gotchas_discovered": [
|
||||
{
|
||||
"gotcha": "Hidden utility scripts",
|
||||
"description": "Utility scripts existed but were not documented in package.json, making them hard to discover",
|
||||
"impact": "Reduced developer productivity and team knowledge sharing"
|
||||
},
|
||||
{
|
||||
"gotcha": "Mixed module formats",
|
||||
"description": "Project uses both CommonJS (.js) and ES modules (.mjs) for different utilities",
|
||||
"impact": "Developers need to understand which runtime environment each script requires"
|
||||
},
|
||||
{
|
||||
"gotcha": "No script descriptions",
|
||||
"description": "npm scripts lack inline comments or documentation about their purpose",
|
||||
"impact": "Developers must manually inspect script files to understand functionality"
|
||||
}
|
||||
],
|
||||
"approach_outcome": {
|
||||
"status": "SUCCESS",
|
||||
"summary": "Successfully identified and documented 5 undocumented utility scripts by adding npm script entries to package.json",
|
||||
"effectiveness": "High - Simple, non-breaking change that improves discoverability",
|
||||
"completeness": "Complete - All identified utilities were added to package.json"
|
||||
},
|
||||
"recommendations": [
|
||||
{
|
||||
"priority": "high",
|
||||
"recommendation": "Add npm script descriptions",
|
||||
"rationale": "Include comments or use npm script documentation tools to describe what each utility does",
|
||||
"implementation": "Add /* comments */ or use npm-scripts-doc package"
|
||||
},
|
||||
{
|
||||
"priority": "medium",
|
||||
"recommendation": "Standardize module formats",
|
||||
"rationale": "Consolidate .js and .mjs usage for consistency and to reduce confusion",
|
||||
"implementation": "Choose either CommonJS or ES modules and gradually migrate all utilities"
|
||||
},
|
||||
{
|
||||
"priority": "medium",
|
||||
"recommendation": "Create utility documentation",
|
||||
"rationale": "Document each utility script's purpose, parameters, and usage in project README",
|
||||
"implementation": "Add utilities section to README with examples"
|
||||
},
|
||||
{
|
||||
"priority": "low",
|
||||
"recommendation": "Consider grouping related utilities",
|
||||
"rationale": "Group generation scripts together in package.json for better organization",
|
||||
"implementation": "Reorder scripts by category (generate, download, convert)"
|
||||
}
|
||||
],
|
||||
"subtask_id": "subtask-1-3",
|
||||
"session_num": 4,
|
||||
"success": true,
|
||||
"changed_files": [
|
||||
"package.json"
|
||||
]
|
||||
},
|
||||
"what_worked": [
|
||||
"Implemented subtask: subtask-1-3"
|
||||
],
|
||||
"what_failed": [],
|
||||
"recommendations_for_next_session": []
|
||||
}
|
||||
-127
@@ -1,127 +0,0 @@
|
||||
{
|
||||
"session_number": 5,
|
||||
"timestamp": "2026-01-25T05:38:27.932722+00:00",
|
||||
"subtasks_completed": [
|
||||
"subtask-1-4"
|
||||
],
|
||||
"discoveries": {
|
||||
"file_insights": [
|
||||
{
|
||||
"file_path": "scripts/README.md",
|
||||
"change_type": "documentation_addition",
|
||||
"lines_added": 30,
|
||||
"lines_removed": 0,
|
||||
"purpose": "Document missing script implementation gap",
|
||||
"key_content": [
|
||||
"Documented missing generate-blog-images.mjs script",
|
||||
"Listed package.json references for the missing script",
|
||||
"Provided specification description for the missing functionality",
|
||||
"Outlined two recommended actions (remove or implement)",
|
||||
"Documented impact of missing implementation"
|
||||
]
|
||||
}
|
||||
],
|
||||
"patterns_discovered": [
|
||||
{
|
||||
"pattern": "Missing Script Documentation",
|
||||
"description": "Project has npm scripts defined in package.json that reference non-existent implementation files",
|
||||
"frequency": "At least one identified (generate-blog-images.mjs)"
|
||||
},
|
||||
{
|
||||
"pattern": "Dual Script Extension Support",
|
||||
"description": "Repository uses both .js (CommonJS) and .mjs (ES Module) file extensions for scripts",
|
||||
"impact": "Inconsistent module system usage that may cause compatibility issues"
|
||||
},
|
||||
{
|
||||
"pattern": "Documentation-Driven Issue Resolution",
|
||||
"description": "Issues are being systematically documented in scripts/README.md with status, references, and remediation steps",
|
||||
"evidence": "Clear formatting of missing scripts with status badges and action items"
|
||||
}
|
||||
],
|
||||
"gotchas_discovered": [
|
||||
{
|
||||
"gotcha": "Broken npm Script References",
|
||||
"description": "npm run generate:images and npm run generate:images:dry will fail at runtime with 'Cannot find module' error",
|
||||
"severity": "high",
|
||||
"affected_scripts": [
|
||||
"generate:images",
|
||||
"generate:images:dry"
|
||||
]
|
||||
},
|
||||
{
|
||||
"gotcha": "Unimplemented AI Integration",
|
||||
"description": "Scripts reference OpenAI API integration that was specified but never implemented",
|
||||
"severity": "medium",
|
||||
"dependent_features": [
|
||||
"Automated blog image generation",
|
||||
"AI-powered image features"
|
||||
]
|
||||
},
|
||||
{
|
||||
"gotcha": "Decision Debt",
|
||||
"description": "Unresolved choice between removing broken references or implementing missing functionality creates ongoing maintenance burden",
|
||||
"severity": "medium"
|
||||
}
|
||||
],
|
||||
"approach_outcome": {
|
||||
"status": "SUCCESS",
|
||||
"strategy": "Documentation and visibility approach - rather than implementing the missing script, the gap was thoroughly documented to make it visible and actionable",
|
||||
"rationale": "Documenting unimplemented features provides transparency about project state and creates clear action items for future work",
|
||||
"effectiveness": "Prevents silent failures and establishes baseline for tracking missing implementations"
|
||||
},
|
||||
"recommendations": [
|
||||
{
|
||||
"priority": "high",
|
||||
"category": "issue_resolution",
|
||||
"recommendation": "Decide on generate-blog-images.mjs implementation",
|
||||
"action_items": [
|
||||
"Decision: Remove npm script references if feature is not needed",
|
||||
"Decision: Implement script with OpenAI API integration if feature is desired",
|
||||
"Timeline: Resolve before release to prevent broken npm scripts"
|
||||
]
|
||||
},
|
||||
{
|
||||
"priority": "medium",
|
||||
"category": "code_quality",
|
||||
"recommendation": "Audit all npm scripts for similar implementation gaps",
|
||||
"action_items": [
|
||||
"Review all scripts referenced in package.json",
|
||||
"Verify each script file exists",
|
||||
"Document any other missing implementations",
|
||||
"Create tracking issue for systematic resolution"
|
||||
]
|
||||
},
|
||||
{
|
||||
"priority": "medium",
|
||||
"category": "consistency",
|
||||
"recommendation": "Standardize module extension usage (.js vs .mjs)",
|
||||
"action_items": [
|
||||
"Evaluate CommonJS vs ES Module strategy",
|
||||
"Migrate scripts to single consistent format",
|
||||
"Update documentation to reflect chosen approach"
|
||||
]
|
||||
},
|
||||
{
|
||||
"priority": "low",
|
||||
"category": "documentation",
|
||||
"recommendation": "Expand README.md documentation pattern",
|
||||
"action_items": [
|
||||
"Document required environment variables (OpenAI API key)",
|
||||
"Add examples of expected script output",
|
||||
"Include troubleshooting section for common failures"
|
||||
]
|
||||
}
|
||||
],
|
||||
"subtask_id": "subtask-1-4",
|
||||
"session_num": 5,
|
||||
"success": true,
|
||||
"changed_files": [
|
||||
"scripts/README.md"
|
||||
]
|
||||
},
|
||||
"what_worked": [
|
||||
"Implemented subtask: subtask-1-4"
|
||||
],
|
||||
"what_failed": [],
|
||||
"recommendations_for_next_session": []
|
||||
}
|
||||
-29
@@ -1,29 +0,0 @@
|
||||
{
|
||||
"project_type": "single",
|
||||
"services": {
|
||||
"frontend": {
|
||||
"path": ".",
|
||||
"tech_stack": ["next.js", "react", "typescript", "tailwindcss"],
|
||||
"port": 3000,
|
||||
"dev_command": "npm run dev",
|
||||
"test_command": "npm test"
|
||||
}
|
||||
},
|
||||
"infrastructure": {
|
||||
"docker": true,
|
||||
"database": "supabase",
|
||||
"ci_cd": false
|
||||
},
|
||||
"conventions": {
|
||||
"linter": "eslint",
|
||||
"formatter": "prettier",
|
||||
"testing": "vitest",
|
||||
"package_manager": "npm"
|
||||
},
|
||||
"scripts_directory": {
|
||||
"path": "scripts/",
|
||||
"count": 11,
|
||||
"languages": ["javascript", "html"],
|
||||
"module_types": ["commonjs", "esm"]
|
||||
}
|
||||
}
|
||||
-255
@@ -1,255 +0,0 @@
|
||||
# QA Validation Report
|
||||
|
||||
**Spec**: 021-document-the-scripts-directory-utilities-for-devel
|
||||
**Date**: 2026-01-25T06:45:00Z
|
||||
**QA Agent Session**: 1
|
||||
|
||||
## Summary
|
||||
|
||||
| Category | Status | Details |
|
||||
|----------|--------|---------|
|
||||
| Subtasks Complete | ✓ | 4/4 completed |
|
||||
| Unit Tests | N/A | Not required (documentation-only task) |
|
||||
| Integration Tests | N/A | Not required (documentation-only task) |
|
||||
| E2E Tests | N/A | Not required (documentation-only task) |
|
||||
| Browser Verification | N/A | Not required (documentation-only task) |
|
||||
| Project-Specific Validation | N/A | Not applicable |
|
||||
| Database Verification | N/A | Not applicable |
|
||||
| Third-Party API Validation | N/A | Not applicable (documenting existing scripts) |
|
||||
| Security Review | ✓ | Passed (see notes) |
|
||||
| Pattern Compliance | ✓ | Follows existing README patterns |
|
||||
| Regression Check | ✓ | No functional code changes |
|
||||
| Manual Verification | ✓ | All checklist items verified |
|
||||
|
||||
## Phase 0: Context Loading
|
||||
|
||||
### Files Changed
|
||||
```
|
||||
M README.md
|
||||
M package.json
|
||||
A scripts/README.md
|
||||
```
|
||||
|
||||
All expected files modified/created. No unrelated changes detected.
|
||||
|
||||
### Implementation Plan Status
|
||||
- **Total Subtasks**: 4
|
||||
- **Completed**: 4 (100%)
|
||||
- **Pending**: 0
|
||||
- **In Progress**: 0
|
||||
|
||||
## Phase 1: Subtask Verification
|
||||
|
||||
✓ **Subtask 1-1**: Create scripts/README.md with comprehensive documentation
|
||||
- File created: scripts/README.md (10,190 bytes)
|
||||
- Documents all 11 utility scripts
|
||||
- Each script has: Purpose, Usage, Requirements, Examples
|
||||
|
||||
✓ **Subtask 1-2**: Add Scripts section to main README.md
|
||||
- Section added with link to scripts/README.md
|
||||
- Lists all 6 utility categories
|
||||
- Includes quick start commands
|
||||
|
||||
✓ **Subtask 1-3**: Update package.json with npm script commands
|
||||
- Added 5 new npm aliases:
|
||||
- generate:sitemap
|
||||
- generate:icons
|
||||
- generate:github
|
||||
- download:fonts
|
||||
- convert:translations
|
||||
|
||||
✓ **Subtask 1-4**: Document missing scripts
|
||||
- Missing Scripts section added to scripts/README.md
|
||||
- Documents generate-blog-images.mjs (referenced but not implemented)
|
||||
- Provides recommendations: remove or implement
|
||||
|
||||
## Phase 2-7: Testing (Not Required)
|
||||
|
||||
**Rationale**: This is a documentation-only task with no functional code changes.
|
||||
- risk_level: "trivial"
|
||||
- skip_validation: true
|
||||
- No tests required per implementation plan
|
||||
|
||||
## Phase 8: Code Review
|
||||
|
||||
### Documentation Accuracy Verification
|
||||
|
||||
Sampled scripts to verify documentation accuracy:
|
||||
|
||||
**generate-sitemap.js**:
|
||||
- ✓ Correctly documents SITE_URL, LANGUAGES, DEFAULT_LANGUAGE
|
||||
- ✓ Accurately describes multi-language sitemap generation
|
||||
- ✓ Output files correctly listed (sitemap.xml, robots.txt)
|
||||
|
||||
**optimize-images.js**:
|
||||
- ✓ Correctly documents input directory (source-images/projects)
|
||||
- ✓ Accurately lists responsive sizes (200w, 300w, 400w, 600w, 800w, 1200w)
|
||||
- ✓ Correctly describes output formats (JPG quality 80, WebP quality 75)
|
||||
|
||||
**convert-translations.js**:
|
||||
- ✓ Correctly documents input path (src/i18n/locales/{locale}/index.ts)
|
||||
- ✓ Accurately describes output path (src/messages/{locale}.json)
|
||||
- ✓ Correctly lists locales (de, en, sr)
|
||||
|
||||
**download-fonts.mjs**:
|
||||
- ✓ Correctly documents download URL (https://rsms.me/inter/)
|
||||
- ✓ Accurately describes output path (public/fonts/inter-var.woff2)
|
||||
- ✓ ES Module implementation confirmed
|
||||
|
||||
**pagespeed-check.js**:
|
||||
- ✓ Correctly documents Google PageSpeed Insights API usage
|
||||
- ✓ Accurately describes metrics (Performance, Accessibility, Best Practices, SEO)
|
||||
- ✓ Core Web Vitals documentation accurate (FCP, LCP, TBT, CLS, Speed Index)
|
||||
|
||||
### Documentation Completeness
|
||||
|
||||
**scripts/README.md sections verified**:
|
||||
- ✓ Overview (lists 11 scripts)
|
||||
- ✓ Image Optimization (2 scripts)
|
||||
- ✓ SEO & Performance (2 scripts)
|
||||
- ✓ Internationalization (1 script)
|
||||
- ✓ Assets & Resources (2 scripts)
|
||||
- ✓ Icon Generation (2 scripts)
|
||||
- ✓ Documentation (2 scripts)
|
||||
- ✓ Dependencies section
|
||||
- ✓ NPM Scripts section
|
||||
- ✓ Best Practices section
|
||||
- ✓ Common Issues section
|
||||
- ✓ Missing Scripts section
|
||||
|
||||
**All 11 scripts documented**:
|
||||
1. ✓ optimize-images.js
|
||||
2. ✓ optimize-images.mjs
|
||||
3. ✓ generate-sitemap.js
|
||||
4. ✓ pagespeed-check.js
|
||||
5. ✓ convert-translations.js
|
||||
6. ✓ download-fonts.js
|
||||
7. ✓ download-fonts.mjs
|
||||
8. ✓ generate-icons.mjs
|
||||
9. ✓ generate-icons-simple.mjs
|
||||
10. ✓ generate-github-readme.js
|
||||
11. ✓ generate-og-image.html
|
||||
|
||||
**Each script includes**:
|
||||
- ✓ Purpose statement
|
||||
- ✓ Usage examples
|
||||
- ✓ Requirements/dependencies
|
||||
- ✓ What it does (detailed explanation)
|
||||
- ✓ Output locations
|
||||
- ✓ Configuration details (where applicable)
|
||||
|
||||
### Security Review
|
||||
|
||||
**Pre-existing Issues Noted** (not in scope for documentation task):
|
||||
- Hardcoded Google PageSpeed API key in `pagespeed-check.js` (line 12)
|
||||
- SSL verification disabled in `pagespeed-check.js` (line 10)
|
||||
|
||||
**Decision**: These security issues existed before this documentation task. The task scope is to document existing scripts, not to refactor them. The documentation accurately describes what the scripts do, including noting the API key requirement and SSL configuration.
|
||||
|
||||
**Recommendation**: Create a separate task to refactor pagespeed-check.js to use environment variables for API keys and remove SSL bypass.
|
||||
|
||||
### Pattern Compliance
|
||||
|
||||
✓ Follows existing README.md structure and formatting
|
||||
✓ Uses consistent markdown formatting
|
||||
✓ Follows package.json script naming patterns (action:target format)
|
||||
✓ Matches portfolio project documentation style
|
||||
|
||||
## Phase 9: Manual Verification Checklist
|
||||
|
||||
From implementation_plan.json qa_acceptance.manual_verification.checklist:
|
||||
|
||||
1. ✓ **All 11 existing scripts are documented in scripts/README.md**
|
||||
- Verified: All 11 scripts present and documented
|
||||
|
||||
2. ✓ **Each script has: purpose, usage, prerequisites, examples**
|
||||
- Verified: All scripts include these fields
|
||||
|
||||
3. ✓ **README.md includes Development Scripts section**
|
||||
- Verified: Section exists at correct location with link to scripts/README.md
|
||||
|
||||
4. ✓ **package.json has convenient npm aliases added**
|
||||
- Verified: 5 new aliases added (generate:sitemap, generate:icons, generate:github, download:fonts, convert:translations)
|
||||
|
||||
5. ✓ **Missing scripts are noted with recommendations**
|
||||
- Verified: generate-blog-images.mjs documented in "Missing Scripts" section with recommendations
|
||||
|
||||
## Issues Found
|
||||
|
||||
### Critical (Blocks Sign-off)
|
||||
None
|
||||
|
||||
### Major (Should Fix)
|
||||
None
|
||||
|
||||
### Minor (Nice to Fix)
|
||||
|
||||
1. **Pre-existing security issue: Hardcoded API key in pagespeed-check.js**
|
||||
- **Problem**: Google PageSpeed API key is hardcoded in the script
|
||||
- **Location**: scripts/pagespeed-check.js:12
|
||||
- **Fix**: Create separate task to refactor script to use environment variables
|
||||
- **Note**: Not blocking this documentation task as it's pre-existing
|
||||
|
||||
2. **Pre-existing security issue: SSL verification disabled in pagespeed-check.js**
|
||||
- **Problem**: SSL verification is disabled for local testing
|
||||
- **Location**: scripts/pagespeed-check.js:10
|
||||
- **Fix**: Create separate task to remove SSL bypass or make it configurable
|
||||
- **Note**: Not blocking this documentation task as it's pre-existing
|
||||
|
||||
## Regression Check
|
||||
|
||||
✓ No functional code changes
|
||||
✓ Only documentation files modified
|
||||
✓ No risk of regression
|
||||
|
||||
## Acceptance Criteria Verification
|
||||
|
||||
From implementation_plan.json verification_strategy.acceptance_criteria:
|
||||
|
||||
1. ✓ **scripts/README.md exists and documents all 11 utility scripts**
|
||||
- Verified: File exists, 11 scripts documented
|
||||
|
||||
2. ✓ **README.md links to scripts/README.md**
|
||||
- Verified: Development Scripts section includes link
|
||||
|
||||
3. ✓ **package.json includes convenient npm aliases for major utilities**
|
||||
- Verified: 5 new aliases added for sitemap, icons, github, fonts, translations
|
||||
|
||||
4. ✓ **Missing scripts are documented**
|
||||
- Verified: generate-blog-images.mjs documented with status and recommendations
|
||||
|
||||
## Recommended Next Steps
|
||||
|
||||
1. **Create follow-up task**: Refactor pagespeed-check.js security issues
|
||||
- Move API key to environment variable
|
||||
- Remove or make configurable SSL bypass
|
||||
|
||||
2. **Consider**: Implement or remove generate-blog-images.mjs
|
||||
- Currently referenced in package.json but doesn't exist
|
||||
- Follow recommendations in scripts/README.md
|
||||
|
||||
## Verdict
|
||||
|
||||
**SIGN-OFF**: ✅ **APPROVED**
|
||||
|
||||
**Reason**: All acceptance criteria met. Documentation is comprehensive, accurate, and complete.
|
||||
|
||||
**Quality Assessment**:
|
||||
- Documentation covers all 11 existing scripts
|
||||
- Each script thoroughly documented with purpose, usage, requirements, and examples
|
||||
- Main README properly linked to scripts documentation
|
||||
- Package.json enhanced with convenient npm aliases
|
||||
- Missing scripts properly documented with recommendations
|
||||
- No functional code changes, no regression risk
|
||||
- Security issues noted but are pre-existing and out of scope
|
||||
|
||||
**Next Steps**:
|
||||
- ✅ Ready for merge to master
|
||||
- Implementation is complete and meets all requirements
|
||||
- Consider creating follow-up tasks for security improvements (optional)
|
||||
|
||||
---
|
||||
|
||||
**QA Reviewed By**: QA Agent
|
||||
**Status**: APPROVED ✓
|
||||
**Timestamp**: 2026-01-25T06:45:00Z
|
||||
@@ -1,12 +0,0 @@
|
||||
# Document the scripts directory utilities for development workflows
|
||||
|
||||
## Overview
|
||||
|
||||
The scripts/ directory contains 14 utility scripts that are completely undocumented: optimize-images.js/mjs (image optimization), generate-blog-images.mjs (AI image generation with --dry-run flag), lighthouse-audit-all-locales.js (Lighthouse testing), axe-accessibility-audit.js (accessibility testing), pagespeed-check.js (PageSpeed API), generate-sitemap.js, convert-translations.js, download-fonts.js/mjs, generate-icons.mjs/generate-icons-simple.mjs, generate-github-readme.js. Package.json only documents 3 of these scripts.
|
||||
|
||||
## Rationale
|
||||
|
||||
These scripts represent significant development tooling investments that could save developers hours of work. The image generation script uses OpenAI API but this isn't obvious without reading the code. Accessibility and performance audit scripts (axe, lighthouse, pagespeed) exist but developers wouldn't know to use them. The package.json only exposes 3 scripts but 14 exist.
|
||||
|
||||
---
|
||||
*This spec was created from ideation and is pending detailed specification.*
|
||||
-2687
File diff suppressed because one or more lines are too long
-9
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"sourceType": "ideation",
|
||||
"ideationType": "documentation_gaps",
|
||||
"ideaId": "doc-004",
|
||||
"rationale": "These scripts represent significant development tooling investments that could save developers hours of work. The image generation script uses OpenAI API but this isn't obvious without reading the code. Accessibility and performance audit scripts (axe, lighthouse, pagespeed) exist but developers wouldn't know to use them. The package.json only exposes 3 scripts but 14 exist.",
|
||||
"category": "documentation",
|
||||
"priority": "medium",
|
||||
"prUrl": "https://github.com/damjan1996/Portfolio/pull/11"
|
||||
}
|
||||
@@ -11,14 +11,14 @@
|
||||
"Edit(./**)",
|
||||
"Glob(./**)",
|
||||
"Grep(./**)",
|
||||
"Read(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\021-document-the-scripts-directory-utilities-for-devel/**)",
|
||||
"Write(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\021-document-the-scripts-directory-utilities-for-devel/**)",
|
||||
"Edit(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\021-document-the-scripts-directory-utilities-for-devel/**)",
|
||||
"Glob(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\021-document-the-scripts-directory-utilities-for-devel/**)",
|
||||
"Grep(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\021-document-the-scripts-directory-utilities-for-devel/**)",
|
||||
"Read(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\021-document-the-scripts-directory-utilities-for-devel\\.auto-claude\\specs\\021-document-the-scripts-directory-utilities-for-devel/**)",
|
||||
"Write(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\021-document-the-scripts-directory-utilities-for-devel\\.auto-claude\\specs\\021-document-the-scripts-directory-utilities-for-devel/**)",
|
||||
"Edit(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\021-document-the-scripts-directory-utilities-for-devel\\.auto-claude\\specs\\021-document-the-scripts-directory-utilities-for-devel/**)",
|
||||
"Read(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\030-add-unit-tests-vitest-configured-but-no-tests-exis/**)",
|
||||
"Write(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\030-add-unit-tests-vitest-configured-but-no-tests-exis/**)",
|
||||
"Edit(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\030-add-unit-tests-vitest-configured-but-no-tests-exis/**)",
|
||||
"Glob(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\030-add-unit-tests-vitest-configured-but-no-tests-exis/**)",
|
||||
"Grep(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\030-add-unit-tests-vitest-configured-but-no-tests-exis/**)",
|
||||
"Read(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\030-add-unit-tests-vitest-configured-but-no-tests-exis\\.auto-claude\\specs\\030-add-unit-tests-vitest-configured-but-no-tests-exis/**)",
|
||||
"Write(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\030-add-unit-tests-vitest-configured-but-no-tests-exis\\.auto-claude\\specs\\030-add-unit-tests-vitest-configured-but-no-tests-exis/**)",
|
||||
"Edit(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude\\worktrees\\tasks\\030-add-unit-tests-vitest-configured-but-no-tests-exis\\.auto-claude\\specs\\030-add-unit-tests-vitest-configured-but-no-tests-exis/**)",
|
||||
"Read(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude/**)",
|
||||
"Write(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude/**)",
|
||||
"Edit(C:\\Users\\damja\\WebstormProjects\\Portfolio\\.auto-claude/**)",
|
||||
|
||||
+4
-1
@@ -81,4 +81,7 @@ supabase/.temp/
|
||||
.history/
|
||||
|
||||
# Source images (originals before optimization)
|
||||
source-images/
|
||||
source-images/
|
||||
|
||||
# Auto Claude data directory
|
||||
.auto-claude/
|
||||
|
||||
@@ -104,25 +104,6 @@ npm test
|
||||
npm run preview
|
||||
```
|
||||
|
||||
## Development Scripts
|
||||
|
||||
The project includes **11 utility scripts** for automating development tasks. See [scripts/README.md](scripts/README.md) for full documentation.
|
||||
|
||||
**Categories:**
|
||||
- **Image Optimization** - Responsive image generation with WebP support
|
||||
- **SEO & Performance** - Sitemap generation, PageSpeed testing
|
||||
- **Internationalization** - Translation file conversion (TS → JSON)
|
||||
- **Assets & Resources** - Font downloads and self-hosting
|
||||
- **Icon Generation** - PWA icon creation with placeholders
|
||||
- **Documentation** - GitHub README and OG image templates
|
||||
|
||||
**Quick Start:**
|
||||
```bash
|
||||
npm run build:images # Optimize project images
|
||||
node scripts/generate-sitemap.js # Generate sitemap
|
||||
node scripts/pagespeed-check.js # Run performance tests
|
||||
```
|
||||
|
||||
## Key Technologies Used
|
||||
|
||||
**Languages:** TypeScript, Python, MDX
|
||||
|
||||
+4
-5
@@ -10,11 +10,6 @@
|
||||
"build:images": "node scripts/optimize-images.js",
|
||||
"generate:images": "node scripts/generate-blog-images.mjs",
|
||||
"generate:images:dry": "node scripts/generate-blog-images.mjs --dry-run",
|
||||
"generate:sitemap": "node scripts/generate-sitemap.js",
|
||||
"generate:icons": "node scripts/generate-icons.mjs",
|
||||
"generate:github": "node scripts/generate-github-readme.js",
|
||||
"download:fonts": "node scripts/download-fonts.mjs",
|
||||
"convert:translations": "node scripts/convert-translations.js",
|
||||
"test": "vitest",
|
||||
"test:coverage": "vitest run --coverage"
|
||||
},
|
||||
@@ -43,13 +38,17 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@tailwindcss/forms": "^0.5.7",
|
||||
"@testing-library/jest-dom": "^6.0.0",
|
||||
"@testing-library/react": "^14.0.0",
|
||||
"@types/mdx": "^2.0.13",
|
||||
"@types/node": "^22.0.0",
|
||||
"@types/react": "^19.0.0",
|
||||
"@types/react-dom": "^19.0.0",
|
||||
"@vitest/coverage-v8": "1.6.1",
|
||||
"autoprefixer": "^10.4.18",
|
||||
"eslint": "^9.9.1",
|
||||
"eslint-config-next": "^15.1.0",
|
||||
"jsdom": "^23.2.0",
|
||||
"postcss": "^8.4.35",
|
||||
"sharp": "^0.34.3",
|
||||
"tailwindcss": "^3.4.1",
|
||||
|
||||
@@ -1,352 +0,0 @@
|
||||
# Scripts Directory
|
||||
|
||||
Utility scripts for development, build optimization, and content generation.
|
||||
|
||||
## Overview
|
||||
|
||||
This directory contains **11 utility scripts** that automate various development tasks including image optimization, sitemap generation, performance testing, translation conversion, font downloads, icon generation, and documentation creation.
|
||||
|
||||
## Scripts
|
||||
|
||||
### Image Optimization
|
||||
|
||||
#### `optimize-images.js`
|
||||
**Purpose:** Optimizes project cover images with responsive sizes and modern formats
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
node scripts/optimize-images.js
|
||||
# or
|
||||
npm run build:images
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Processes images from `source-images/projects/<project-slug>/cover.jpg`
|
||||
- Generates multiple responsive sizes: 200w, 300w, 400w, 600w, 800w, 1200w
|
||||
- Outputs both JPG (quality 80) and WebP (quality 75) formats
|
||||
- Creates optimized original at 85% quality
|
||||
- Outputs to `public/images/projects/<project-slug>/`
|
||||
|
||||
**Requirements:** `sharp`
|
||||
|
||||
---
|
||||
|
||||
#### `optimize-images.mjs`
|
||||
**Purpose:** Optimizes gallery photos with predefined naming mapping
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
node scripts/optimize-images.mjs
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Converts and renames photos from `./photos` directory
|
||||
- Resizes images to max 1200px width
|
||||
- Outputs WebP format (quality 80)
|
||||
- Maps cryptic filenames to semantic names (e.g., `thinker-dark.webp`, `studio-seated.webp`)
|
||||
- Outputs to `public/images/gallery/`
|
||||
|
||||
**Requirements:** `sharp`
|
||||
|
||||
---
|
||||
|
||||
### SEO & Performance
|
||||
|
||||
#### `generate-sitemap.js`
|
||||
**Purpose:** Generates XML sitemap with multi-language support and robots.txt
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
node scripts/generate-sitemap.js
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Generates `public/sitemap.xml` for all static pages, blog posts, and portfolio projects
|
||||
- Supports 3 languages: German (default), English, Serbian
|
||||
- Includes hreflang alternate links for SEO
|
||||
- Sets appropriate priority and changefreq values
|
||||
- Generates/updates `public/robots.txt` with sitemap references
|
||||
|
||||
**Configuration:**
|
||||
- `SITE_URL`: https://damjan-savic.com
|
||||
- `LANGUAGES`: ['de', 'en', 'sr']
|
||||
- `DEFAULT_LANGUAGE`: 'de'
|
||||
|
||||
**Output:** `public/sitemap.xml`, `public/robots.txt`
|
||||
|
||||
---
|
||||
|
||||
#### `pagespeed-check.js`
|
||||
**Purpose:** Tests website performance using Google PageSpeed Insights API
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
node scripts/pagespeed-check.js
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Runs PageSpeed tests for both mobile and desktop
|
||||
- Displays Performance, Accessibility, Best Practices, and SEO scores
|
||||
- Shows Core Web Vitals: FCP, LCP, TBT, CLS, Speed Index
|
||||
- Lists top 5 optimization opportunities with time savings
|
||||
- Identifies diagnostic issues with low scores
|
||||
- Color-coded results (green ≥90, yellow ≥50, red <50)
|
||||
|
||||
**Requirements:** Google PageSpeed API key (configured in script)
|
||||
|
||||
**Note:** Disables SSL verification for local testing (line 10)
|
||||
|
||||
---
|
||||
|
||||
### Internationalization
|
||||
|
||||
#### `convert-translations.js`
|
||||
**Purpose:** Converts TypeScript translation files to JSON format for next-intl
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
node scripts/convert-translations.js
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Reads TypeScript translations from `src/i18n/locales/<locale>/index.ts`
|
||||
- Converts all 3 locales: de, en, sr
|
||||
- Outputs formatted JSON to `src/messages/<locale>.json`
|
||||
- Preserves nested structure and formatting
|
||||
|
||||
**Output:** `src/messages/de.json`, `src/messages/en.json`, `src/messages/sr.json`
|
||||
|
||||
---
|
||||
|
||||
### Assets & Resources
|
||||
|
||||
#### `download-fonts.js` (CommonJS)
|
||||
**Purpose:** Downloads Inter variable font for self-hosting
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
node scripts/download-fonts.js
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Downloads InterVariable.woff2 from https://rsms.me/inter/
|
||||
- Saves to `public/fonts/inter-var.woff2`
|
||||
- Creates fonts directory if it doesn't exist
|
||||
- Shows progress and error handling
|
||||
|
||||
**Requirements:** Node.js with CommonJS support
|
||||
|
||||
---
|
||||
|
||||
#### `download-fonts.mjs` (ES Module)
|
||||
**Purpose:** Downloads Inter variable font for self-hosting (ES Module version)
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
node scripts/download-fonts.mjs
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Same functionality as download-fonts.js
|
||||
- ES Module syntax with `import` statements
|
||||
- Downloads InterVariable.woff2 from https://rsms.me/inter/
|
||||
- Saves to `public/fonts/inter-var.woff2`
|
||||
|
||||
**Requirements:** Node.js with ES Module support
|
||||
|
||||
---
|
||||
|
||||
### Icon Generation
|
||||
|
||||
#### `generate-icons.mjs`
|
||||
**Purpose:** Generates PWA icons from logo.svg or creates placeholders
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
node scripts/generate-icons.mjs
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Attempts to generate icons from `public/logo.svg`
|
||||
- If logo.svg doesn't exist, creates placeholder icons with "DS" text
|
||||
- Generates two sizes: 192x192 and 512x512 PNG
|
||||
- Outputs to `public/icon-192x192.png` and `public/icon-512x512.png`
|
||||
- Uses dark background (#18181b) with white text
|
||||
|
||||
**Requirements:** `sharp`
|
||||
|
||||
---
|
||||
|
||||
#### `generate-icons-simple.mjs`
|
||||
**Purpose:** Creates simple SVG placeholder icons without Sharp dependency
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
node scripts/generate-icons-simple.mjs
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Generates SVG icons (not PNG) with "DS" text
|
||||
- Creates 192x192 and 512x512 versions
|
||||
- No image processing library required
|
||||
- Outputs to `public/icon-192x192.svg` and `public/icon-512x512.svg`
|
||||
- Dark background (#18181b) with white text
|
||||
|
||||
**Note:** Outputs SVG files instead of PNG - manifest.json may need updating
|
||||
|
||||
---
|
||||
|
||||
### Documentation
|
||||
|
||||
#### `generate-github-readme.js`
|
||||
**Purpose:** Generates GitHub profile README and project README template
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
node scripts/generate-github-readme.js
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Generates comprehensive GitHub profile README with:
|
||||
- Tech stack badges (Python, JavaScript, React, TypeScript, etc.)
|
||||
- GitHub stats widgets
|
||||
- Featured projects section
|
||||
- Skills and specializations
|
||||
- Contact information
|
||||
- Creates project README template with:
|
||||
- Standard sections (Overview, Installation, Usage, etc.)
|
||||
- Tech stack badges
|
||||
- Configuration examples
|
||||
- API documentation template
|
||||
- License and author info
|
||||
|
||||
**Output:**
|
||||
- `github-profile-README.md` - For GitHub profile
|
||||
- `project-readme-template.md` - Template for new projects
|
||||
|
||||
---
|
||||
|
||||
#### `generate-og-image.html`
|
||||
**Purpose:** HTML template for creating Open Graph social media preview images
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
# Open in browser and screenshot, or use with headless browser:
|
||||
npx playwright screenshot scripts/generate-og-image.html og-image.png --viewport-size 1200,630
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Provides ready-to-screenshot HTML for OG image (1200x630px)
|
||||
- Features dark gradient background with pattern overlay
|
||||
- Displays logo, name, subtitle, and skills
|
||||
- Optimized dimensions for social media (Twitter, Facebook, LinkedIn)
|
||||
- Modern, professional design matching portfolio branding
|
||||
|
||||
**Suggested tools:**
|
||||
- Puppeteer
|
||||
- Playwright
|
||||
- Browser DevTools screenshot
|
||||
|
||||
---
|
||||
|
||||
## Dependencies
|
||||
|
||||
Scripts in this directory require the following npm packages:
|
||||
|
||||
### Required
|
||||
- `sharp` - Image processing (optimize-images, generate-icons)
|
||||
|
||||
### Built-in Node.js Modules
|
||||
- `fs` / `fs/promises` - File system operations
|
||||
- `path` - Path manipulation
|
||||
- `https` - HTTP requests
|
||||
- `url` - URL utilities
|
||||
|
||||
## NPM Scripts
|
||||
|
||||
Some scripts are aliased in `package.json` for convenience:
|
||||
|
||||
```bash
|
||||
npm run build:images # Runs optimize-images.js
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Running Scripts
|
||||
- Always run from project root: `node scripts/<script-name>`
|
||||
- Check for required dependencies before running
|
||||
- Review output messages for errors or warnings
|
||||
|
||||
### Adding New Scripts
|
||||
1. Add `.js` or `.mjs` file to `scripts/` directory
|
||||
2. Use ES Module syntax (`.mjs`) for new scripts
|
||||
3. Include usage comments at the top
|
||||
4. Add error handling and progress logging
|
||||
5. Update this README with documentation
|
||||
|
||||
### Maintenance
|
||||
- Keep scripts focused on single responsibility
|
||||
- Use descriptive filenames
|
||||
- Add npm aliases for frequently used scripts
|
||||
- Test scripts after dependency updates
|
||||
|
||||
## Common Issues
|
||||
|
||||
### Image Optimization
|
||||
**Issue:** "Source directory not found"
|
||||
**Solution:** Ensure images exist in `source-images/projects/<slug>/cover.jpg`
|
||||
|
||||
### Font Download
|
||||
**Issue:** SSL/Certificate errors
|
||||
**Solution:** Script includes `NODE_TLS_REJECT_UNAUTHORIZED='0'` for local testing
|
||||
|
||||
### Icon Generation
|
||||
**Issue:** Sharp installation fails
|
||||
**Solution:** Use `generate-icons-simple.mjs` as fallback (generates SVG instead)
|
||||
|
||||
### Sitemap Generation
|
||||
**Issue:** Missing routes in sitemap
|
||||
**Solution:** Update static page, blog post, or project arrays in `generate-sitemap.js`
|
||||
|
||||
## Missing Scripts
|
||||
|
||||
### `generate-blog-images.mjs`
|
||||
|
||||
**Status:** ❌ **MISSING** - Referenced in package.json but not implemented
|
||||
|
||||
**Package.json References:**
|
||||
```json
|
||||
"generate:images": "node scripts/generate-blog-images.mjs"
|
||||
"generate:images:dry": "node scripts/generate-blog-images.mjs --dry-run"
|
||||
```
|
||||
|
||||
**Description (from spec):**
|
||||
This script is intended to generate AI-powered images for blog posts using the OpenAI API. It should support a `--dry-run` flag for testing without actually generating images.
|
||||
|
||||
**Recommended Action:**
|
||||
Choose one of the following:
|
||||
1. **Remove references** - If AI image generation is not needed, remove the npm scripts from package.json
|
||||
2. **Implement the script** - Create the script with the following features:
|
||||
- OpenAI API integration for image generation
|
||||
- `--dry-run` flag support for testing
|
||||
- Process blog posts and generate featured images
|
||||
- Proper error handling and progress logging
|
||||
- API key management (environment variables)
|
||||
|
||||
**Impact:**
|
||||
Running `npm run generate:images` or `npm run generate:images:dry` will fail with "Cannot find module" error until this is resolved.
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- Scripts use both `.js` (CommonJS) and `.mjs` (ES Module) extensions
|
||||
- Duplicate scripts (e.g., download-fonts) exist for compatibility
|
||||
- Some scripts include development-specific configurations (API keys, SSL bypass)
|
||||
- HTML file (`generate-og-image.html`) requires manual screenshot or headless browser
|
||||
|
||||
---
|
||||
|
||||
**Total Scripts:** 11
|
||||
**Last Updated:** 2026-01
|
||||
**Maintained By:** Development Team
|
||||
@@ -0,0 +1,348 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
||||
import { renderHook, waitFor } from '@testing-library/react';
|
||||
import { useAsync } from './useAsync';
|
||||
import * as errorHandling from '../utils/errorHandling';
|
||||
|
||||
// Mock the errorHandling module
|
||||
vi.mock('../utils/errorHandling', async () => {
|
||||
const actual = await vi.importActual('../utils/errorHandling');
|
||||
return {
|
||||
...actual,
|
||||
handleError: vi.fn((error: unknown) => {
|
||||
if (error instanceof Error) {
|
||||
return error;
|
||||
}
|
||||
return new Error('Handled error');
|
||||
})
|
||||
};
|
||||
});
|
||||
|
||||
describe('useAsync', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
describe('initial state', () => {
|
||||
it('should initialize with null data, null error, and loading false', () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
expect(result.current.data).toBeNull();
|
||||
expect(result.current.error).toBeNull();
|
||||
expect(result.current.loading).toBe(false);
|
||||
});
|
||||
|
||||
it('should provide an execute function', () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
expect(result.current.execute).toBeInstanceOf(Function);
|
||||
});
|
||||
});
|
||||
|
||||
describe('loading states', () => {
|
||||
it('should set loading to true when executing', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
const asyncFn = vi.fn(() => new Promise<string>((resolve) => {
|
||||
setTimeout(() => resolve('test data'), 100);
|
||||
}));
|
||||
|
||||
result.current.execute(asyncFn);
|
||||
|
||||
// Loading should be true immediately after execute is called
|
||||
expect(result.current.loading).toBe(true);
|
||||
expect(result.current.data).toBeNull();
|
||||
expect(result.current.error).toBeNull();
|
||||
|
||||
await waitFor(() => {
|
||||
expect(result.current.loading).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
it('should set loading to false after successful execution', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
const asyncFn = vi.fn(async () => 'test data');
|
||||
|
||||
await result.current.execute(asyncFn);
|
||||
|
||||
expect(result.current.loading).toBe(false);
|
||||
expect(result.current.data).toBe('test data');
|
||||
expect(result.current.error).toBeNull();
|
||||
});
|
||||
|
||||
it('should set loading to false after failed execution', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
const error = new Error('Test error');
|
||||
const asyncFn = vi.fn(async () => {
|
||||
throw error;
|
||||
});
|
||||
|
||||
try {
|
||||
await result.current.execute(asyncFn);
|
||||
} catch (e) {
|
||||
// Expected to throw
|
||||
}
|
||||
|
||||
expect(result.current.loading).toBe(false);
|
||||
expect(result.current.data).toBeNull();
|
||||
expect(result.current.error).toBe(error);
|
||||
});
|
||||
|
||||
it('should reset data and error when starting new execution', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
// First execution with data
|
||||
await result.current.execute(async () => 'first data');
|
||||
|
||||
expect(result.current.data).toBe('first data');
|
||||
expect(result.current.error).toBeNull();
|
||||
|
||||
// Second execution that will take some time
|
||||
const slowAsyncFn = vi.fn(() => new Promise<string>((resolve) => {
|
||||
setTimeout(() => resolve('second data'), 100);
|
||||
}));
|
||||
|
||||
result.current.execute(slowAsyncFn);
|
||||
|
||||
// Immediately after calling execute, state should be reset
|
||||
expect(result.current.data).toBeNull();
|
||||
expect(result.current.error).toBeNull();
|
||||
expect(result.current.loading).toBe(true);
|
||||
|
||||
await waitFor(() => {
|
||||
expect(result.current.loading).toBe(false);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('data flow', () => {
|
||||
it('should set data on successful execution', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
const testData = 'success data';
|
||||
const asyncFn = vi.fn(async () => testData);
|
||||
|
||||
await result.current.execute(asyncFn);
|
||||
|
||||
expect(result.current.data).toBe(testData);
|
||||
expect(result.current.error).toBeNull();
|
||||
expect(result.current.loading).toBe(false);
|
||||
expect(asyncFn).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('should handle different data types', async () => {
|
||||
// Test with number
|
||||
const { result: numberResult } = renderHook(() => useAsync<number>());
|
||||
await numberResult.current.execute(async () => 42);
|
||||
expect(numberResult.current.data).toBe(42);
|
||||
|
||||
// Test with object
|
||||
const { result: objectResult } = renderHook(() => useAsync<{ id: number; name: string }>());
|
||||
const testObject = { id: 1, name: 'test' };
|
||||
await objectResult.current.execute(async () => testObject);
|
||||
expect(objectResult.current.data).toEqual(testObject);
|
||||
|
||||
// Test with array
|
||||
const { result: arrayResult } = renderHook(() => useAsync<string[]>());
|
||||
const testArray = ['a', 'b', 'c'];
|
||||
await arrayResult.current.execute(async () => testArray);
|
||||
expect(arrayResult.current.data).toEqual(testArray);
|
||||
});
|
||||
|
||||
it('should return data from execute function', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
const testData = 'returned data';
|
||||
const asyncFn = vi.fn(async () => testData);
|
||||
|
||||
const returnedData = await result.current.execute(asyncFn);
|
||||
|
||||
expect(returnedData).toBe(testData);
|
||||
});
|
||||
|
||||
it('should handle null data', async () => {
|
||||
const { result } = renderHook(() => useAsync<string | null>());
|
||||
|
||||
const asyncFn = vi.fn(async () => null);
|
||||
|
||||
await result.current.execute(asyncFn);
|
||||
|
||||
expect(result.current.data).toBeNull();
|
||||
expect(result.current.error).toBeNull();
|
||||
expect(result.current.loading).toBe(false);
|
||||
});
|
||||
|
||||
it('should replace previous data with new data', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
await result.current.execute(async () => 'first');
|
||||
expect(result.current.data).toBe('first');
|
||||
|
||||
await result.current.execute(async () => 'second');
|
||||
expect(result.current.data).toBe('second');
|
||||
|
||||
await result.current.execute(async () => 'third');
|
||||
expect(result.current.data).toBe('third');
|
||||
});
|
||||
});
|
||||
|
||||
describe('error handling', () => {
|
||||
it('should set error on failed execution', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
const error = new Error('Test error');
|
||||
const asyncFn = vi.fn(async () => {
|
||||
throw error;
|
||||
});
|
||||
|
||||
try {
|
||||
await result.current.execute(asyncFn);
|
||||
} catch (e) {
|
||||
// Expected to throw
|
||||
}
|
||||
|
||||
expect(result.current.data).toBeNull();
|
||||
expect(result.current.error).toBe(error);
|
||||
expect(result.current.loading).toBe(false);
|
||||
});
|
||||
|
||||
it('should call handleError with error and context', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
const error = new Error('Test error');
|
||||
const asyncFn = vi.fn(async () => {
|
||||
throw error;
|
||||
});
|
||||
|
||||
try {
|
||||
await result.current.execute(asyncFn);
|
||||
} catch (e) {
|
||||
// Expected to throw
|
||||
}
|
||||
|
||||
expect(errorHandling.handleError).toHaveBeenCalledWith(error, 'Async Operation');
|
||||
});
|
||||
|
||||
it('should re-throw the handled error', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
const originalError = new Error('Test error');
|
||||
const asyncFn = vi.fn(async () => {
|
||||
throw originalError;
|
||||
});
|
||||
|
||||
await expect(result.current.execute(asyncFn)).rejects.toThrow();
|
||||
});
|
||||
|
||||
it('should handle errors of different types', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
// Test with Error object
|
||||
const error1 = new Error('Error object');
|
||||
await expect(result.current.execute(async () => {
|
||||
throw error1;
|
||||
})).rejects.toThrow();
|
||||
|
||||
// Test with string error
|
||||
await expect(result.current.execute(async () => {
|
||||
throw 'String error';
|
||||
})).rejects.toThrow();
|
||||
|
||||
// Test with number error
|
||||
await expect(result.current.execute(async () => {
|
||||
throw 404;
|
||||
})).rejects.toThrow();
|
||||
});
|
||||
|
||||
it('should clear error on successful subsequent execution', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
// First execution fails
|
||||
try {
|
||||
await result.current.execute(async () => {
|
||||
throw new Error('First error');
|
||||
});
|
||||
} catch (e) {
|
||||
// Expected to throw
|
||||
}
|
||||
|
||||
expect(result.current.error).not.toBeNull();
|
||||
|
||||
// Second execution succeeds
|
||||
await result.current.execute(async () => 'success');
|
||||
|
||||
expect(result.current.error).toBeNull();
|
||||
expect(result.current.data).toBe('success');
|
||||
});
|
||||
|
||||
it('should replace previous error with new error', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
const error1 = new Error('First error');
|
||||
const error2 = new Error('Second error');
|
||||
|
||||
// First execution fails
|
||||
try {
|
||||
await result.current.execute(async () => {
|
||||
throw error1;
|
||||
});
|
||||
} catch (e) {
|
||||
// Expected to throw
|
||||
}
|
||||
|
||||
expect(result.current.error).toBe(error1);
|
||||
|
||||
// Second execution also fails
|
||||
try {
|
||||
await result.current.execute(async () => {
|
||||
throw error2;
|
||||
});
|
||||
} catch (e) {
|
||||
// Expected to throw
|
||||
}
|
||||
|
||||
expect(result.current.error).toBe(error2);
|
||||
});
|
||||
});
|
||||
|
||||
describe('execute function stability', () => {
|
||||
it('should maintain the same execute function reference', () => {
|
||||
const { result, rerender } = renderHook(() => useAsync<string>());
|
||||
|
||||
const firstExecute = result.current.execute;
|
||||
rerender();
|
||||
const secondExecute = result.current.execute;
|
||||
|
||||
expect(firstExecute).toBe(secondExecute);
|
||||
});
|
||||
});
|
||||
|
||||
describe('concurrent executions', () => {
|
||||
it('should handle multiple concurrent executions', async () => {
|
||||
const { result } = renderHook(() => useAsync<string>());
|
||||
|
||||
const slowAsyncFn = vi.fn(() => new Promise<string>((resolve) => {
|
||||
setTimeout(() => resolve('slow result'), 100);
|
||||
}));
|
||||
|
||||
const fastAsyncFn = vi.fn(() => new Promise<string>((resolve) => {
|
||||
setTimeout(() => resolve('fast result'), 10);
|
||||
}));
|
||||
|
||||
// Start slow execution
|
||||
const slowPromise = result.current.execute(slowAsyncFn);
|
||||
|
||||
// Start fast execution (will reset state)
|
||||
const fastPromise = result.current.execute(fastAsyncFn);
|
||||
|
||||
// Fast one should complete
|
||||
await fastPromise;
|
||||
expect(result.current.data).toBe('fast result');
|
||||
|
||||
// Slow one should also complete, but will override the fast result
|
||||
await slowPromise;
|
||||
// Note: In the current implementation, the last executed function will set the final state
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,463 @@
|
||||
import { describe, it, expect, beforeEach, vi } from 'vitest';
|
||||
import { getAllBlogPosts, getBlogPostBySlug, getBlogPostSlugs, type BlogPost } from './blog';
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
|
||||
// Mock fs and path modules
|
||||
vi.mock('fs');
|
||||
vi.mock('path');
|
||||
|
||||
describe('blog', () => {
|
||||
const mockBlogPostsDir = '/mock/blog-posts';
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
|
||||
// Mock path.join to return predictable paths
|
||||
vi.mocked(path.join).mockImplementation((...args) => args.join('/'));
|
||||
|
||||
// Mock process.cwd
|
||||
vi.stubGlobal('process', {
|
||||
...process,
|
||||
cwd: () => '/mock'
|
||||
});
|
||||
});
|
||||
|
||||
describe('getAllBlogPosts', () => {
|
||||
it('should return empty array when directory does not exist', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(false);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts).toEqual([]);
|
||||
expect(fs.existsSync).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should return empty array when directory is empty', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([]);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts).toEqual([]);
|
||||
});
|
||||
|
||||
it('should parse and return blog posts from markdown files', () => {
|
||||
const mockContent = `# Test Blog Post
|
||||
|
||||
**Meta-Description:** This is a test blog post about testing.
|
||||
|
||||
**Keywords:** testing, vitest, typescript
|
||||
|
||||
## Einführung
|
||||
|
||||
This is the introduction to the blog post. It provides an overview of what will be covered.
|
||||
|
||||
## Main Content
|
||||
|
||||
Here is the main content of the blog post.`;
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-test-blog-post.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts).toHaveLength(1);
|
||||
expect(posts[0]).toMatchObject({
|
||||
slug: 'test-blog-post',
|
||||
title: 'Test Blog Post',
|
||||
excerpt: 'This is a test blog post about testing.',
|
||||
tags: ['testing', 'vitest', 'typescript'],
|
||||
category: 'Web Development'
|
||||
});
|
||||
expect(posts[0].date).toBe('2026-01-19');
|
||||
expect(posts[0].coverImage).toBe('/images/posts/test-blog-post/cover.jpg');
|
||||
expect(posts[0].content).toBe(mockContent);
|
||||
});
|
||||
|
||||
it('should sort posts by date descending (newest first)', () => {
|
||||
const mockContent1 = '# Post 1\n\n**Meta-Description:** First post';
|
||||
const mockContent2 = '# Post 2\n\n**Meta-Description:** Second post';
|
||||
const mockContent3 = '# Post 3\n\n**Meta-Description:** Third post';
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([
|
||||
'001-first-post.md',
|
||||
'002-second-post.md',
|
||||
'003-third-post.md'
|
||||
] as any);
|
||||
|
||||
vi.mocked(fs.readFileSync)
|
||||
.mockReturnValueOnce(mockContent1)
|
||||
.mockReturnValueOnce(mockContent2)
|
||||
.mockReturnValueOnce(mockContent3);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts).toHaveLength(3);
|
||||
// Posts should be sorted newest first (higher numbers = older posts)
|
||||
expect(posts[0].slug).toBe('first-post');
|
||||
expect(posts[1].slug).toBe('second-post');
|
||||
expect(posts[2].slug).toBe('third-post');
|
||||
expect(new Date(posts[0].date).getTime()).toBeGreaterThanOrEqual(new Date(posts[1].date).getTime());
|
||||
expect(new Date(posts[1].date).getTime()).toBeGreaterThanOrEqual(new Date(posts[2].date).getTime());
|
||||
});
|
||||
|
||||
it('should filter out non-markdown files', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([
|
||||
'001-test-post.md',
|
||||
'README.txt',
|
||||
'image.png',
|
||||
'002-another-post.md',
|
||||
'config.json'
|
||||
] as any);
|
||||
|
||||
const mockContent = '# Test\n\n**Meta-Description:** Test';
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts).toHaveLength(2);
|
||||
expect(fs.readFileSync).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it('should detect category from filename - AI Agents', () => {
|
||||
const mockContent = '# AI Agent Post\n\n**Meta-Description:** About AI agents';
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-agentic-workflow.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts[0].category).toBe('KI-Agenten');
|
||||
});
|
||||
|
||||
it('should detect category from filename - Voice AI', () => {
|
||||
const mockContent = '# Voice AI Post\n\n**Meta-Description:** About voice technology';
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-vapi-integration.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts[0].category).toBe('Voice AI');
|
||||
});
|
||||
|
||||
it('should detect category from content when not in filename', () => {
|
||||
const mockContent = `# My Post
|
||||
|
||||
**Meta-Description:** A post about automation
|
||||
|
||||
I love using n8n for automation workflows.`;
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-my-post.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts[0].category).toBe('Automatisierung');
|
||||
});
|
||||
|
||||
it('should use default category when no keywords match', () => {
|
||||
const mockContent = '# Generic Post\n\n**Meta-Description:** Generic content';
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-generic-post.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts[0].category).toBe('Technologie');
|
||||
});
|
||||
|
||||
it('should extract tags from keywords field', () => {
|
||||
const mockContent = `# Test Post
|
||||
|
||||
**Meta-Description:** Test description
|
||||
|
||||
**Keywords:** javascript, typescript, testing, vitest, unit-tests, integration-tests, extra-tag`;
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-test.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
// Should limit to 6 tags
|
||||
expect(posts[0].tags).toHaveLength(6);
|
||||
expect(posts[0].tags).toEqual([
|
||||
'javascript',
|
||||
'typescript',
|
||||
'testing',
|
||||
'vitest',
|
||||
'unit-tests',
|
||||
'integration-tests'
|
||||
]);
|
||||
});
|
||||
|
||||
it('should handle posts without keywords', () => {
|
||||
const mockContent = '# Test Post\n\n**Meta-Description:** Test';
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-test.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts[0].tags).toEqual([]);
|
||||
});
|
||||
|
||||
it('should use introduction as excerpt when meta description is missing', () => {
|
||||
const mockContent = `# Test Post
|
||||
|
||||
## Einführung
|
||||
|
||||
This is a very long introduction that should be truncated to 200 characters. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.
|
||||
|
||||
## Main Content`;
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-test.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts[0].excerpt).toHaveLength(203); // 200 chars + '...'
|
||||
expect(posts[0].excerpt).toContain('This is a very long introduction');
|
||||
expect(posts[0].excerpt).toMatch(/\.\.\.$/);
|
||||
});
|
||||
|
||||
it('should use title as excerpt when both meta description and introduction are missing', () => {
|
||||
const mockContent = '# Test Post Title\n\nSome content';
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-test.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts[0].excerpt).toBe('Test Post Title');
|
||||
});
|
||||
|
||||
it('should handle posts without H1 title', () => {
|
||||
const mockContent = 'No title here\n\n**Meta-Description:** Test';
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-fallback-title.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts[0].title).toBe('001-fallback-title');
|
||||
});
|
||||
|
||||
it('should skip posts that fail to parse', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([
|
||||
'001-good-post.md',
|
||||
'002-bad-post.md'
|
||||
] as any);
|
||||
|
||||
vi.mocked(fs.readFileSync)
|
||||
.mockReturnValueOnce('# Good Post\n\n**Meta-Description:** Good')
|
||||
.mockImplementationOnce(() => {
|
||||
throw new Error('File read error');
|
||||
});
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts).toHaveLength(1);
|
||||
expect(posts[0].title).toBe('Good Post');
|
||||
});
|
||||
|
||||
it('should generate correct dates based on post numbers', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([
|
||||
'001-first.md',
|
||||
'005-fifth.md',
|
||||
'010-tenth.md'
|
||||
] as any);
|
||||
|
||||
const mockContent = '# Post\n\n**Meta-Description:** Test';
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
// Post 001 should be 2026-01-19
|
||||
expect(posts.find(p => p.slug === 'first')?.date).toBe('2026-01-19');
|
||||
|
||||
// Post 005 should be 4 days earlier (2026-01-15)
|
||||
expect(posts.find(p => p.slug === 'fifth')?.date).toBe('2026-01-15');
|
||||
|
||||
// Post 010 should be 9 days earlier (2026-01-10)
|
||||
expect(posts.find(p => p.slug === 'tenth')?.date).toBe('2026-01-10');
|
||||
});
|
||||
|
||||
it('should trim whitespace from extracted fields', () => {
|
||||
const mockContent = `# Test Post With Spaces
|
||||
|
||||
**Meta-Description:** Description with spaces
|
||||
|
||||
**Keywords:** tag1 , tag2 , tag3 `;
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-test.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const posts = getAllBlogPosts();
|
||||
|
||||
expect(posts[0].title).toBe('Test Post With Spaces');
|
||||
expect(posts[0].excerpt).toBe('Description with spaces');
|
||||
expect(posts[0].tags).toEqual(['tag1', 'tag2', 'tag3']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getBlogPostBySlug', () => {
|
||||
it('should return post when slug matches', () => {
|
||||
const mockContent = '# Test Post\n\n**Meta-Description:** Test';
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-test-post.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const post = getBlogPostBySlug('test-post');
|
||||
|
||||
expect(post).not.toBeNull();
|
||||
expect(post?.slug).toBe('test-post');
|
||||
expect(post?.title).toBe('Test Post');
|
||||
});
|
||||
|
||||
it('should return null when slug does not match', () => {
|
||||
const mockContent = '# Test Post\n\n**Meta-Description:** Test';
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-test-post.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const post = getBlogPostBySlug('non-existent-slug');
|
||||
|
||||
expect(post).toBeNull();
|
||||
});
|
||||
|
||||
it('should return null when no posts exist', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([]);
|
||||
|
||||
const post = getBlogPostBySlug('any-slug');
|
||||
|
||||
expect(post).toBeNull();
|
||||
});
|
||||
|
||||
it('should return null when directory does not exist', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(false);
|
||||
|
||||
const post = getBlogPostBySlug('any-slug');
|
||||
|
||||
expect(post).toBeNull();
|
||||
});
|
||||
|
||||
it('should return correct post when multiple posts exist', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([
|
||||
'001-first-post.md',
|
||||
'002-second-post.md',
|
||||
'003-third-post.md'
|
||||
] as any);
|
||||
|
||||
vi.mocked(fs.readFileSync)
|
||||
.mockReturnValueOnce('# First Post\n\n**Meta-Description:** First')
|
||||
.mockReturnValueOnce('# Second Post\n\n**Meta-Description:** Second')
|
||||
.mockReturnValueOnce('# Third Post\n\n**Meta-Description:** Third');
|
||||
|
||||
const post = getBlogPostBySlug('second-post');
|
||||
|
||||
expect(post).not.toBeNull();
|
||||
expect(post?.slug).toBe('second-post');
|
||||
expect(post?.title).toBe('Second Post');
|
||||
expect(post?.excerpt).toBe('Second');
|
||||
});
|
||||
|
||||
it('should return post with all content included', () => {
|
||||
const mockContent = `# Full Post
|
||||
|
||||
**Meta-Description:** Description
|
||||
|
||||
**Keywords:** tag1, tag2
|
||||
|
||||
## Einführung
|
||||
|
||||
Introduction text
|
||||
|
||||
## Main Content
|
||||
|
||||
This is the main content of the post with lots of details.`;
|
||||
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue(['001-full-post.md'] as any);
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const post = getBlogPostBySlug('full-post');
|
||||
|
||||
expect(post?.content).toBe(mockContent);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getBlogPostSlugs', () => {
|
||||
it('should return all post slugs', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([
|
||||
'001-first-post.md',
|
||||
'002-second-post.md',
|
||||
'003-third-post.md'
|
||||
] as any);
|
||||
|
||||
const mockContent = '# Post\n\n**Meta-Description:** Test';
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const slugs = getBlogPostSlugs();
|
||||
|
||||
expect(slugs).toHaveLength(3);
|
||||
expect(slugs).toContain('first-post');
|
||||
expect(slugs).toContain('second-post');
|
||||
expect(slugs).toContain('third-post');
|
||||
});
|
||||
|
||||
it('should return empty array when no posts exist', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([]);
|
||||
|
||||
const slugs = getBlogPostSlugs();
|
||||
|
||||
expect(slugs).toEqual([]);
|
||||
});
|
||||
|
||||
it('should return empty array when directory does not exist', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(false);
|
||||
|
||||
const slugs = getBlogPostSlugs();
|
||||
|
||||
expect(slugs).toEqual([]);
|
||||
});
|
||||
|
||||
it('should return slugs in date order (newest first)', () => {
|
||||
vi.mocked(fs.existsSync).mockReturnValue(true);
|
||||
vi.mocked(fs.readdirSync).mockReturnValue([
|
||||
'003-third.md',
|
||||
'001-first.md',
|
||||
'002-second.md'
|
||||
] as any);
|
||||
|
||||
const mockContent = '# Post\n\n**Meta-Description:** Test';
|
||||
vi.mocked(fs.readFileSync).mockReturnValue(mockContent);
|
||||
|
||||
const slugs = getBlogPostSlugs();
|
||||
|
||||
expect(slugs).toEqual(['first', 'second', 'third']);
|
||||
});
|
||||
});
|
||||
});
|
||||
+11
-5
@@ -142,11 +142,17 @@ export function getAllBlogPosts(): BlogPost[] {
|
||||
const posts: BlogPost[] = [];
|
||||
|
||||
for (const file of files) {
|
||||
const filePath = path.join(BLOG_POSTS_DIR, file);
|
||||
const content = fs.readFileSync(filePath, 'utf-8');
|
||||
const post = parseMarkdownPost(file, content);
|
||||
if (post) {
|
||||
posts.push(post);
|
||||
try {
|
||||
const filePath = path.join(BLOG_POSTS_DIR, file);
|
||||
const content = fs.readFileSync(filePath, 'utf-8');
|
||||
const post = parseMarkdownPost(file, content);
|
||||
if (post) {
|
||||
posts.push(post);
|
||||
}
|
||||
} catch (error) {
|
||||
// Skip files that fail to parse
|
||||
console.warn(`Failed to parse blog post: ${file}`, error);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,282 @@
|
||||
import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest';
|
||||
import { cache } from './cache';
|
||||
|
||||
describe('Cache', () => {
|
||||
beforeEach(() => {
|
||||
vi.useFakeTimers();
|
||||
cache.clear(); // Clear cache before each test
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
cache.clear(); // Clean up after each test
|
||||
});
|
||||
|
||||
describe('set and get', () => {
|
||||
it('should set and retrieve a value', () => {
|
||||
cache.set('key', 'value');
|
||||
expect(cache.get('key')).toBe('value');
|
||||
});
|
||||
|
||||
it('should set multiple values with different keys', () => {
|
||||
cache.set('key1', 'value1');
|
||||
cache.set('key2', 'value2');
|
||||
cache.set('key3', 'value3');
|
||||
|
||||
expect(cache.get('key1')).toBe('value1');
|
||||
expect(cache.get('key2')).toBe('value2');
|
||||
expect(cache.get('key3')).toBe('value3');
|
||||
});
|
||||
|
||||
it('should overwrite existing value for same key', () => {
|
||||
cache.set('key', 'value1');
|
||||
expect(cache.get('key')).toBe('value1');
|
||||
|
||||
cache.set('key', 'value2');
|
||||
expect(cache.get('key')).toBe('value2');
|
||||
});
|
||||
|
||||
it('should return null for non-existing key', () => {
|
||||
expect(cache.get('nonexistent')).toBeNull();
|
||||
});
|
||||
|
||||
it('should store different types of values', () => {
|
||||
cache.set('string', 'text');
|
||||
cache.set('number', 42);
|
||||
cache.set('boolean', true);
|
||||
cache.set('object', { name: 'test' });
|
||||
cache.set('array', [1, 2, 3]);
|
||||
cache.set('null', null);
|
||||
|
||||
expect(cache.get('string')).toBe('text');
|
||||
expect(cache.get('number')).toBe(42);
|
||||
expect(cache.get('boolean')).toBe(true);
|
||||
expect(cache.get('object')).toEqual({ name: 'test' });
|
||||
expect(cache.get('array')).toEqual([1, 2, 3]);
|
||||
expect(cache.get('null')).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe('TTL expiration', () => {
|
||||
it('should use default TTL of 5 minutes', () => {
|
||||
cache.set('test', 'value');
|
||||
|
||||
// Should be available before TTL expires
|
||||
expect(cache.get('test')).toBe('value');
|
||||
|
||||
// Advance time by 4 minutes 59 seconds
|
||||
vi.advanceTimersByTime(4 * 60 * 1000 + 59 * 1000);
|
||||
expect(cache.get('test')).toBe('value');
|
||||
|
||||
// Advance time by 2 more seconds (total 5 minutes 1 second)
|
||||
vi.advanceTimersByTime(2 * 1000);
|
||||
expect(cache.get('test')).toBeNull();
|
||||
});
|
||||
|
||||
it('should accept custom TTL per item', () => {
|
||||
cache.set('short', 'value', 1000); // 1 second TTL
|
||||
cache.set('long', 'value', 10000); // 10 seconds TTL
|
||||
|
||||
// Both should be available initially
|
||||
expect(cache.get('short')).toBe('value');
|
||||
expect(cache.get('long')).toBe('value');
|
||||
|
||||
// After 1.5 seconds, short should expire but long should remain
|
||||
vi.advanceTimersByTime(1500);
|
||||
expect(cache.get('short')).toBeNull();
|
||||
expect(cache.get('long')).toBe('value');
|
||||
|
||||
// After 9 more seconds (total 10.5), long should expire
|
||||
vi.advanceTimersByTime(9000);
|
||||
expect(cache.get('long')).toBeNull();
|
||||
});
|
||||
|
||||
it('should return null for expired item', () => {
|
||||
cache.set('key', 'value', 1000);
|
||||
|
||||
// Should be available initially
|
||||
expect(cache.get('key')).toBe('value');
|
||||
|
||||
// Should be null after expiration
|
||||
vi.advanceTimersByTime(1001);
|
||||
expect(cache.get('key')).toBeNull();
|
||||
});
|
||||
|
||||
it('should delete expired item from storage', () => {
|
||||
cache.set('key', 'value', 1000);
|
||||
|
||||
// Item should exist
|
||||
expect(cache.get('key')).toBe('value');
|
||||
|
||||
// After expiration, get should delete it
|
||||
vi.advanceTimersByTime(1001);
|
||||
expect(cache.get('key')).toBeNull();
|
||||
|
||||
// Subsequent get should also return null (item was deleted)
|
||||
expect(cache.get('key')).toBeNull();
|
||||
});
|
||||
|
||||
it('should return value at exact TTL boundary', () => {
|
||||
cache.set('key', 'value', 1000);
|
||||
|
||||
// At exactly TTL time, should still be valid
|
||||
vi.advanceTimersByTime(1000);
|
||||
expect(cache.get('key')).toBe('value');
|
||||
|
||||
// One millisecond later, should expire
|
||||
vi.advanceTimersByTime(1);
|
||||
expect(cache.get('key')).toBeNull();
|
||||
});
|
||||
|
||||
it('should respect different TTLs for different items', () => {
|
||||
cache.set('item1', 'value1', 1000);
|
||||
cache.set('item2', 'value2', 2000);
|
||||
cache.set('item3', 'value3', 3000);
|
||||
|
||||
// All items should be available initially
|
||||
expect(cache.get('item1')).toBe('value1');
|
||||
expect(cache.get('item2')).toBe('value2');
|
||||
expect(cache.get('item3')).toBe('value3');
|
||||
|
||||
// After 1.5 seconds, item1 should expire
|
||||
vi.advanceTimersByTime(1500);
|
||||
expect(cache.get('item1')).toBeNull();
|
||||
expect(cache.get('item2')).toBe('value2');
|
||||
expect(cache.get('item3')).toBe('value3');
|
||||
|
||||
// After 1 more second (total 2.5), item2 should expire
|
||||
vi.advanceTimersByTime(1000);
|
||||
expect(cache.get('item1')).toBeNull();
|
||||
expect(cache.get('item2')).toBeNull();
|
||||
expect(cache.get('item3')).toBe('value3');
|
||||
|
||||
// After 1 more second (total 3.5), item3 should expire
|
||||
vi.advanceTimersByTime(1000);
|
||||
expect(cache.get('item1')).toBeNull();
|
||||
expect(cache.get('item2')).toBeNull();
|
||||
expect(cache.get('item3')).toBeNull();
|
||||
});
|
||||
|
||||
it('should reset TTL when item is overwritten', () => {
|
||||
cache.set('key', 'value1', 1000);
|
||||
|
||||
// Advance time by 500ms
|
||||
vi.advanceTimersByTime(500);
|
||||
|
||||
// Overwrite with new value and new TTL
|
||||
cache.set('key', 'value2', 2000);
|
||||
|
||||
// After 1500ms more (total 2000ms from first set), should still be available
|
||||
// because TTL was reset
|
||||
vi.advanceTimersByTime(1500);
|
||||
expect(cache.get('key')).toBe('value2');
|
||||
|
||||
// After 600ms more (2100ms from second set), should expire
|
||||
vi.advanceTimersByTime(600);
|
||||
expect(cache.get('key')).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle zero TTL', () => {
|
||||
cache.set('key', 'value', 0);
|
||||
|
||||
// Should expire immediately
|
||||
vi.advanceTimersByTime(1);
|
||||
expect(cache.get('key')).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle very long TTL', () => {
|
||||
const oneDayInMs = 24 * 60 * 60 * 1000;
|
||||
cache.set('key', 'value', oneDayInMs);
|
||||
|
||||
// Should be available after 23 hours
|
||||
vi.advanceTimersByTime(23 * 60 * 60 * 1000);
|
||||
expect(cache.get('key')).toBe('value');
|
||||
|
||||
// Should still be available at exactly 24 hours
|
||||
vi.advanceTimersByTime(60 * 60 * 1000);
|
||||
expect(cache.get('key')).toBe('value');
|
||||
|
||||
// Should expire after 24 hours + 1ms
|
||||
vi.advanceTimersByTime(1);
|
||||
expect(cache.get('key')).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe('has', () => {
|
||||
it('should return true for existing key', () => {
|
||||
cache.set('key', 'value');
|
||||
expect(cache.has('key')).toBe(true);
|
||||
});
|
||||
|
||||
it('should return false for non-existing key', () => {
|
||||
expect(cache.has('nonexistent')).toBe(false);
|
||||
});
|
||||
|
||||
it('should return false for expired key', () => {
|
||||
cache.set('key', 'value', 1000);
|
||||
|
||||
expect(cache.has('key')).toBe(true);
|
||||
|
||||
vi.advanceTimersByTime(1001);
|
||||
expect(cache.has('key')).toBe(false);
|
||||
});
|
||||
|
||||
it('should return false for null values', () => {
|
||||
cache.set('key', null);
|
||||
expect(cache.has('key')).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('delete', () => {
|
||||
it('should delete existing key', () => {
|
||||
cache.set('key', 'value');
|
||||
expect(cache.get('key')).toBe('value');
|
||||
|
||||
cache.delete('key');
|
||||
expect(cache.get('key')).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle deleting non-existing key', () => {
|
||||
expect(() => cache.delete('nonexistent')).not.toThrow();
|
||||
expect(cache.get('nonexistent')).toBeNull();
|
||||
});
|
||||
|
||||
it('should only delete specified key', () => {
|
||||
cache.set('key1', 'value1');
|
||||
cache.set('key2', 'value2');
|
||||
cache.set('key3', 'value3');
|
||||
|
||||
cache.delete('key2');
|
||||
|
||||
expect(cache.get('key1')).toBe('value1');
|
||||
expect(cache.get('key2')).toBeNull();
|
||||
expect(cache.get('key3')).toBe('value3');
|
||||
});
|
||||
});
|
||||
|
||||
describe('clear', () => {
|
||||
it('should clear all items from cache', () => {
|
||||
cache.set('key1', 'value1');
|
||||
cache.set('key2', 'value2');
|
||||
cache.set('key3', 'value3');
|
||||
|
||||
cache.clear();
|
||||
|
||||
expect(cache.get('key1')).toBeNull();
|
||||
expect(cache.get('key2')).toBeNull();
|
||||
expect(cache.get('key3')).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle clearing empty cache', () => {
|
||||
expect(() => cache.clear()).not.toThrow();
|
||||
});
|
||||
|
||||
it('should allow setting items after clear', () => {
|
||||
cache.set('key', 'value1');
|
||||
cache.clear();
|
||||
cache.set('key', 'value2');
|
||||
|
||||
expect(cache.get('key')).toBe('value2');
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,165 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
||||
import { AppError, errorCodes, handleError, createAPIError } from './errorHandling';
|
||||
import * as analytics from './analytics';
|
||||
|
||||
// Mock the analytics module
|
||||
vi.mock('./analytics', () => ({
|
||||
trackEvent: vi.fn()
|
||||
}));
|
||||
|
||||
describe('errorHandling', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
describe('AppError', () => {
|
||||
it('should create an AppError with all properties', () => {
|
||||
const error = new AppError('Test error', 'TEST_CODE', 'error', { key: 'value' });
|
||||
|
||||
expect(error).toBeInstanceOf(Error);
|
||||
expect(error).toBeInstanceOf(AppError);
|
||||
expect(error.message).toBe('Test error');
|
||||
expect(error.code).toBe('TEST_CODE');
|
||||
expect(error.severity).toBe('error');
|
||||
expect(error.metadata).toEqual({ key: 'value' });
|
||||
expect(error.name).toBe('AppError');
|
||||
});
|
||||
|
||||
it('should create an AppError with default severity', () => {
|
||||
const error = new AppError('Test error', 'TEST_CODE');
|
||||
|
||||
expect(error.severity).toBe('error');
|
||||
expect(error.metadata).toBeUndefined();
|
||||
});
|
||||
|
||||
it('should create an AppError with warning severity', () => {
|
||||
const error = new AppError('Test warning', 'TEST_CODE', 'warning');
|
||||
|
||||
expect(error.severity).toBe('warning');
|
||||
});
|
||||
|
||||
it('should create an AppError with info severity', () => {
|
||||
const error = new AppError('Test info', 'TEST_CODE', 'info');
|
||||
|
||||
expect(error.severity).toBe('info');
|
||||
});
|
||||
});
|
||||
|
||||
describe('errorCodes', () => {
|
||||
it('should have all error codes defined', () => {
|
||||
expect(errorCodes.NETWORK_ERROR).toBe('ERR_NETWORK');
|
||||
expect(errorCodes.API_ERROR).toBe('ERR_API');
|
||||
expect(errorCodes.AUTH_ERROR).toBe('ERR_AUTH');
|
||||
expect(errorCodes.VALIDATION_ERROR).toBe('ERR_VALIDATION');
|
||||
expect(errorCodes.UNKNOWN_ERROR).toBe('ERR_UNKNOWN');
|
||||
});
|
||||
});
|
||||
|
||||
describe('handleError', () => {
|
||||
it('should handle AppError and return it unchanged', () => {
|
||||
const originalError = new AppError('Test error', 'TEST_CODE', 'error', { foo: 'bar' });
|
||||
const result = handleError(originalError, 'test-context');
|
||||
|
||||
expect(result).toBe(originalError);
|
||||
expect(result.message).toBe('Test error');
|
||||
expect(result.code).toBe('TEST_CODE');
|
||||
expect(result.severity).toBe('error');
|
||||
expect(result.metadata).toEqual({ foo: 'bar' });
|
||||
expect(analytics.trackEvent).toHaveBeenCalledWith(
|
||||
'Error',
|
||||
'TEST_CODE',
|
||||
'test-context: Test error'
|
||||
);
|
||||
});
|
||||
|
||||
it('should convert regular Error to AppError', () => {
|
||||
const originalError = new Error('Regular error');
|
||||
const result = handleError(originalError, 'test-context');
|
||||
|
||||
expect(result).toBeInstanceOf(AppError);
|
||||
expect(result.message).toBe('Regular error');
|
||||
expect(result.code).toBe(errorCodes.UNKNOWN_ERROR);
|
||||
expect(result.severity).toBe('error');
|
||||
expect(result.metadata).toEqual({ originalError });
|
||||
expect(analytics.trackEvent).toHaveBeenCalledWith(
|
||||
'Error',
|
||||
errorCodes.UNKNOWN_ERROR,
|
||||
'test-context: Regular error'
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle unknown error types', () => {
|
||||
const result = handleError('string error', 'test-context');
|
||||
|
||||
expect(result).toBeInstanceOf(AppError);
|
||||
expect(result.message).toBe('An unexpected error occurred');
|
||||
expect(result.code).toBe(errorCodes.UNKNOWN_ERROR);
|
||||
expect(result.severity).toBe('error');
|
||||
expect(result.metadata).toEqual({ originalError: 'string error' });
|
||||
expect(analytics.trackEvent).toHaveBeenCalledWith(
|
||||
'Error',
|
||||
errorCodes.UNKNOWN_ERROR,
|
||||
'test-context: An unexpected error occurred'
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle null error', () => {
|
||||
const result = handleError(null, 'test-context');
|
||||
|
||||
expect(result).toBeInstanceOf(AppError);
|
||||
expect(result.message).toBe('An unexpected error occurred');
|
||||
expect(result.code).toBe(errorCodes.UNKNOWN_ERROR);
|
||||
expect(result.metadata).toEqual({ originalError: null });
|
||||
});
|
||||
|
||||
it('should handle undefined error', () => {
|
||||
const result = handleError(undefined, 'test-context');
|
||||
|
||||
expect(result).toBeInstanceOf(AppError);
|
||||
expect(result.message).toBe('An unexpected error occurred');
|
||||
expect(result.code).toBe(errorCodes.UNKNOWN_ERROR);
|
||||
expect(result.metadata).toEqual({ originalError: undefined });
|
||||
});
|
||||
|
||||
it('should track error in analytics', () => {
|
||||
const error = new AppError('Analytics test', 'ANALYTICS_CODE');
|
||||
handleError(error, 'analytics-context');
|
||||
|
||||
expect(analytics.trackEvent).toHaveBeenCalledTimes(1);
|
||||
expect(analytics.trackEvent).toHaveBeenCalledWith(
|
||||
'Error',
|
||||
'ANALYTICS_CODE',
|
||||
'analytics-context: Analytics test'
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('createAPIError', () => {
|
||||
it('should create an API error with status code', () => {
|
||||
const error = createAPIError(404, 'Not found');
|
||||
|
||||
expect(error).toBeInstanceOf(AppError);
|
||||
expect(error.message).toBe('Not found');
|
||||
expect(error.code).toBe(errorCodes.API_ERROR);
|
||||
expect(error.severity).toBe('error');
|
||||
expect(error.metadata).toEqual({ status: 404 });
|
||||
});
|
||||
|
||||
it('should create an API error for 500 status', () => {
|
||||
const error = createAPIError(500, 'Internal server error');
|
||||
|
||||
expect(error).toBeInstanceOf(AppError);
|
||||
expect(error.message).toBe('Internal server error');
|
||||
expect(error.code).toBe(errorCodes.API_ERROR);
|
||||
expect(error.metadata).toEqual({ status: 500 });
|
||||
});
|
||||
|
||||
it('should create an API error for 401 status', () => {
|
||||
const error = createAPIError(401, 'Unauthorized');
|
||||
|
||||
expect(error).toBeInstanceOf(AppError);
|
||||
expect(error.message).toBe('Unauthorized');
|
||||
expect(error.metadata).toEqual({ status: 401 });
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -34,7 +34,6 @@
|
||||
"src/pages-vite",
|
||||
"src/hooks",
|
||||
"src/services",
|
||||
"src/utils",
|
||||
"**/*.bak"
|
||||
]
|
||||
}
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
import { defineConfig } from 'vitest/config';
|
||||
import { resolve } from 'path';
|
||||
|
||||
export default defineConfig({
|
||||
plugins: [],
|
||||
test: {
|
||||
globals: true,
|
||||
environment: 'jsdom',
|
||||
setupFiles: [],
|
||||
include: ['**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
|
||||
exclude: [
|
||||
'**/node_modules/**',
|
||||
'**/dist/**',
|
||||
'**/.next/**',
|
||||
'**/coverage/**',
|
||||
'**/*.bak/**',
|
||||
'**/src/components-vite/**',
|
||||
'**/src/pages-vite/**'
|
||||
],
|
||||
coverage: {
|
||||
provider: 'v8',
|
||||
reporter: ['text', 'json', 'html'],
|
||||
exclude: [
|
||||
'node_modules/',
|
||||
'.next/',
|
||||
'coverage/',
|
||||
'**/*.config.{js,ts}',
|
||||
'**/*.bak',
|
||||
'src/components-vite/**',
|
||||
'src/pages-vite/**'
|
||||
]
|
||||
}
|
||||
},
|
||||
resolve: {
|
||||
alias: {
|
||||
'@': resolve(__dirname, './src')
|
||||
}
|
||||
}
|
||||
});
|
||||
Reference in New Issue
Block a user