migration-api

Migrate properties, methods, and types from 1st-gen to 2nd-gen components.

1.5k|257|Updated Nov 19, 2018

Search Tags:#api #components #migration #type-safety #phase-3 #public-api #2nd-gen

Ready to run

npx skills add https://github.com/adobe/spectrum-web-components --skill migration-api

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: migration-api
Source: https://github.com/adobe/spectrum-web-components/tree/main/.ai/skills/migration-api
Command: npx skills add https://github.com/adobe/spectrum-web-components --skill migration-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Phase 3 of the 1st-gen to 2nd-gen component migration; ensures properties, methods, and types are moved while keeping the public API clear and well-structured.

Core Features & Use Cases

Phase 3 API migration workflow guidance, including identifying surface changes, preserving core types, and documenting temporary changes with @todo notes.
Maintains type safety by centering changes in core and isolating generation-specific logic.
Use Case: Apply to multiple components undergoing the Phase 3 migration to ensure a consistent public contract.

Quick Start

Migrate properties, methods, and types from 1st-gen to 2nd-gen components while preserving the public API.

Frequently Asked Questions about migration-api

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

FAQPage Schema

How do I migrate component APIs from 1st-gen to 2nd-gen while preserving type safety?▼

To migrate component APIs from 1st-gen to 2nd-gen while preserving type safety, move properties, methods, and types into core, isolating generation-specific logic to maintain consistent public contracts.

What is the Phase 3 API migration workflow for components?▼

The Phase 3 API migration workflow identifies public surface changes, preserves core types, and documents temporary changes with @todo notes to ensure a clear and well-structured public API across components.

How should I document temporary API changes during a component migration?▼

You should document temporary API changes during a component migration by adding @todo notes directly in the code, ensuring temporary deviations from the public contract are tracked for future alignment.

Does 2nd-gen component migration require public API contracts to live in core?▼

Yes, 2nd-gen component migration enforces that public API contracts must live in core to maintain type safety, isolate generation-specific logic, and align the project structure with SWC guidelines.

Can I apply the Phase 3 API migration workflow across multiple components at once?▼

Yes, you can apply the Phase 3 API migration workflow across multiple components simultaneously to ensure they share a consistent public contract and updated documentation during the generation transition.

Why should public API contracts be centralized in core during generation migration?▼

Centralizing public API contracts in core during generation migration maintains type safety by isolating generation-specific logic, preventing contract drift, and aligning project structure with SWC guidelines.