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

Rename any _all.scss files to _index.scss so they work as index files #4960

Closed
4 tasks done
Tracked by #3731
36degrees opened this issue Apr 29, 2024 · 0 comments · Fixed by #4955
Closed
4 tasks done
Tracked by #3731

Rename any _all.scss files to _index.scss so they work as index files #4960

36degrees opened this issue Apr 29, 2024 · 0 comments · Fixed by #4955
Assignees
Milestone

Comments

@36degrees
Copy link
Contributor

36degrees commented Apr 29, 2024

What

Rename the all files that act as entrypoints to each of our Sass layers.

Retain the all files as aliases, but add deprecation warnings when importing via them so we can remove those files in the next major release.

Update any documentation referring to the all files to reference the new index files.

Why

Use index as the entrypoint for each layer as it:

  • matches how we’re structuring the Sass for components
  • allows users to omit ‘index’ from the filename where their Sass compiler supports index files
  • is a small stepping stone towards moving to the Sass module system

Who needs to work on this

Developers

Who needs to review this

Developers, tech writer

Done when

  • We have index files for each of our Sass layer entrypoints
  • We've updated any internal imports to use the new index files
  • We've retained the existing all files as aliases for the index files, and they output warnings when imported
  • We've updated any documentation that refers to the all files to reference the index files instead.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging a pull request may close this issue.

1 participant