@gitlab/ui 87.3.0 → 87.4.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [87.4.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v87.3.1...v87.4.0) (2024-07-30)
+
+
+### Features
+
+* make Tailwind migrations a 2-steps process ([b148f2b](https://gitlab.com/gitlab-org/gitlab-ui/commit/b148f2bae2064f199c285e1d55ec12bc7a651f8d))
+
+## [87.3.1](https://gitlab.com/gitlab-org/gitlab-ui/compare/v87.3.0...v87.3.1) (2024-07-30)
+
+
+### Bug Fixes
+
+* add missing Tailwind equivalent for `gl-flex-shrink-0` ([5e20414](https://gitlab.com/gitlab-org/gitlab-ui/commit/5e20414a18ddd14247862baaf3eedc5390683e82))
+
 # [87.3.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v87.2.1...v87.3.0) (2024-07-30)
 
 

package/bin/migrate_custom_utils_to_tw.bundled.mjs

@@ -183900,6 +183900,7 @@ var tailwindEquivalents = {
   "gl-md-flex-direction-row-reverse": "md:gl-flex-row-reverse",
   "gl-flex-grow-0!": "!gl-grow-0",
   "gl-flex-grow-1": "gl-grow",
+  "gl-flex-shrink-0": "gl-shrink-0",
   "gl-md-flex-grow-0": "md:gl-grow-0",
   "gl-flex-basis-0": "gl-basis-0",
   "gl-flex-basis-quarter": "gl-basis-1/4",
@@ -184330,32 +184331,48 @@ function runMigrations(contents, migrationsToDo) {
 }
 
 // bin/migrate_custom_utils_to_tw.mjs
-function createRewriter(config, migrationsToDo) {
-  const { tailwindConfig, dryRun } = config;
+function isFrontendFile(file) {
+  return file.endsWith(".js") || file.endsWith(".vue");
+}
+function isPositiveAnswer(answer) {
+  const a3 = answer.toLowerCase();
+  return ["y", "yes", ""].includes(a3);
+}
+function createRewriter(dryRun, migrationsToDo) {
   return async function rewrite(file) {
     const contents = await readFile3(file, { encoding: "utf8" });
-    let newContents = runMigrations(contents, migrationsToDo);
+    const newContents = runMigrations(contents, migrationsToDo);
     if (contents === newContents) {
       console.warn(`No changes to ${file}`);
-      return;
+      return false;
     }
     if (dryRun) {
       console.warn(`Would fix up ${file}`);
-      return;
-    }
-    if (file.endsWith(".js") || file.endsWith(".vue")) {
-      const prettierConfig = await resolveConfig(file) || {};
-      newContents = await format22(newContents, {
-        filepath: file,
-        ...prettierConfig,
-        plugins: [dist_exports],
-        tailwindConfig
-      });
+      return false;
     }
     await writeFile2(file, newContents, { encoding: "utf8" });
     console.warn(`Fixed ${file}`);
+    return true;
   };
 }
+async function prettify(tailwindConfig, files) {
+  for (const file of files) {
+    const contents = await readFile3(file, { encoding: "utf8" });
+    const prettierConfig = await resolveConfig(file) || {};
+    const newContents = await format22(contents, {
+      filepath: file,
+      ...prettierConfig,
+      plugins: [dist_exports],
+      tailwindConfig
+    });
+    if (contents === newContents) {
+      console.warn(`${file} did not need to be prettified`);
+    } else {
+      await writeFile2(file, newContents, { encoding: "utf8" });
+      console.warn(`Prettified ${file}`);
+    }
+  }
+}
 function validateMigrations(processedMigrations) {
   const errors = [];
   for (const { from, to: to4 } of processedMigrations) {
@@ -184451,6 +184468,10 @@ function getArgsParser() {
     describe: "Don't actually update files, but print more info",
     type: "boolean",
     default: false
+  }).option("single-step-migration", {
+    describe: "Run the migration in a single step. This means that migrated files are prettified with the Tailwind plugin immediately. Leave this disabled to have a chance to commit migrate files before `prettier-plugin-tailwindcss` re-orders classes.",
+    type: "boolean",
+    default: false
   }).help("help");
 }
 async function main() {
@@ -184469,32 +184490,64 @@ async function main() {
     console.warn("Will do approximately %d class migrations:", migrations.length);
     console.warn(migrations.map((m3) => `	${m3.from} => ${m3.to}`).join("\n"));
   }
-  const rewrite = createRewriter(program, migrations);
+  const rewrite = createRewriter(program.dryRun, migrations);
+  let files = [];
   if (program.fromStdin) {
     console.warn("Reading files from stdin:");
     for await (const file of readline.createInterface({ input: process.stdin })) {
       if (file.trim()) {
-        await rewrite(file);
+        files.push(file);
       }
     }
-    return;
-  }
-  const { pattern, directories, files } = await getFilesAndDirectories(
-    program.directories ?? [],
-    program.dryRun
-  );
-  if (program.dryRun) {
-    console.warn(
-      [`Running on %d files across %d directories`, `(using pattern: %s).`].join("\n"),
-      files.length,
-      directories.length,
-      pattern
+  } else {
+    const filesAndDirectories = await getFilesAndDirectories(
+      program.directories ?? [],
+      program.dryRun
     );
-    console.warn("Directories searched:");
-    console.warn(`	${directories.join("\n	")}`);
+    files = filesAndDirectories.files;
+    const { pattern, directories } = filesAndDirectories;
+    if (program.dryRun) {
+      console.warn(
+        [`Running on %d files across %d directories`, `(using pattern: %s).`].join("\n"),
+        files.length,
+        directories.length,
+        pattern
+      );
+      console.warn("Directories searched:");
+      console.warn(`	${directories.join("\n	")}`);
+    }
   }
+  let migratedFilesCount = 0;
   for (const file of files) {
-    await rewrite(file);
+    if (await rewrite(file)) {
+      migratedFilesCount += 1;
+    }
+  }
+  if (migratedFilesCount === 0) {
+    console.warn("No files needed to be migrated");
+    return;
+  }
+  const filesToBePrettified = files.filter((file) => isFrontendFile(file));
+  if (filesToBePrettified.length === 0) {
+    console.warn("No files to be prettified");
+    return;
+  }
+  if (!program.singleStepMigration) {
+    const rl5 = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout
+    });
+    const answer = await rl5.question(`
+Files have been migrated and will now be prettified.
+Make sure to commit the changes before proceeding if you would like to track
+the diff before CSS classes get re-ordered by the Tailwind Prettier plugin.
+Continue? (Y/n) `);
+    rl5.close();
+    if (isPositiveAnswer(answer)) {
+      await prettify(program.tailwindConfig, filesToBePrettified);
+    }
+  } else {
+    await prettify(program.tailwindConfig, filesToBePrettified);
   }
 }
 main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "87.3.0",
+  "version": "87.4.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",