Skip to content

chore(CSS Utils): update utility class deprecation script

What does this MR do?

Related to &10980

Using logic from https://gitlab.com/peterhegman/tailwind-and-gitlab-ui-utility-class-compare this MR updates the script we will be using to migrate to Tailwind CSS. This is how the updated script works:

  1. Generate all Tailwind utility classes and store them in a temp directory
  2. Generate all the GitLab UI utility classes
  3. Filter GitLab UI utility classes by a specific SCSS file (e.g src/scss/utility-mixins/position.scss)
  4. Loop through the GitLab UI utility classes
    • If the name and the rules of the utility class match Tailwind
      • If it is an !important utility mark it as matched and !important
      • If it is a stateful utility (hover, focus, or active) mark it as matched and stateful
      • Otherwise mark it as a matched regular utility
    • Otherwise mark it as not matched
  5. Loop through the not matched utility classes and rename them to gl-deprecated-* in gitlab-org/gitlab and gitlab-org/gitlab-ui
  6. Loop through the matched !important utilities and move the ! to the front in gitlab-org/gitlab to match Tailwind format
  7. Loop through the matched stateful utilities and move the stateful modifier to the front (e.g. hover:gl-text-gray-900) in gitlab-org/gitlab to match Tailwind format
  8. Loop through the matched regular utility classes and remove them from the corresponding SCSS file (e.g src/scss/utility-mixins/position.scss)

How to test locally

Run yarn deprecate-gl-utils <name of scss file to process> <path to gitlab-development-kit/gitlab>

Screenshots or screen recordings

Example output when running the script with src/scss/utility-mixins/color.scss.

Screenshot_2024-02-15_at_2.14.29_PM

Integration merge requests

Does this MR meet the acceptance criteria?

This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.

Toggle the acceptance checklist

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidelines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened (see integration merge requests above).
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Peter Hegman

Merge request reports