consistency-pass

Audits changed files against style guides, migration plans, and shared-resource documentation.

1.5k|261|Updated Nov 19, 2018
One-click install
npx skills add https://github.com/adobe/spectrum-web-components --skill consistency-pass
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: consistency-pass
Source: https://github.com/adobe/spectrum-web-components/tree/main/.ai/skills/consistency-pass
Command: npx skills add https://github.com/adobe/spectrum-web-components --skill consistency-pass

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

During component migrations, code drifts from style guides, migration plans go stale, and shared-resource documentation silently falls out of sync. This Skill runs a structured three-part self-audit so these inconsistencies are caught before a migration phase is declared complete.

Core Features & Use Cases

  • Code Conformance Check: Runs linters (yarn lint, yarn lint:css, prettier) and applies the code-conformance checklist to changed files.
  • Plan Validity Check: Verifies the implementation matches the migration plan, updates phase checklists, moves settled questions to the Decision log, and scans for cascading inconsistencies across plan sections.
  • Shared Resources Check: Ensures new or newly consumed controllers, mixins, and utilities in @adobe/spectrum-wc-core or sibling shared-utils locations are recorded in the shared-resources doc.
  • Use Case: After finishing the styling phase of a component migration, run the pass to confirm CSS follows conventions, the plan's Phase 5 checklist is updated, and any new shared mixin is documented.

Quick Start

Ask the assistant to run a consistency and validity pass on the files changed in this migration phase before marking it complete.

Frequently Asked Questions about consistency-pass

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check my migration work against the style guide?

Run a consistency pass by saying "check my work" or "consistency pass". It runs yarn lint, yarn lint:css, and prettier on changed files first, then applies the manual code-conformance checklist scoped to the files you changed.

When should a consistency and validity pass be run?

Run it before declaring any migration phase complete, especially Phases 3, 5, 6, and 7, and after implementation changes to TypeScript, CSS, test, or stories files. It should run proactively without waiting to be asked.

What happens when implementation diverges from the migration plan?

The plan is treated as authoritative, so divergence is flagged to the user rather than silently updating the plan. The plan is only updated when the change was explicitly confirmed during the current session.

Does the pass check shared resources in @adobe/spectrum-wc-core?

Yes, it verifies that new or newly consumed controllers, mixins, utilities, and directives in core or sibling shared-utils locations are recorded in the shared-resources doc. Phases touching no shared resources report not applicable.

What is a cascading consistency check in a migration plan?

When any plan section changes, the entire plan is scanned for affected references, such as renamed attributes, removed dependencies, or changed defaults. All code examples, breaking change entries, and migration guidance are updated to stay consistent.