Skip to content

feat: make Tailwind migrations a 2-steps process

Paul Gascou-Vaillancourt requested to merge two-steps-tailwind-migration into main

What does this MR do?

feat: make Tailwind migrations a 2-steps process

Updates the Tailwind migration script so that Prettier can be run after the migrations. This gives us a chance to commit the changes right after the migrations and before the CSS utils get re-ordered, which might make diffs confusing.

How to test this?

  • Ensure you have some files with unordered legacy utils. For example, apply the following patch to src/components/base/card/card.vue:

    diff --git a/src/components/base/card/card.vue b/src/components/base/card/card.vue
    index f0a3d9ec7..8d8142fb6 100644
    --- a/src/components/base/card/card.vue
    +++ b/src/components/base/card/card.vue
    @@ -33,11 +33,7 @@ export default {
     
     <template>
       <div class="gl-card">
    -    <div
    -      v-if="$scopedSlots.header"
    -      class="gl-card-header gl-flex sm:gl-hidden"
    -      :class="headerClass"
    -    >
    +    <div v-if="$scopedSlots.header" class="gl-card-header gl-sm-display-none gl-display-flex" :class="headerClass">
           <!-- @slot The card's header content. -->
           <slot name="header"></slot>
         </div>
  • Run the script against some directories that need migrating and that contain frontend files. Eg:

    bin/migrate_custom_utils_to_tw.mjs --directories src/components/base/card/
    • The script should hang once the utils have been migrated, at which point you can commit the changes.
  • Resume the script's execution by typing Enter

    • The files should now be prettified.

Screenshots or screen recordings

2_steps_script

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 Paul Gascou-Vaillancourt

Merge request reports

Loading