@sk8metal/michi-cli 0.0.9 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/README.md +236 -57
- package/dist/scripts/__tests__/create-project.test.js +24 -28
- package/dist/scripts/__tests__/create-project.test.js.map +1 -1
- package/dist/scripts/__tests__/jira-transitions.test.d.ts +5 -0
- package/dist/scripts/__tests__/jira-transitions.test.d.ts.map +1 -0
- package/dist/scripts/__tests__/jira-transitions.test.js +172 -0
- package/dist/scripts/__tests__/jira-transitions.test.js.map +1 -0
- package/dist/scripts/__tests__/multi-project-estimate.test.js +14 -15
- package/dist/scripts/__tests__/multi-project-estimate.test.js.map +1 -1
- package/dist/scripts/__tests__/setup-existing-project.test.js +79 -0
- package/dist/scripts/__tests__/setup-existing-project.test.js.map +1 -1
- package/dist/scripts/__tests__/setup-interactive.test.js +23 -17
- package/dist/scripts/__tests__/setup-interactive.test.js.map +1 -1
- package/dist/scripts/__tests__/spec-impl-workflow.test.d.ts +5 -0
- package/dist/scripts/__tests__/spec-impl-workflow.test.d.ts.map +1 -0
- package/dist/scripts/__tests__/spec-impl-workflow.test.js +321 -0
- package/dist/scripts/__tests__/spec-impl-workflow.test.js.map +1 -0
- package/dist/scripts/__tests__/spec-loader.test.d.ts +5 -0
- package/dist/scripts/__tests__/spec-loader.test.d.ts.map +1 -0
- package/dist/scripts/__tests__/spec-loader.test.js +153 -0
- package/dist/scripts/__tests__/spec-loader.test.js.map +1 -0
- package/dist/scripts/__tests__/validate-phase.test.js +109 -22
- package/dist/scripts/__tests__/validate-phase.test.js.map +1 -1
- package/dist/scripts/config/config-schema.d.ts +31 -0
- package/dist/scripts/config/config-schema.d.ts.map +1 -1
- package/dist/scripts/config/config-schema.js +64 -26
- package/dist/scripts/config/config-schema.js.map +1 -1
- package/dist/scripts/config-interactive.d.ts.map +1 -1
- package/dist/scripts/config-interactive.js +53 -38
- package/dist/scripts/config-interactive.js.map +1 -1
- package/dist/scripts/confluence-sync.d.ts.map +1 -1
- package/dist/scripts/confluence-sync.js +0 -11
- package/dist/scripts/confluence-sync.js.map +1 -1
- package/dist/scripts/constants/__tests__/environments.test.js +39 -5
- package/dist/scripts/constants/__tests__/environments.test.js.map +1 -1
- package/dist/scripts/constants/environments.d.ts +1 -1
- package/dist/scripts/constants/environments.d.ts.map +1 -1
- package/dist/scripts/constants/environments.js +22 -7
- package/dist/scripts/constants/environments.js.map +1 -1
- package/dist/scripts/constants/test-commands.d.ts +36 -0
- package/dist/scripts/constants/test-commands.d.ts.map +1 -0
- package/dist/scripts/constants/test-commands.js +70 -0
- package/dist/scripts/constants/test-commands.js.map +1 -0
- package/dist/scripts/jira-sync.d.ts +89 -3
- package/dist/scripts/jira-sync.d.ts.map +1 -1
- package/dist/scripts/jira-sync.js +366 -96
- package/dist/scripts/jira-sync.js.map +1 -1
- package/dist/scripts/markdown-to-confluence.js +1 -1
- package/dist/scripts/markdown-to-confluence.js.map +1 -1
- package/dist/scripts/phase-runner.d.ts +1 -1
- package/dist/scripts/phase-runner.d.ts.map +1 -1
- package/dist/scripts/phase-runner.js +809 -13
- package/dist/scripts/phase-runner.js.map +1 -1
- package/dist/scripts/pr-automation.d.ts.map +1 -1
- package/dist/scripts/pr-automation.js.map +1 -1
- package/dist/scripts/pre-flight-check.js +1 -1
- package/dist/scripts/pre-flight-check.js.map +1 -1
- package/dist/scripts/setup-existing-project.js +61 -29
- package/dist/scripts/setup-existing-project.js.map +1 -1
- package/dist/scripts/setup-interactive.js +3 -3
- package/dist/scripts/setup-interactive.js.map +1 -1
- package/dist/scripts/spec-impl-workflow.d.ts +94 -0
- package/dist/scripts/spec-impl-workflow.d.ts.map +1 -0
- package/dist/scripts/spec-impl-workflow.js +354 -0
- package/dist/scripts/spec-impl-workflow.js.map +1 -0
- package/dist/scripts/template/__tests__/renderer.test.js.map +1 -1
- package/dist/scripts/test-execution-generator.d.ts +52 -0
- package/dist/scripts/test-execution-generator.d.ts.map +1 -0
- package/dist/scripts/test-execution-generator.js +576 -0
- package/dist/scripts/test-execution-generator.js.map +1 -0
- package/dist/scripts/test-interactive.d.ts +10 -0
- package/dist/scripts/test-interactive.d.ts.map +1 -0
- package/dist/scripts/test-interactive.js +627 -0
- package/dist/scripts/test-interactive.js.map +1 -0
- package/dist/scripts/test-new-features.d.ts +5 -0
- package/dist/scripts/test-new-features.d.ts.map +1 -0
- package/dist/scripts/test-new-features.js +145 -0
- package/dist/scripts/test-new-features.js.map +1 -0
- package/dist/scripts/test-spec-generator.d.ts +29 -0
- package/dist/scripts/test-spec-generator.d.ts.map +1 -0
- package/dist/scripts/test-spec-generator.js +494 -0
- package/dist/scripts/test-spec-generator.js.map +1 -0
- package/dist/scripts/test-workflow-stages.d.ts +6 -0
- package/dist/scripts/test-workflow-stages.d.ts.map +1 -0
- package/dist/scripts/test-workflow-stages.js +43 -0
- package/dist/scripts/test-workflow-stages.js.map +1 -0
- package/dist/scripts/utils/__tests__/aidlc-parser.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/aidlc-parser.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/aidlc-parser.test.js +315 -0
- package/dist/scripts/utils/__tests__/aidlc-parser.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/business-days.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/business-days.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/business-days.test.js +171 -0
- package/dist/scripts/utils/__tests__/business-days.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/config-loader.test.js +1 -1
- package/dist/scripts/utils/__tests__/config-loader.test.js.map +1 -1
- package/dist/scripts/utils/__tests__/config-validator.test.js +164 -35
- package/dist/scripts/utils/__tests__/config-validator.test.js.map +1 -1
- package/dist/scripts/utils/__tests__/env-config.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/env-config.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/env-config.test.js +218 -0
- package/dist/scripts/utils/__tests__/env-config.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.js +202 -0
- package/dist/scripts/utils/__tests__/jira-issue-type-fetcher.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/tasks-converter.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/tasks-converter.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/tasks-converter.test.js +500 -0
- package/dist/scripts/utils/__tests__/tasks-converter.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.js +314 -0
- package/dist/scripts/utils/__tests__/tasks-format-validator.test.js.map +1 -0
- package/dist/scripts/utils/__tests__/test-runner.test.d.ts +5 -0
- package/dist/scripts/utils/__tests__/test-runner.test.d.ts.map +1 -0
- package/dist/scripts/utils/__tests__/test-runner.test.js +64 -0
- package/dist/scripts/utils/__tests__/test-runner.test.js.map +1 -0
- package/dist/scripts/utils/aidlc-parser.d.ts +86 -0
- package/dist/scripts/utils/aidlc-parser.d.ts.map +1 -0
- package/dist/scripts/utils/aidlc-parser.js +208 -0
- package/dist/scripts/utils/aidlc-parser.js.map +1 -0
- package/dist/scripts/utils/business-days.d.ts +52 -0
- package/dist/scripts/utils/business-days.d.ts.map +1 -0
- package/dist/scripts/utils/business-days.js +98 -0
- package/dist/scripts/utils/business-days.js.map +1 -0
- package/dist/scripts/utils/ci-generator.d.ts +14 -0
- package/dist/scripts/utils/ci-generator.d.ts.map +1 -0
- package/dist/scripts/utils/ci-generator.js +61 -0
- package/dist/scripts/utils/ci-generator.js.map +1 -0
- package/dist/scripts/utils/config-loader.js +2 -2
- package/dist/scripts/utils/config-loader.js.map +1 -1
- package/dist/scripts/utils/config-validator.d.ts +7 -1
- package/dist/scripts/utils/config-validator.d.ts.map +1 -1
- package/dist/scripts/utils/config-validator.js +136 -23
- package/dist/scripts/utils/config-validator.js.map +1 -1
- package/dist/scripts/utils/confluence-approval.d.ts +46 -0
- package/dist/scripts/utils/confluence-approval.d.ts.map +1 -0
- package/dist/scripts/utils/confluence-approval.js +118 -0
- package/dist/scripts/utils/confluence-approval.js.map +1 -0
- package/dist/scripts/utils/confluence-hierarchy.d.ts.map +1 -1
- package/dist/scripts/utils/confluence-hierarchy.js +1 -1
- package/dist/scripts/utils/confluence-hierarchy.js.map +1 -1
- package/dist/scripts/utils/docker-generator.d.ts +9 -0
- package/dist/scripts/utils/docker-generator.d.ts.map +1 -0
- package/dist/scripts/utils/docker-generator.js +132 -0
- package/dist/scripts/utils/docker-generator.js.map +1 -0
- package/dist/scripts/utils/docker-requirement-detector.d.ts +15 -0
- package/dist/scripts/utils/docker-requirement-detector.d.ts.map +1 -0
- package/dist/scripts/utils/docker-requirement-detector.js +124 -0
- package/dist/scripts/utils/docker-requirement-detector.js.map +1 -0
- package/dist/scripts/utils/env-config.d.ts +54 -0
- package/dist/scripts/utils/env-config.d.ts.map +1 -0
- package/dist/scripts/utils/env-config.js +414 -0
- package/dist/scripts/utils/env-config.js.map +1 -0
- package/dist/scripts/utils/jira-issue-type-fetcher.d.ts +70 -0
- package/dist/scripts/utils/jira-issue-type-fetcher.d.ts.map +1 -0
- package/dist/scripts/utils/jira-issue-type-fetcher.js +147 -0
- package/dist/scripts/utils/jira-issue-type-fetcher.js.map +1 -0
- package/dist/scripts/utils/language-detector.d.ts +14 -0
- package/dist/scripts/utils/language-detector.d.ts.map +1 -0
- package/dist/scripts/utils/language-detector.js +119 -0
- package/dist/scripts/utils/language-detector.js.map +1 -0
- package/dist/scripts/utils/markdown-parser.d.ts +55 -0
- package/dist/scripts/utils/markdown-parser.d.ts.map +1 -0
- package/dist/scripts/utils/markdown-parser.js +289 -0
- package/dist/scripts/utils/markdown-parser.js.map +1 -0
- package/dist/scripts/utils/project-detector.d.ts +17 -0
- package/dist/scripts/utils/project-detector.d.ts.map +1 -0
- package/dist/scripts/utils/project-detector.js +166 -0
- package/dist/scripts/utils/project-detector.js.map +1 -0
- package/dist/scripts/utils/project-finder.js +2 -2
- package/dist/scripts/utils/project-finder.js.map +1 -1
- package/dist/scripts/utils/release-notes-generator.d.ts +56 -0
- package/dist/scripts/utils/release-notes-generator.d.ts.map +1 -0
- package/dist/scripts/utils/release-notes-generator.js +162 -0
- package/dist/scripts/utils/release-notes-generator.js.map +1 -0
- package/dist/scripts/utils/spec-loader.d.ts +79 -0
- package/dist/scripts/utils/spec-loader.d.ts.map +1 -0
- package/dist/scripts/utils/spec-loader.js +80 -0
- package/dist/scripts/utils/spec-loader.js.map +1 -0
- package/dist/scripts/utils/spec-updater.d.ts +7 -0
- package/dist/scripts/utils/spec-updater.d.ts.map +1 -1
- package/dist/scripts/utils/spec-updater.js.map +1 -1
- package/dist/scripts/utils/tasks-converter.d.ts +57 -0
- package/dist/scripts/utils/tasks-converter.d.ts.map +1 -0
- package/dist/scripts/utils/tasks-converter.js +322 -0
- package/dist/scripts/utils/tasks-converter.js.map +1 -0
- package/dist/scripts/utils/tasks-format-validator.d.ts +36 -0
- package/dist/scripts/utils/tasks-format-validator.d.ts.map +1 -0
- package/dist/scripts/utils/tasks-format-validator.js +158 -0
- package/dist/scripts/utils/tasks-format-validator.js.map +1 -0
- package/dist/scripts/utils/template-applier.d.ts +37 -0
- package/dist/scripts/utils/template-applier.d.ts.map +1 -0
- package/dist/scripts/utils/template-applier.js +129 -0
- package/dist/scripts/utils/template-applier.js.map +1 -0
- package/dist/scripts/utils/test-config-generator.d.ts +12 -0
- package/dist/scripts/utils/test-config-generator.d.ts.map +1 -0
- package/dist/scripts/utils/test-config-generator.js +185 -0
- package/dist/scripts/utils/test-config-generator.js.map +1 -0
- package/dist/scripts/utils/test-runner.d.ts +31 -0
- package/dist/scripts/utils/test-runner.d.ts.map +1 -0
- package/dist/scripts/utils/test-runner.js +103 -0
- package/dist/scripts/utils/test-runner.js.map +1 -0
- package/dist/scripts/validate-phase.d.ts +1 -1
- package/dist/scripts/validate-phase.d.ts.map +1 -1
- package/dist/scripts/validate-phase.js +171 -8
- package/dist/scripts/validate-phase.js.map +1 -1
- package/dist/scripts/workflow-orchestrator.d.ts +8 -0
- package/dist/scripts/workflow-orchestrator.d.ts.map +1 -1
- package/dist/scripts/workflow-orchestrator.js +108 -7
- package/dist/scripts/workflow-orchestrator.js.map +1 -1
- package/dist/src/__tests__/integration/internationalization.test.d.ts +8 -0
- package/dist/src/__tests__/integration/internationalization.test.d.ts.map +1 -0
- package/dist/src/__tests__/integration/internationalization.test.js +333 -0
- package/dist/src/__tests__/integration/internationalization.test.js.map +1 -0
- package/dist/src/__tests__/integration/setup/claude-agent.test.d.ts +1 -1
- package/dist/src/__tests__/integration/setup/claude-agent.test.js +17 -20
- package/dist/src/__tests__/integration/setup/claude-agent.test.js.map +1 -1
- package/dist/src/__tests__/integration/setup/claude.test.js +82 -0
- package/dist/src/__tests__/integration/setup/claude.test.js.map +1 -1
- package/dist/src/__tests__/integration/setup/cursor.test.js +23 -19
- package/dist/src/__tests__/integration/setup/cursor.test.js.map +1 -1
- package/dist/src/__tests__/integration/setup/validation.test.js +41 -58
- package/dist/src/__tests__/integration/setup/validation.test.js.map +1 -1
- package/dist/src/cli.d.ts.map +1 -1
- package/dist/src/cli.js +209 -18
- package/dist/src/cli.js.map +1 -1
- package/dist/src/commands/setup-existing.d.ts +4 -0
- package/dist/src/commands/setup-existing.d.ts.map +1 -1
- package/dist/src/commands/setup-existing.js +367 -47
- package/dist/src/commands/setup-existing.js.map +1 -1
- package/docs/README.md +3 -1
- package/docs/context.md +59 -0
- package/docs/design-issue-55.md +240 -0
- package/docs/design-issue-56.md +181 -0
- package/docs/michi-development/testing/manual-verification-flow.md +2242 -0
- package/docs/michi-development/testing/pre-publish-checklist.md +560 -0
- package/docs/plan.md +275 -0
- package/docs/user-guide/getting-started/github-token-setup.md +509 -0
- package/docs/{getting-started → user-guide/getting-started}/quick-start.md +16 -0
- package/docs/{getting-started → user-guide/getting-started}/setup.md +28 -1
- package/docs/user-guide/guides/agent-skills-integration.md +217 -0
- package/docs/{guides → user-guide/guides}/customization.md +2 -2
- package/docs/user-guide/guides/internationalization.md +540 -0
- package/docs/{guides → user-guide/guides}/multi-project.md +3 -3
- package/docs/{guides → user-guide/guides}/phase-automation.md +92 -34
- package/docs/user-guide/guides/workflow.md +570 -0
- package/docs/user-guide/hands-on/README.md +142 -0
- package/docs/user-guide/hands-on/claude-agent-setup.md +455 -0
- package/docs/user-guide/hands-on/claude-setup.md +398 -0
- package/docs/user-guide/hands-on/cursor-setup.md +352 -0
- package/docs/user-guide/hands-on/troubleshooting.md +964 -0
- package/docs/user-guide/hands-on/verification-checklist.md +438 -0
- package/docs/user-guide/hands-on/workflow-walkthrough.md +906 -0
- package/docs/user-guide/reference/config.md +564 -0
- package/docs/{reference → user-guide/reference}/quick-reference.md +53 -40
- package/docs/{reference → user-guide/reference}/tasks-template.md +2 -2
- package/docs/user-guide/release/ci-setup.md +541 -0
- package/docs/user-guide/release/release-flow.md +476 -0
- package/docs/user-guide/templates/test-specs/README.md +173 -0
- package/docs/user-guide/templates/test-specs/e2e-test-spec-template.md +547 -0
- package/docs/user-guide/templates/test-specs/integration-test-spec-template.md +435 -0
- package/docs/user-guide/templates/test-specs/performance-test-spec-template.md +454 -0
- package/docs/user-guide/templates/test-specs/security-test-spec-template.md +664 -0
- package/docs/user-guide/templates/test-specs/unit-test-spec-template.md +328 -0
- package/docs/{testing → user-guide/testing}/integration-tests.md +24 -9
- package/docs/user-guide/testing/tdd-cycle.md +349 -0
- package/docs/user-guide/testing/test-execution-flow.md +396 -0
- package/docs/user-guide/testing/test-failure-handling.md +521 -0
- package/docs/user-guide/testing/test-planning-flow.md +181 -0
- package/docs/user-guide/testing-strategy.md +185 -0
- package/docs/verification-guide.md +518 -0
- package/package.json +7 -2
- package/scripts/__tests__/create-project.test.ts +67 -49
- package/scripts/__tests__/jira-transitions.test.ts +225 -0
- package/scripts/__tests__/multi-project-estimate.test.ts +36 -30
- package/scripts/__tests__/setup-existing-project.test.ts +98 -1
- package/scripts/__tests__/setup-interactive.test.ts +52 -46
- package/scripts/__tests__/spec-impl-workflow.test.ts +429 -0
- package/scripts/__tests__/spec-loader.test.ts +199 -0
- package/scripts/__tests__/validate-phase.test.ts +178 -54
- package/scripts/config/config-schema.ts +100 -50
- package/scripts/config-interactive.ts +191 -136
- package/scripts/confluence-sync.ts +0 -12
- package/scripts/constants/__tests__/environments.test.ts +42 -6
- package/scripts/constants/environments.ts +33 -13
- package/scripts/constants/test-commands.ts +96 -0
- package/scripts/jira-sync.ts +767 -232
- package/scripts/markdown-to-confluence.ts +1 -1
- package/scripts/phase-runner.ts +1056 -63
- package/scripts/pr-automation.ts +0 -1
- package/scripts/pre-flight-check.ts +1 -1
- package/scripts/pre-publish-check.sh +311 -0
- package/scripts/quick-verify.sh +115 -0
- package/scripts/setup-existing-project.ts +201 -117
- package/scripts/setup-interactive.ts +4 -4
- package/scripts/spec-impl-workflow.ts +505 -0
- package/scripts/template/__tests__/renderer.test.ts +1 -2
- package/scripts/test-execution-generator.ts +695 -0
- package/scripts/test-interactive.ts +779 -0
- package/scripts/test-new-features.ts +168 -0
- package/scripts/test-npm-package.sh +345 -0
- package/scripts/test-spec-generator.ts +574 -0
- package/scripts/test-workflow-stages.ts +53 -0
- package/scripts/utils/__tests__/aidlc-parser.test.ts +349 -0
- package/scripts/utils/__tests__/business-days.test.ts +214 -0
- package/scripts/utils/__tests__/config-loader.test.ts +1 -1
- package/scripts/utils/__tests__/config-validator.test.ts +309 -88
- package/scripts/utils/__tests__/env-config.test.ts +259 -0
- package/scripts/utils/__tests__/jira-issue-type-fetcher.test.ts +272 -0
- package/scripts/utils/__tests__/tasks-converter.test.ts +582 -0
- package/scripts/utils/__tests__/tasks-format-validator.test.ts +338 -0
- package/scripts/utils/__tests__/test-runner.test.ts +77 -0
- package/scripts/utils/aidlc-parser.ts +289 -0
- package/scripts/utils/business-days.ts +115 -0
- package/scripts/utils/ci-generator.ts +84 -0
- package/scripts/utils/config-loader.ts +2 -2
- package/scripts/utils/config-validator.ts +304 -117
- package/scripts/utils/confluence-approval.ts +167 -0
- package/scripts/utils/confluence-hierarchy.ts +2 -4
- package/scripts/utils/docker-generator.ts +151 -0
- package/scripts/utils/docker-requirement-detector.ts +153 -0
- package/scripts/utils/env-config.ts +526 -0
- package/scripts/utils/jira-issue-type-fetcher.ts +199 -0
- package/scripts/utils/language-detector.ts +139 -0
- package/scripts/utils/markdown-parser.ts +376 -0
- package/scripts/utils/project-detector.ts +192 -0
- package/scripts/utils/project-finder.ts +2 -2
- package/scripts/utils/release-notes-generator.ts +210 -0
- package/scripts/utils/spec-loader.ts +125 -0
- package/scripts/utils/spec-updater.ts +8 -1
- package/scripts/utils/tasks-converter.ts +601 -0
- package/scripts/utils/tasks-format-validator.ts +193 -0
- package/scripts/utils/template-applier.ts +202 -0
- package/scripts/utils/test-config-generator.ts +210 -0
- package/scripts/utils/test-runner.ts +133 -0
- package/scripts/validate-phase.ts +207 -12
- package/scripts/workflow-orchestrator.ts +130 -12
- package/templates/ci/github-actions/java.yml +54 -0
- package/templates/ci/github-actions/nodejs.yml +46 -0
- package/templates/ci/github-actions/php.yml +52 -0
- package/templates/ci/screwdriver/java.yaml +17 -0
- package/templates/ci/screwdriver/nodejs.yaml +17 -0
- package/templates/ci/screwdriver/php.yaml +20 -0
- package/templates/claude/agents/design-reviewer/AGENT.md +497 -0
- package/templates/claude/agents/e2e-first-planner/AGENT.md +410 -0
- package/templates/claude/agents/oss-license-checker/AGENT.md +265 -0
- package/templates/claude/agents/pr-resolver/AGENT.md +196 -0
- package/templates/claude/agents/stable-version-auditor/AGENT.md +279 -0
- package/templates/claude/commands/kiro/kiro-spec-impl.md +253 -0
- package/templates/claude/commands/kiro/kiro-spec-tasks.md +368 -0
- package/templates/claude/commands/michi/design-review.md +66 -0
- package/templates/claude/commands/michi/e2e-plan.md +113 -0
- package/templates/claude/commands/michi/license-check.md +80 -0
- package/templates/claude/commands/michi/pr-resolve.md +153 -0
- package/templates/claude/commands/michi/version-audit.md +91 -0
- package/templates/claude/skills/design-review/SKILL.md +648 -0
- package/templates/claude/skills/e2e-first-planning/SKILL.md +360 -0
- package/templates/claude/skills/oss-license/SKILL.md +232 -0
- package/templates/claude/skills/stable-version/SKILL.md +252 -0
- package/templates/claude-agent/README.md +7 -1
- package/templates/claude-agent/agents/.gitkeep +0 -0
- package/templates/claude-agent/agents/designer.md +79 -0
- package/templates/claude-agent/agents/developer.md +68 -0
- package/templates/claude-agent/agents/manager-agent.md +59 -0
- package/templates/claude-agent/agents/tester.md +101 -0
- package/templates/claude-agent/commands/kiro/.gitkeep +0 -0
- package/templates/claude-agent/commands/kiro/kiro-spec-impl.md +244 -0
- package/templates/claude-agent/commands/kiro/kiro-spec-tasks.md +354 -0
- package/templates/cline/rules/atlassian-integration.md +36 -0
- package/templates/cline/rules/michi-core.md +56 -0
- package/templates/codex/AGENTS.override.md +277 -0
- package/templates/codex/prompts/confluence-sync.md +177 -0
- package/templates/codex/rules/README.md +210 -0
- package/templates/common/.kiro/project.json.template +21 -0
- package/templates/cursor/commands/kiro/kiro-spec-impl.md +244 -0
- package/templates/cursor/commands/kiro/kiro-spec-tasks.md +354 -0
- package/templates/gemini/commands/README.md +41 -0
- package/templates/gemini/rules/GEMINI.md +80 -0
- package/docs/guides/workflow.md +0 -342
- package/docs/reference/config.md +0 -545
- package/scripts/setup-existing.sh +0 -279
- /package/docs/{contributing → michi-development/contributing}/development.md +0 -0
- /package/docs/{contributing → michi-development/contributing}/release.md +0 -0
- /package/docs/{testing-strategy.md → michi-development/testing-strategy.md} +0 -0
- /package/docs/{getting-started → user-guide/getting-started}/new-repository-setup.md +0 -0
|
@@ -0,0 +1,648 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: design-review
|
|
3
|
+
description: |
|
|
4
|
+
UIデザインレビューガイド。
|
|
5
|
+
アクセシビリティ、レスポンシブ、UXパターン、パフォーマンスをチェック。
|
|
6
|
+
allowed-tools: Read, Grep, Glob
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# デザインレビュースキル
|
|
10
|
+
|
|
11
|
+
## 目的
|
|
12
|
+
|
|
13
|
+
UIデザインの品質を評価し、アクセシビリティ、レスポンシブデザイン、UXパターン、パフォーマンスの観点から改善提案を行う。
|
|
14
|
+
|
|
15
|
+
## レビューの4つの観点
|
|
16
|
+
|
|
17
|
+
### 1. アクセシビリティ(A11y)
|
|
18
|
+
### 2. レスポンシブデザイン
|
|
19
|
+
### 3. UXパターン
|
|
20
|
+
### 4. パフォーマンス
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 1. アクセシビリティ(WCAG 2.1 AA準拠)
|
|
25
|
+
|
|
26
|
+
### 重要な原則
|
|
27
|
+
|
|
28
|
+
#### POUR原則
|
|
29
|
+
|
|
30
|
+
| 原則 | 説明 |
|
|
31
|
+
|------|------|
|
|
32
|
+
| **P**erceivable(知覚可能) | すべてのユーザーが情報を知覚できる |
|
|
33
|
+
| **O**perable(操作可能) | すべてのユーザーがUIを操作できる |
|
|
34
|
+
| **U**nderstandable(理解可能) | 情報とUIが理解可能 |
|
|
35
|
+
| **R**obust(堅牢) | 多様な技術で解釈可能 |
|
|
36
|
+
|
|
37
|
+
### チェックリスト
|
|
38
|
+
|
|
39
|
+
#### 1.1 テキストの代替
|
|
40
|
+
|
|
41
|
+
```html
|
|
42
|
+
<!-- ❌ 悪い例 -->
|
|
43
|
+
<img src="logo.png">
|
|
44
|
+
<button><i class="icon-save"></i></button>
|
|
45
|
+
|
|
46
|
+
<!-- ✅ 良い例 -->
|
|
47
|
+
<img src="logo.png" alt="Company Logo">
|
|
48
|
+
<button aria-label="保存"><i class="icon-save" aria-hidden="true"></i></button>
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
#### 1.2 コントラスト比
|
|
52
|
+
|
|
53
|
+
**WCAG 2.1 AA基準:**
|
|
54
|
+
- 通常テキスト: 4.5:1 以上
|
|
55
|
+
- 大きなテキスト(18pt以上 or 14pt太字以上): 3:1 以上
|
|
56
|
+
|
|
57
|
+
**確認ツール:**
|
|
58
|
+
- [WebAIM Contrast Checker](https://webaim.org/resources/contrastchecker/)
|
|
59
|
+
- Chrome DevTools: Lighthouse
|
|
60
|
+
|
|
61
|
+
```css
|
|
62
|
+
/* ❌ 悪い例: コントラスト比 2.5:1 */
|
|
63
|
+
.text {
|
|
64
|
+
color: #999;
|
|
65
|
+
background: #fff;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/* ✅ 良い例: コントラスト比 7:1 */
|
|
69
|
+
.text {
|
|
70
|
+
color: #555;
|
|
71
|
+
background: #fff;
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
#### 1.3 キーボード操作
|
|
76
|
+
|
|
77
|
+
```html
|
|
78
|
+
<!-- ❌ 悪い例: キーボード操作不可 -->
|
|
79
|
+
<div onclick="submit()">送信</div>
|
|
80
|
+
|
|
81
|
+
<!-- ✅ 良い例 -->
|
|
82
|
+
<button type="submit">送信</button>
|
|
83
|
+
|
|
84
|
+
<!-- ✅ カスタム要素の場合 -->
|
|
85
|
+
<div role="button" tabindex="0" onclick="submit()" onkeydown="handleKey(event)">
|
|
86
|
+
送信
|
|
87
|
+
</div>
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
**チェック項目:**
|
|
91
|
+
- [ ] すべての操作がキーボードで可能か
|
|
92
|
+
- [ ] Tab順序が論理的か
|
|
93
|
+
- [ ] フォーカスインジケーターが視認可能か
|
|
94
|
+
- [ ] Escキーでモーダルが閉じるか
|
|
95
|
+
|
|
96
|
+
#### 1.4 フォーカスの可視化
|
|
97
|
+
|
|
98
|
+
```css
|
|
99
|
+
/* ❌ 悪い例: フォーカスを消す */
|
|
100
|
+
button:focus {
|
|
101
|
+
outline: none;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/* ✅ 良い例 */
|
|
105
|
+
button:focus {
|
|
106
|
+
outline: 2px solid #0066cc;
|
|
107
|
+
outline-offset: 2px;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/* ✅ より良い例 */
|
|
111
|
+
button:focus-visible {
|
|
112
|
+
outline: 2px solid #0066cc;
|
|
113
|
+
outline-offset: 2px;
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
#### 1.5 セマンティックHTML
|
|
118
|
+
|
|
119
|
+
```html
|
|
120
|
+
<!-- ❌ 悪い例 -->
|
|
121
|
+
<div class="header">
|
|
122
|
+
<div class="nav">
|
|
123
|
+
<div class="link">Home</div>
|
|
124
|
+
<div class="link">About</div>
|
|
125
|
+
</div>
|
|
126
|
+
</div>
|
|
127
|
+
|
|
128
|
+
<!-- ✅ 良い例 -->
|
|
129
|
+
<header>
|
|
130
|
+
<nav>
|
|
131
|
+
<ul>
|
|
132
|
+
<li><a href="/">Home</a></li>
|
|
133
|
+
<li><a href="/about">About</a></li>
|
|
134
|
+
</ul>
|
|
135
|
+
</nav>
|
|
136
|
+
</header>
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
#### 1.6 ARIAの適切な使用
|
|
140
|
+
|
|
141
|
+
```html
|
|
142
|
+
<!-- ❌ 悪い例: 不要なARIA -->
|
|
143
|
+
<button role="button">送信</button>
|
|
144
|
+
|
|
145
|
+
<!-- ✅ 良い例: 必要最小限 -->
|
|
146
|
+
<button>送信</button>
|
|
147
|
+
|
|
148
|
+
<!-- ✅ 良い例: カスタムコンポーネントで必要 -->
|
|
149
|
+
<div role="dialog" aria-labelledby="dialog-title" aria-modal="true">
|
|
150
|
+
<h2 id="dialog-title">確認</h2>
|
|
151
|
+
<p>本当に削除しますか?</p>
|
|
152
|
+
<button>削除</button>
|
|
153
|
+
<button>キャンセル</button>
|
|
154
|
+
</div>
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
#### 1.7 フォームのラベル
|
|
158
|
+
|
|
159
|
+
```html
|
|
160
|
+
<!-- ❌ 悪い例 -->
|
|
161
|
+
<input type="text" placeholder="メールアドレス">
|
|
162
|
+
|
|
163
|
+
<!-- ✅ 良い例 -->
|
|
164
|
+
<label for="email">メールアドレス</label>
|
|
165
|
+
<input type="email" id="email" name="email" required>
|
|
166
|
+
|
|
167
|
+
<!-- ✅ エラーメッセージの関連付け -->
|
|
168
|
+
<label for="email">メールアドレス</label>
|
|
169
|
+
<input type="email" id="email" name="email" aria-describedby="email-error" required>
|
|
170
|
+
<span id="email-error" role="alert">有効なメールアドレスを入力してください</span>
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### アクセシビリティツール
|
|
174
|
+
|
|
175
|
+
| ツール | 用途 |
|
|
176
|
+
|--------|------|
|
|
177
|
+
| [axe DevTools](https://www.deque.com/axe/devtools/) | 自動検出ツール |
|
|
178
|
+
| [WAVE](https://wave.webaim.org/) | ページ全体の評価 |
|
|
179
|
+
| [Lighthouse](https://developers.google.com/web/tools/lighthouse) | Chrome DevTools統合 |
|
|
180
|
+
| [NVDA](https://www.nvaccess.org/) | スクリーンリーダー(Windows) |
|
|
181
|
+
| [VoiceOver](https://www.apple.com/accessibility/voiceover/) | スクリーンリーダー(Mac/iOS) |
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## 2. レスポンシブデザイン
|
|
186
|
+
|
|
187
|
+
### ブレークポイント標準
|
|
188
|
+
|
|
189
|
+
| デバイス | 幅 | 備考 |
|
|
190
|
+
|---------|-----|------|
|
|
191
|
+
| Mobile(縦) | 320px - 480px | iPhone SE, etc. |
|
|
192
|
+
| Mobile(横) | 481px - 767px | |
|
|
193
|
+
| Tablet(縦) | 768px - 1024px | iPad, etc. |
|
|
194
|
+
| Tablet(横) | 1025px - 1280px | |
|
|
195
|
+
| Desktop | 1281px - 1920px | 標準的なPC |
|
|
196
|
+
| Large Desktop | 1921px+ | 4K, ウルトラワイド |
|
|
197
|
+
|
|
198
|
+
### レスポンシブチェックリスト
|
|
199
|
+
|
|
200
|
+
#### 2.1 ビューポート設定
|
|
201
|
+
|
|
202
|
+
```html
|
|
203
|
+
<!-- ✅ 必須 -->
|
|
204
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
#### 2.2 フルードグリッド
|
|
208
|
+
|
|
209
|
+
```css
|
|
210
|
+
/* ❌ 悪い例: 固定幅 */
|
|
211
|
+
.container {
|
|
212
|
+
width: 1200px;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
/* ✅ 良い例: 可変幅 */
|
|
216
|
+
.container {
|
|
217
|
+
max-width: 1200px;
|
|
218
|
+
width: 100%;
|
|
219
|
+
padding: 0 16px;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
/* ✅ より良い例: CSS Grid */
|
|
223
|
+
.grid {
|
|
224
|
+
display: grid;
|
|
225
|
+
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
|
|
226
|
+
gap: 16px;
|
|
227
|
+
}
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
#### 2.3 フレキシブル画像
|
|
231
|
+
|
|
232
|
+
```css
|
|
233
|
+
/* ✅ 基本 */
|
|
234
|
+
img {
|
|
235
|
+
max-width: 100%;
|
|
236
|
+
height: auto;
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/* ✅ レスポンシブ画像 */
|
|
240
|
+
<picture>
|
|
241
|
+
<source media="(min-width: 1024px)" srcset="large.jpg">
|
|
242
|
+
<source media="(min-width: 768px)" srcset="medium.jpg">
|
|
243
|
+
<img src="small.jpg" alt="説明">
|
|
244
|
+
</picture>
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
#### 2.4 メディアクエリ
|
|
248
|
+
|
|
249
|
+
```css
|
|
250
|
+
/* モバイルファースト推奨 */
|
|
251
|
+
|
|
252
|
+
/* Base: Mobile */
|
|
253
|
+
.menu {
|
|
254
|
+
display: none;
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
/* Tablet以上 */
|
|
258
|
+
@media (min-width: 768px) {
|
|
259
|
+
.menu {
|
|
260
|
+
display: flex;
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
/* Desktop以上 */
|
|
265
|
+
@media (min-width: 1280px) {
|
|
266
|
+
.menu {
|
|
267
|
+
font-size: 18px;
|
|
268
|
+
}
|
|
269
|
+
}
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
#### 2.5 タッチターゲットサイズ
|
|
273
|
+
|
|
274
|
+
**最小サイズ: 44x44px(Apple HIG)/ 48x48px(Material Design)**
|
|
275
|
+
|
|
276
|
+
```css
|
|
277
|
+
/* ❌ 悪い例: タップしづらい */
|
|
278
|
+
.button {
|
|
279
|
+
width: 30px;
|
|
280
|
+
height: 30px;
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
/* ✅ 良い例 */
|
|
284
|
+
.button {
|
|
285
|
+
min-width: 44px;
|
|
286
|
+
min-height: 44px;
|
|
287
|
+
padding: 12px 16px;
|
|
288
|
+
}
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### レスポンシブテストツール
|
|
292
|
+
|
|
293
|
+
- Chrome DevTools: Device Toolbar
|
|
294
|
+
- Firefox: Responsive Design Mode
|
|
295
|
+
- [BrowserStack](https://www.browserstack.com/): 実機テスト
|
|
296
|
+
- [Responsively App](https://responsively.app/): 複数デバイス同時表示
|
|
297
|
+
|
|
298
|
+
---
|
|
299
|
+
|
|
300
|
+
## 3. UXパターン
|
|
301
|
+
|
|
302
|
+
### 3.1 フォームデザイン
|
|
303
|
+
|
|
304
|
+
#### フォームのベストプラクティス
|
|
305
|
+
|
|
306
|
+
```html
|
|
307
|
+
<!-- ✅ 良いフォーム -->
|
|
308
|
+
<form>
|
|
309
|
+
<!-- ラベルは上に配置 -->
|
|
310
|
+
<label for="name">お名前 <span aria-label="必須">*</span></label>
|
|
311
|
+
<input type="text" id="name" name="name" required autocomplete="name">
|
|
312
|
+
|
|
313
|
+
<!-- ヘルプテキスト -->
|
|
314
|
+
<label for="password">パスワード</label>
|
|
315
|
+
<input type="password" id="password" name="password"
|
|
316
|
+
aria-describedby="password-help" required>
|
|
317
|
+
<small id="password-help">8文字以上、英数字を含む</small>
|
|
318
|
+
|
|
319
|
+
<!-- エラーメッセージ -->
|
|
320
|
+
<label for="email">メールアドレス</label>
|
|
321
|
+
<input type="email" id="email" name="email"
|
|
322
|
+
aria-describedby="email-error" aria-invalid="true" required>
|
|
323
|
+
<span id="email-error" role="alert" class="error">
|
|
324
|
+
有効なメールアドレスを入力してください
|
|
325
|
+
</span>
|
|
326
|
+
|
|
327
|
+
<!-- ボタン -->
|
|
328
|
+
<button type="submit">送信</button>
|
|
329
|
+
<button type="button">キャンセル</button>
|
|
330
|
+
</form>
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
**チェック項目:**
|
|
334
|
+
- [ ] ラベルがすべての入力フィールドに付いているか
|
|
335
|
+
- [ ] 必須項目が明示されているか
|
|
336
|
+
- [ ] プレースホルダーをラベルの代わりにしていないか
|
|
337
|
+
- [ ] エラーメッセージが具体的か
|
|
338
|
+
- [ ] 送信ボタンが明確か
|
|
339
|
+
|
|
340
|
+
#### フォームバリデーション
|
|
341
|
+
|
|
342
|
+
```javascript
|
|
343
|
+
// ✅ リアルタイムバリデーション(onBlurで)
|
|
344
|
+
input.addEventListener('blur', (e) => {
|
|
345
|
+
if (!e.target.validity.valid) {
|
|
346
|
+
showError(e.target, getErrorMessage(e.target));
|
|
347
|
+
} else {
|
|
348
|
+
clearError(e.target);
|
|
349
|
+
}
|
|
350
|
+
});
|
|
351
|
+
|
|
352
|
+
// ✅ 送信時の全体バリデーション
|
|
353
|
+
form.addEventListener('submit', (e) => {
|
|
354
|
+
if (!form.checkValidity()) {
|
|
355
|
+
e.preventDefault();
|
|
356
|
+
// 最初のエラーフィールドにフォーカス
|
|
357
|
+
const firstError = form.querySelector('[aria-invalid="true"]');
|
|
358
|
+
firstError?.focus();
|
|
359
|
+
}
|
|
360
|
+
});
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
### 3.2 フィードバック
|
|
364
|
+
|
|
365
|
+
#### ローディング状態
|
|
366
|
+
|
|
367
|
+
```html
|
|
368
|
+
<!-- ✅ ローディング表示 -->
|
|
369
|
+
<button type="submit" aria-busy="true" disabled>
|
|
370
|
+
<span class="spinner" aria-hidden="true"></span>
|
|
371
|
+
送信中...
|
|
372
|
+
</button>
|
|
373
|
+
|
|
374
|
+
<!-- スクリーンリーダー用 -->
|
|
375
|
+
<div role="status" aria-live="polite" class="sr-only">
|
|
376
|
+
データを送信しています。しばらくお待ちください。
|
|
377
|
+
</div>
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
#### 成功/エラー通知
|
|
381
|
+
|
|
382
|
+
```html
|
|
383
|
+
<!-- ✅ 成功メッセージ -->
|
|
384
|
+
<div role="alert" aria-live="assertive" class="success">
|
|
385
|
+
✓ 保存しました
|
|
386
|
+
</div>
|
|
387
|
+
|
|
388
|
+
<!-- ✅ エラーメッセージ -->
|
|
389
|
+
<div role="alert" aria-live="assertive" class="error">
|
|
390
|
+
✗ 保存に失敗しました。もう一度お試しください。
|
|
391
|
+
</div>
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
### 3.3 ナビゲーション
|
|
395
|
+
|
|
396
|
+
#### パンくずリスト
|
|
397
|
+
|
|
398
|
+
```html
|
|
399
|
+
<!-- ✅ セマンティックなパンくずリスト -->
|
|
400
|
+
<nav aria-label="パンくずリスト">
|
|
401
|
+
<ol>
|
|
402
|
+
<li><a href="/">ホーム</a></li>
|
|
403
|
+
<li><a href="/products">商品</a></li>
|
|
404
|
+
<li aria-current="page">商品詳細</li>
|
|
405
|
+
</ol>
|
|
406
|
+
</nav>
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
#### ページネーション
|
|
410
|
+
|
|
411
|
+
```html
|
|
412
|
+
<!-- ✅ アクセシブルなページネーション -->
|
|
413
|
+
<nav aria-label="ページネーション">
|
|
414
|
+
<ul>
|
|
415
|
+
<li><a href="?page=1" aria-label="前のページ">←</a></li>
|
|
416
|
+
<li><a href="?page=1">1</a></li>
|
|
417
|
+
<li><span aria-current="page">2</span></li>
|
|
418
|
+
<li><a href="?page=3">3</a></li>
|
|
419
|
+
<li><a href="?page=3" aria-label="次のページ">→</a></li>
|
|
420
|
+
</ul>
|
|
421
|
+
</nav>
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
### 3.4 モーダル/ダイアログ
|
|
425
|
+
|
|
426
|
+
```html
|
|
427
|
+
<!-- ✅ アクセシブルなモーダル -->
|
|
428
|
+
<div role="dialog" aria-labelledby="modal-title" aria-modal="true">
|
|
429
|
+
<h2 id="modal-title">確認</h2>
|
|
430
|
+
<p>本当に削除しますか?この操作は取り消せません。</p>
|
|
431
|
+
<button autofocus>削除</button>
|
|
432
|
+
<button>キャンセル</button>
|
|
433
|
+
</div>
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
**モーダルのJavaScript要件:**
|
|
437
|
+
- [ ] 開いたときに最初の要素にフォーカス
|
|
438
|
+
- [ ] Tabキーでモーダル内を循環
|
|
439
|
+
- [ ] Escキーで閉じる
|
|
440
|
+
- [ ] 背景をスクロール不可にする
|
|
441
|
+
- [ ] 閉じたときに元の位置にフォーカスを戻す
|
|
442
|
+
|
|
443
|
+
---
|
|
444
|
+
|
|
445
|
+
## 4. パフォーマンス(Core Web Vitals)
|
|
446
|
+
|
|
447
|
+
### Core Web Vitals 基準
|
|
448
|
+
|
|
449
|
+
| 指標 | 良好 | 改善が必要 | 不良 |
|
|
450
|
+
|------|------|-----------|------|
|
|
451
|
+
| **LCP** (Largest Contentful Paint) | ≤ 2.5s | 2.5s - 4.0s | > 4.0s |
|
|
452
|
+
| **FID** (First Input Delay) | ≤ 100ms | 100ms - 300ms | > 300ms |
|
|
453
|
+
| **CLS** (Cumulative Layout Shift) | ≤ 0.1 | 0.1 - 0.25 | > 0.25 |
|
|
454
|
+
|
|
455
|
+
### 4.1 LCP(最大コンテンツの描画)
|
|
456
|
+
|
|
457
|
+
**改善方法:**
|
|
458
|
+
|
|
459
|
+
```html
|
|
460
|
+
<!-- ✅ 画像の最適化 -->
|
|
461
|
+
<img src="hero.jpg"
|
|
462
|
+
width="1200"
|
|
463
|
+
height="600"
|
|
464
|
+
loading="eager"
|
|
465
|
+
fetchpriority="high"
|
|
466
|
+
alt="Hero image">
|
|
467
|
+
|
|
468
|
+
<!-- ✅ WebPフォーマット -->
|
|
469
|
+
<picture>
|
|
470
|
+
<source type="image/webp" srcset="hero.webp">
|
|
471
|
+
<img src="hero.jpg" alt="Hero image">
|
|
472
|
+
</picture>
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
**チェック項目:**
|
|
476
|
+
- [ ] 画像をWebP形式で提供しているか
|
|
477
|
+
- [ ] 画像サイズを指定しているか(width, height)
|
|
478
|
+
- [ ] Critical CSSをインライン化しているか
|
|
479
|
+
- [ ] 不要なJavaScriptをレンダリングブロックしていないか
|
|
480
|
+
|
|
481
|
+
### 4.2 FID(初回入力遅延)
|
|
482
|
+
|
|
483
|
+
**改善方法:**
|
|
484
|
+
|
|
485
|
+
```html
|
|
486
|
+
<!-- ✅ JavaScriptの遅延読み込み -->
|
|
487
|
+
<script src="analytics.js" defer></script>
|
|
488
|
+
<script src="non-critical.js" async></script>
|
|
489
|
+
|
|
490
|
+
<!-- ✅ Code Splitting -->
|
|
491
|
+
<script type="module">
|
|
492
|
+
import('./critical.js');
|
|
493
|
+
|
|
494
|
+
// 必要なときだけ読み込み
|
|
495
|
+
button.addEventListener('click', async () => {
|
|
496
|
+
const module = await import('./heavy-feature.js');
|
|
497
|
+
module.init();
|
|
498
|
+
});
|
|
499
|
+
</script>
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
**チェック項目:**
|
|
503
|
+
- [ ] JavaScriptバンドルサイズを最小化しているか
|
|
504
|
+
- [ ] Tree Shakingを有効にしているか
|
|
505
|
+
- [ ] 不要なpolyfillを削除したか
|
|
506
|
+
- [ ] Long Tasksを分割したか
|
|
507
|
+
|
|
508
|
+
### 4.3 CLS(累積レイアウトシフト)
|
|
509
|
+
|
|
510
|
+
**改善方法:**
|
|
511
|
+
|
|
512
|
+
```css
|
|
513
|
+
/* ✅ 画像/動画のサイズ指定 */
|
|
514
|
+
img, video {
|
|
515
|
+
aspect-ratio: 16 / 9;
|
|
516
|
+
width: 100%;
|
|
517
|
+
height: auto;
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
/* ✅ フォント読み込み時のレイアウトシフト防止 */
|
|
521
|
+
@font-face {
|
|
522
|
+
font-family: 'CustomFont';
|
|
523
|
+
src: url('font.woff2') format('woff2');
|
|
524
|
+
font-display: swap; /* または optional */
|
|
525
|
+
}
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
**チェック項目:**
|
|
529
|
+
- [ ] 画像・動画にwidth/height属性を指定しているか
|
|
530
|
+
- [ ] Webフォント読み込み中のフォールバックが適切か
|
|
531
|
+
- [ ] 広告・埋め込みコンテンツの領域を確保しているか
|
|
532
|
+
- [ ] アニメーションでtransformを使用しているか(topではなく)
|
|
533
|
+
|
|
534
|
+
### パフォーマンステストツール
|
|
535
|
+
|
|
536
|
+
| ツール | 用途 |
|
|
537
|
+
|--------|------|
|
|
538
|
+
| [Lighthouse](https://developers.google.com/web/tools/lighthouse) | 総合評価 |
|
|
539
|
+
| [PageSpeed Insights](https://pagespeed.web.dev/) | 実ユーザーデータ |
|
|
540
|
+
| [WebPageTest](https://www.webpagetest.org/) | 詳細分析 |
|
|
541
|
+
| Chrome DevTools: Performance | プロファイリング |
|
|
542
|
+
|
|
543
|
+
---
|
|
544
|
+
|
|
545
|
+
## レビューレポートフォーマット
|
|
546
|
+
|
|
547
|
+
### テンプレート
|
|
548
|
+
|
|
549
|
+
```markdown
|
|
550
|
+
# デザインレビューレポート
|
|
551
|
+
|
|
552
|
+
## サマリー
|
|
553
|
+
- レビュー日時: YYYY-MM-DD
|
|
554
|
+
- ページ/コンポーネント: [対象]
|
|
555
|
+
- 総合評価: [A/B/C/D]
|
|
556
|
+
|
|
557
|
+
## 1. アクセシビリティ(評価: X/10)
|
|
558
|
+
|
|
559
|
+
### Critical(即時対応)
|
|
560
|
+
- [ ] **コントラスト不足**: ボタンのコントラスト比が3:1(推奨: 4.5:1)
|
|
561
|
+
- 場所: `.primary-button`
|
|
562
|
+
- 推奨: `color: #005A9C` に変更
|
|
563
|
+
|
|
564
|
+
### Warning(対応推奨)
|
|
565
|
+
- [ ] **フォーカス不明**: フォーカスインジケーターが視認困難
|
|
566
|
+
- 場所: `input:focus`
|
|
567
|
+
- 推奨: `outline: 2px solid #0066cc` を追加
|
|
568
|
+
|
|
569
|
+
### Info(改善提案)
|
|
570
|
+
- [ ] **ARIA不足**: モーダルに `aria-modal="true"` がない
|
|
571
|
+
- 場所: `.modal`
|
|
572
|
+
- 推奨: 属性を追加
|
|
573
|
+
|
|
574
|
+
## 2. レスポンシブデザイン(評価: X/10)
|
|
575
|
+
|
|
576
|
+
### Critical
|
|
577
|
+
- [ ] **横スクロール発生**: Mobile (375px) で横スクロール
|
|
578
|
+
- 原因: `.container { width: 400px }`
|
|
579
|
+
- 推奨: `max-width: 100%` に変更
|
|
580
|
+
|
|
581
|
+
### Info
|
|
582
|
+
- [ ] **タッチターゲット小**: ボタンが40x40px
|
|
583
|
+
- 推奨: 最小 44x44px に拡大
|
|
584
|
+
|
|
585
|
+
## 3. UXパターン(評価: X/10)
|
|
586
|
+
|
|
587
|
+
### Warning
|
|
588
|
+
- [ ] **エラーメッセージ不明確**: "Invalid input"
|
|
589
|
+
- 推奨: 「メールアドレスの形式が正しくありません」
|
|
590
|
+
|
|
591
|
+
### Info
|
|
592
|
+
- [ ] **ローディング状態なし**: 送信ボタンにフィードバックなし
|
|
593
|
+
- 推奨: `aria-busy="true"` とスピナー表示
|
|
594
|
+
|
|
595
|
+
## 4. パフォーマンス(評価: X/10)
|
|
596
|
+
|
|
597
|
+
### Core Web Vitals
|
|
598
|
+
- LCP: 3.2s(改善が必要)
|
|
599
|
+
- FID: 80ms(良好)
|
|
600
|
+
- CLS: 0.15(改善が必要)
|
|
601
|
+
|
|
602
|
+
### Critical
|
|
603
|
+
- [ ] **LCP遅延**: Hero画像 (2.5MB) が最適化されていない
|
|
604
|
+
- 推奨: WebP形式 (300KB) に変換
|
|
605
|
+
|
|
606
|
+
### Warning
|
|
607
|
+
- [ ] **CLS発生**: Webフォント読み込み時にレイアウトシフト
|
|
608
|
+
- 推奨: `font-display: swap` を設定
|
|
609
|
+
|
|
610
|
+
## 推奨アクション
|
|
611
|
+
|
|
612
|
+
### 優先度1(即時対応)
|
|
613
|
+
1. コントラスト比の改善
|
|
614
|
+
2. 横スクロールの修正
|
|
615
|
+
3. 画像の最適化
|
|
616
|
+
|
|
617
|
+
### 優先度2(1週間以内)
|
|
618
|
+
1. フォーカスインジケーターの改善
|
|
619
|
+
2. エラーメッセージの具体化
|
|
620
|
+
3. Webフォントの最適化
|
|
621
|
+
|
|
622
|
+
### 優先度3(任意)
|
|
623
|
+
1. ARIA属性の追加
|
|
624
|
+
2. タッチターゲットの拡大
|
|
625
|
+
```
|
|
626
|
+
|
|
627
|
+
---
|
|
628
|
+
|
|
629
|
+
## 参考資料
|
|
630
|
+
|
|
631
|
+
### アクセシビリティ
|
|
632
|
+
- [WCAG 2.1 ガイドライン](https://www.w3.org/WAI/WCAG21/quickref/)
|
|
633
|
+
- [WebAIM](https://webaim.org/)
|
|
634
|
+
- [A11y Project](https://www.a11yproject.com/)
|
|
635
|
+
- [MDN Accessibility](https://developer.mozilla.org/ja/docs/Web/Accessibility)
|
|
636
|
+
|
|
637
|
+
### レスポンシブデザイン
|
|
638
|
+
- [Responsive Web Design Basics](https://web.dev/responsive-web-design-basics/)
|
|
639
|
+
- [CSS Grid Layout](https://developer.mozilla.org/ja/docs/Web/CSS/CSS_Grid_Layout)
|
|
640
|
+
|
|
641
|
+
### UXパターン
|
|
642
|
+
- [Material Design](https://material.io/)
|
|
643
|
+
- [Apple Human Interface Guidelines](https://developer.apple.com/design/human-interface-guidelines/)
|
|
644
|
+
- [Nielsen Norman Group](https://www.nngroup.com/)
|
|
645
|
+
|
|
646
|
+
### パフォーマンス
|
|
647
|
+
- [Web Vitals](https://web.dev/vitals/)
|
|
648
|
+
- [Lighthouse Performance Scoring](https://developer.chrome.com/docs/lighthouse/performance/performance-scoring/)
|