feat(components, docs, eslint): update component ::part names to use post- prefix
#6806
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 tasks
🦋 Changeset detectedLatest commit: b759b4a The changes in this PR will be included in the next version bump. This PR includes changesets to release 14 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
alionazherdetska
changed the title
post- prefix::part names to use post- prefix
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enforces a new naming convention requiring all CSS Shadow Parts in Stencil components to use the post- prefix to prevent naming collisions with third-party styling. The changes include renaming existing Shadow Parts in post-menu and post-tabs components, implementing a new ESLint rule to enforce this convention going forward, and updating all associated documentation, tests, and styling references.
Key Changes
- Added new ESLint rule
stencil-component-part-namingto enforcepost-prefix on all Shadow Parts - Renamed Shadow Parts in components:
menu→post-menu,tabs→post-tabs,content→post-tabs-content - Updated all references across components, documentation, tests, and styles
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/eslint/src/rules/stencil-component-part-naming.ts | New ESLint rule implementation to enforce post- prefix on Shadow Parts |
| packages/eslint/test/rules/stencil-component-part-naming.spec.ts | Comprehensive test coverage for the new ESLint rule |
| packages/eslint/src/rules/index.ts | Exports the new ESLint rule |
| packages/eslint/src/configs/stencil/recommended.ts | Enables the new rule in recommended configuration |
| packages/components/src/components/post-tabs/post-tabs.tsx | Updates Shadow Part names and JSDoc comments for post-tabs component |
| packages/components/src/components/post-menu/post-menu.tsx | Updates Shadow Part names and JSDoc comments for post-menu component |
| packages/components/src/components/post-menu/post-menu.scss | Updates CSS selector to target renamed part |
| packages/components/src/components/post-language-menu/post-language-menu.scss | Updates CSS selector to target renamed part |
| packages/documentation/src/stories/components/tabs/tabs.stories.ts | Updates Storybook story to reflect renamed parts |
| packages/documentation/.storybook/styles/components/tabs.scss | Updates documentation-specific styling for renamed parts |
| packages/components/cypress/e2e/tabs.cy.ts | Updates E2E tests to reference renamed parts |
| .changeset/purple-carpets-laugh.md | Changeset documenting post-menu breaking changes |
| .changeset/dark-monkeys-shave.md | Changeset documenting post-tabs breaking changes |
Comments suppressed due to low confidence (1)
.changeset/purple-carpets-laugh.md:9
- A changeset entry is missing for the
@swisspost/design-system-eslintpackage. Since a new ESLint rule has been added (stencil-component-part-naming), a changeset should be created for this package with an appropriate version bump (likelyminorsince it's a new feature).
---
'@swisspost/design-system-components': major
'@swisspost/design-system-documentation': patch
---
Renamed `post-menu` parts to avoid naming confusions with other components.
- `::part(menu)` is now `::part(post-menu)`.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📄 Description
This PR enforces a new naming convention requiring all CSS Shadow Parts in Stencil components to use the
post-prefix to prevent naming collisions with third-party styling.Key Changes
🚀 Demo
🔮 Design review
📝 Checklist