Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BREAKING-CHANGE: Renamed variables-scss to tokens-exporter and add assets-exporter #DS-1483 #1695

Merged
merged 2 commits into from
Oct 17, 2024

Conversation

curdaj
Copy link
Contributor

@curdaj curdaj commented Oct 10, 2024

Description

Additional context

Issue reference

@github-actions github-actions bot added the BC Breaking change label Oct 10, 2024
Copy link

netlify bot commented Oct 10, 2024

Deploy Preview for spirit-design-system ready!

Name Link
🔨 Latest commit 6db0f52
🔍 Latest deploy log https://app.netlify.com/sites/spirit-design-system/deploys/6710d14f53f67900080c4f8a
😎 Deploy Preview https://deploy-preview-1695--spirit-design-system.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 96 (🟢 up 1 from production)
Accessibility: 93 (no change from production)
Best Practices: 100 (no change from production)
SEO: 82 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Oct 10, 2024

Deploy Preview for spirit-design-system-storybook canceled.

Name Link
🔨 Latest commit 6db0f52
🔍 Latest deploy log https://app.netlify.com/sites/spirit-design-system-storybook/deploys/6710d14f6bdaf50008ae1d82

.commitlintrc.mjs Outdated Show resolved Hide resolved
.eslintrc.js Outdated Show resolved Hide resolved
.prettierignore Outdated Show resolved Hide resolved
@literat
Copy link
Collaborator

literat commented Oct 14, 2024

I suggest use only tokens for directory name. So the structure will be exporters/tokens. Clean and short. We do not use the spirit- prefix for any package directory, so here we should apply the same rule. :-)

@pavelklibani pavelklibani force-pushed the bc/ds-1483-change-exporter-name branch from 4e3c92d to 1e60b71 Compare October 15, 2024 12:37
@pavelklibani
Copy link
Contributor

pavelklibani commented Oct 15, 2024

I suggest use only tokens for directory name. So the structure will be exporters/tokens. Clean and short. We do not use the spirit- prefix for any package directory, so here we should apply the same rule. :-)

Agree that tokens is better

@pavelklibani
Copy link
Contributor

rebased with main (fixed supernova bug - updated versions etc.)

@pavelklibani pavelklibani marked this pull request as ready for review October 15, 2024 13:22
@pavelklibani pavelklibani requested a review from literat October 15, 2024 13:23
@curdaj curdaj force-pushed the bc/ds-1483-change-exporter-name branch 2 times, most recently from d03587d to 653172a Compare October 16, 2024 09:38
Copy link
Collaborator

@literat literat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great Job. It is looking good. I have made a few nice-to-have suggestions.

Also, it comes to mind that it might be appropriate to deprecate the svg, js, and scss exporters. I mean like write some sentence into the exporters readmes: This exporter is deprecated. Use ... instead. And link to the new exporter code.
I know that is under our control, but for history's sake :-) Thanks.

exporters/assets/exporter.json Outdated Show resolved Hide resolved
exporters/assets/exporter.json Outdated Show resolved Hide resolved
exporters/assets/exporter.json Outdated Show resolved Hide resolved
exporters/tokens/exporter.json Outdated Show resolved Hide resolved
exporters/tokens/exporter.json Outdated Show resolved Hide resolved
@crishpeen
Copy link
Member

crishpeen commented Oct 17, 2024

Great Job. It is looking good. I have made a few nice-to-have suggestions.

Also, it comes to mind that it might be appropriate to deprecate the svg, js, and scss exporters. I mean like write some sentence into the exporters readmes: This exporter is deprecated. Use ... instead. And link to the new exporter code. I know that is under our control, but for history's sake :-) Thanks.

I don't think so we want to deprecate these exporters in main yet. We do not offer an alternative and teams need them.

We can do this when we merge v3 (or we can deprecate it in the integration branch). @literat

Copy link
Member

@crishpeen crishpeen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the commit message scope in the first commit.

exporters/assets/exporter.json Outdated Show resolved Hide resolved
exporters/assets/src/asset_path.pr Outdated Show resolved Hide resolved
exporters/tokens/package.json Outdated Show resolved Hide resolved
@curdaj curdaj force-pushed the bc/ds-1483-change-exporter-name branch from 653172a to 35d66d5 Compare October 17, 2024 08:53
curdaj and others added 2 commits October 17, 2024 10:56
- preparation for renaming the svg exporter to assets exporter in the future
@curdaj curdaj force-pushed the bc/ds-1483-change-exporter-name branch from 35d66d5 to 6db0f52 Compare October 17, 2024 08:56
@curdaj curdaj requested a review from crishpeen October 17, 2024 09:10
Copy link
Collaborator

@literat literat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@curdaj curdaj changed the title BREAKING-CHANGE: Renamed variables-scss to spirit-tokens-exporter and add spirit-assets-exporter #DS-1483 BREAKING-CHANGE: Renamed variables-scss to tokens-exporter and add assets-exporter #DS-1483 Oct 17, 2024
@curdaj curdaj merged commit 771d2cd into main Oct 17, 2024
20 checks passed
@curdaj curdaj deleted the bc/ds-1483-change-exporter-name branch October 17, 2024 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BC Breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants