style(status-light): clean up code styles by rise-erpelding · Pull Request #6157 · adobe/spectrum-web-components

rise-erpelding · 2026-04-09T13:59:00Z

Description

2nd-gen status light cleanup for SWC-1671: contributor TypeScript guides (STATUS_LIGHT_* naming, types file layout, DEBUG lifecycle/URLs), SWC concrete class polish, and story fixes.

Core (`StatusLight.types.ts`, `StatusLight.base.ts`)

Rename constants to STATUS_LIGHT_* (multi-word prefix per naming guide). No deprecated STATUSLIGHT_* re-exports (2nd-gen still preview).
Reorganize types with SHARED / S1-ONLY / CANONICAL / TYPES separators (same idea as Badge.types.ts). Add StatusLightSize derived from valid sizes.
DEBUG: Run validation in update() before super.update() (match Badge.base.ts / 17_debug-validation). warn() doc links use 2nd-gen Storybook (.../second-gen/?path=/docs/components-status-light--docs, same base as SECOND_GEN_URL in scripts/generate-llms-txt.js).

SWC (`StatusLight.ts`, stories)

Class-level @property / @attribute on the concrete class for CEM parity (e.g. with ProgressCircle.ts).
classMap: keep typeof this.variant !== 'undefined' for consistency with Badge.
Stories: import/use STATUS_LIGHT_* everywhere (e.g. Sizes story uses STATUS_LIGHT_VALID_SIZES).

Out of scope (documented / deferred)

S1-only blocks in core types: left labeled for removal with 1st-gen; no full “canonical-only core” refactor in this PR.
Deprecated aliases for old constant names: skipped

Motivation and context

Aligns 2nd-gen status light with 08_component-types, 10_naming-conventions, 06_method-patterns, and 17_debug-validation so future S1 removal and consumers get predictable exports and DEBUG behavior.

Related issue(s)

SWC-1671

Screenshots (if appropriate)

None expected (no intentional visual/CSS changes). If VRT diffs appear, confirm against Storybook.

Author's checklist

I have read the CONTRIBUTING and PULL_REQUESTS documents.
I have reviewed the Accessibility Practices for this feature, see: ARIA Practices
I have added or kept automated tests covering these changes (yarn test status-light from 2nd-gen/packages/swc).
I have included a well-written changeset if this change should publish a version bump (likely patch for @spectrum-web-components/core / @adobe/spectrum-wc if applicable).
I have included updated documentation if required (stories/JSDoc updated in-repo).

Reviewer's checklist

Includes a GitHub issue with appropriate flag or Jira ticket number without a link
Includes a thoughtfully written changeset if the change warrants patch, minor, or major
Automated tests cover the change and follow project practices
Validated on supported browsers (spot-check if scope is narrow)
All VRTs approved before golden hash updates (if CI reports diffs)

After the PR opens, use branch preview links from the github-actions comment (Storybook second-gen, VRT review URLs) instead of hardcoding PR numbers in manual steps.

Manual review test cases

Status light — Storybook (2nd-gen)
1. Open second-gen Storybook → Status light (overview, sizes, semantic / non-semantic variants).
2. Confirm layouts and labels render; controls for variant and size behave as before.
DEBUG (optional, local dev)
1. Run Storybook or app in development so window.__swc.DEBUG is on.
2. Set an invalid variant on <swc-status-light> (e.g. unsupported string) → expect warn with message + link to second-gen docs.
3. Add disabled attribute on 2nd-gen element → expect warn about unsupported disabled state.
VRT
1. If CI reports visual diffs for status light, confirm expected vs golden; update golden hash only if intentional.

Device review

Desktop
(emulated) Mobile — spot-check Status light stories if VRT or layout concerns
(emulated) iPad — optional

Accessibility testing checklist

See Accessibility testing guide.

Status light is non-interactive (no focusable host behavior); content in the default slot supplies visible text. No change to role model intended.

Keyboard — No interactive host: tab through a page with status lights and confirm focus order is unchanged and no new focus traps.
1. Open 2nd-gen Storybook → Status light Overview (or similar).
2. Tab past surrounding controls; status light itself should not steal focus.
3. Expect no regression vs previous behavior.
Screen reader — Confirm slotted label still reads as normal text content in context (e.g. VoiceOver on macOS over the Overview story).
1. Open the same story.
2. Navigate to the status light text.
3. Expect the label to be announced with surrounding page semantics unchanged.

changeset-bot · 2026-04-09T13:59:09Z

⚠️ No Changeset found

Latest commit: c3bc530

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2026-04-09T14:04:38Z

📚 Branch Preview Links

🔍 First Generation Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-6157

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

rise-erpelding · 2026-04-09T14:51:45Z

