Skip to content

feat: Add utility class migration script

Lukas 'ai-pi' Eipert requested to merge leipert-add-migration-script into main

What does this MR do?

feat: Add utility class migration script

This adds a migration script for legacy utilities to tailwind utilities.

This was extracted from: gitlab!154442 (merged)

The idea is simple:

  1. We give a list of files via stdin or iterate over all source files in the current directory or in a given list of directories.
  2. We replace legacy utility class names with their tailwind equivalents (list maintained bin/lib/tailwind_equivalents.js). Note, not all legacy utils are mapped, but just the ones currently in use in the GitLab project and other important projects.
  3. You test that the changes have the expected results. Migration strategy for larger projects might be folder by folder or route by route.

Screenshots or screen recordings

N/A

Integration merge requests

Not needed

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 Lukas 'ai-pi' Eipert

Merge request reports