-/**
+/*
 * @todo The S1 types can be removed once we are no longer maintaining 1st-gen.
- * @todo Rename STATUSLIGHT_ prefix to STATUS_LIGHT_ to align with type prefix


In the rename, I did not add any deprecation notices... I thought given the current usage of 2nd-gen, it wasn't really necessary and would just add noise. But definitely could be added if that's something we want!

I think that makes sense, not adding the deprecation notice on the name change.

marissahuysentruyt

Looks like there's probably 3 files that could get deleted! Maybe the branch just needs a rebase!

marissahuysentruyt · 2026-04-09T15:33:11Z

-/**
+/*
 * @todo The S1 types can be removed once we are no longer maintaining 1st-gen.
- * @todo Rename STATUSLIGHT_ prefix to STATUS_LIGHT_ to align with type prefix


I think that makes sense, not adding the deprecation notice on the name change.

marissahuysentruyt · 2026-04-09T15:36:30Z

+export const STATUS_LIGHT_VARIANTS_S2 = [
+  ...STATUS_LIGHT_VARIANTS_SEMANTIC_S2,
+  ...STATUS_LIGHT_VARIANTS_COLOR_S2,


Now that 1st-gen and 2nd-gen are separated, can we remove or rename any of the types that have the S2 suffix? Do we even need the S1 types now?

We don't, but I didn't want to tangle with them right now, I'm hoping we can deal with this in SWC-1867. Good call-out!

agree with addressing in SWC-1867. this was an affect of the pivot and decoupling from 1st-gen

caseyisonit

approving with s1 types clean up in SWC-1867

…tatus-light-code-style

* refactor: rename STATUSLIGHT to STATUS_LIGHT type * refactor: reorg types file * refactor: standardized debug warnings * refactor: update jsdoc comments --------- Co-authored-by: Casey Eickhoff <48574582+caseyisonit@users.noreply.github.com>

rise-erpelding added Component:Status light 2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. labels Apr 9, 2026

rise-erpelding marked this pull request as ready for review April 9, 2026 14:02

rise-erpelding requested a review from a team as a code owner April 9, 2026 14:02

rise-erpelding added the Status:Ready for review PR ready for review or re-review. label Apr 9, 2026

rise-erpelding mentioned this pull request Apr 9, 2026

[SWC-1668] feat: migrate poc components to full-fidelity production #6122

Draft

40 tasks

rise-erpelding commented Apr 9, 2026

View reviewed changes

marissahuysentruyt reviewed Apr 9, 2026

View reviewed changes

rise-erpelding added 4 commits April 9, 2026 10:54

refactor: rename STATUSLIGHT to STATUS_LIGHT type

309bc0b

refactor: reorg types file

9460215

refactor: standardized debug warnings

3d5cef9

refactor: update jsdoc comments

464ed2e

rise-erpelding force-pushed the rise-erpelding/swc-1671-status-light-code-style branch from 7052be4 to 464ed2e Compare April 9, 2026 15:54

caseyisonit approved these changes Apr 13, 2026

View reviewed changes

Merge branch 'swc-1668/poc-components' into rise-erpelding/swc-1671-s…

c3bc530

…tatus-light-code-style

caseyisonit added the Status:Ready for merge PR has 2 approvals, all tests pass, and is ready to merge label Apr 13, 2026

caseyisonit merged commit e0d3061 into swc-1668/poc-components Apr 13, 2026
27 checks passed

caseyisonit deleted the rise-erpelding/swc-1671-status-light-code-style branch April 13, 2026 19:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

style(status-light): clean up code styles#6157

style(status-light): clean up code styles#6157
caseyisonit merged 5 commits intoswc-1668/poc-componentsfrom
rise-erpelding/swc-1671-status-light-code-style

rise-erpelding commented Apr 9, 2026 •

edited

Loading

Uh oh!

changeset-bot Bot commented Apr 9, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 9, 2026 •

edited

Loading

Uh oh!

rise-erpelding Apr 9, 2026

Uh oh!

marissahuysentruyt Apr 9, 2026

Uh oh!

marissahuysentruyt left a comment

Uh oh!

marissahuysentruyt Apr 9, 2026

Uh oh!

marissahuysentruyt Apr 9, 2026

Uh oh!

rise-erpelding Apr 9, 2026

Uh oh!

caseyisonit Apr 13, 2026

Uh oh!

Uh oh!

Uh oh!

caseyisonit left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

rise-erpelding commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Core (StatusLight.types.ts, StatusLight.base.ts)

SWC (StatusLight.ts, stories)

Out of scope (documented / deferred)

Motivation and context

Related issue(s)

Screenshots (if appropriate)

Author's checklist

Reviewer's checklist

Manual review test cases

Device review

Accessibility testing checklist

Uh oh!

changeset-bot Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Branch Preview Links

🔍 First Generation Visual Regression Test Results

Uh oh!

rise-erpelding Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

marissahuysentruyt Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

marissahuysentruyt left a comment

Choose a reason for hiding this comment

Uh oh!

marissahuysentruyt Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

marissahuysentruyt Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

rise-erpelding Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

caseyisonit Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

caseyisonit left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rise-erpelding commented Apr 9, 2026 •

edited

Loading

Core (`StatusLight.types.ts`, `StatusLight.base.ts`)

SWC (`StatusLight.ts`, stories)

changeset-bot Bot commented Apr 9, 2026 •

edited

Loading

github-actions Bot commented Apr 9, 2026 •

edited

Loading