Add option to pad order in fileName with zeros in addMigration

src/commands/migrations/add/add.ts

@@ -20,7 +20,8 @@ export const register: RegisterCommand = yargs =>
         .option("migrationsFolder", {
           alias: "m",
           type: "string",
-          describe: "Specifies the path to the folder where the migration should be stored.",
+          describe:
+            "Specifies the path to the folder where the migration should be stored. Defaults to the current working directory.",
         })
         .option("type", {
           alias: "t",
@@ -41,6 +42,12 @@ export const register: RegisterCommand = yargs =>
           describe: "Sets the order property to the provided value.",
           type: "number",
           conflicts: ["timestamp"],
+        })
+        .option("padWithLeadingZeros", {
+          describe: "Specifies the number of leading zeros for the order number in the migration file name.",
+          type: "number",
+          conflicts: ["timestamp"],
+          implies: "order",
         }),
     handler: args => addMigrationCli(args).catch(simplifyErrors),
   });
@@ -51,6 +58,7 @@ type AddMigrationCliParams =
     migrationsFolder: string | undefined;
     timestamp: boolean | undefined;
     order: number | undefined;
+    padWithLeadingZeros: number | undefined;
     type: string;
   }>
   & LogOptions;
@@ -69,8 +77,18 @@ const resolveParams = (args: AddMigrationCliParams): AddMigrationParams => {
     throw new Error(`Invalid type '${args.type}'. Allowed values are 'ts' (TypeScript) or 'js' (JavaScript).`);
   }
 
+  const orderParams = {
+    timestamp: args.timestamp,
+    order: args.order,
+    padWithLeadingZeros: args.padWithLeadingZeros,
+  } as
+    | { timestamp: true }
+    | { timestamp: false | undefined; order: number }
+    | { timestamp: false | undefined; order: number; padWithLeadingZeros: number | undefined };
+
   return {
     ...args,
     type: args.type as "ts" | "js",
+    ...orderParams,
   };
 };

src/modules/migrations/add.ts

@@ -5,20 +5,15 @@ import * as path from "path";
 import { logInfo, LogOptions } from "../../log.js";
 import { handleErr } from "./utils/errUtils.js";
 import { createFolder, saveFile } from "./utils/fileUtils.js";
-import {
-  formatDateForFileName,
-  generateJavascriptMigration,
-  generateTypescriptMigration,
-  getMigrationName,
-} from "./utils/migrationUtils.js";
+import { generateJavascriptMigration, generateTypescriptMigration, getMigrationName } from "./utils/migrationUtils.js";
 
 export type AddMigrationParams = Readonly<
   & {
     name: string;
     migrationsFolder?: string;
     type: "js" | "ts";
   }
-  & ({ timestamp: true } | { timestamp?: false; order?: number })
+  & TimestampOrOrderParams
   & LogOptions
 >;
 
@@ -38,7 +33,11 @@ export const addMigration = async (params: AddMigrationParams) => {
   const migrationName = getMigrationName(
     params.name,
     params.type,
-    params.timestamp ? formatDateForFileName(currentDate) : undefined,
+    params.timestamp
+      ? currentDate
+      : params.order === undefined
+      ? undefined
+      : padWithLeadingZeros(params.order, params.padWithLeadingZeros),
   );
   const migrationData = params.type === "ts"
     ? generateTypescriptMigration(params.timestamp ? currentDate : params.order)
@@ -55,3 +54,16 @@ export const addMigration = async (params: AddMigrationParams) => {
     `Migration ${migrationName} has been created sucessfully in ${chalk.blue(saveMigrationPath)}`,
   );
 };
+
+const padWithLeadingZeros = (order: number, numberOfZeros: number | undefined) =>
+  numberOfZeros
+    ? order.toString().padStart(numberOfZeros, "0")
+    : order.toString();
+
+type TimestampOrOrderParams =
+  | Readonly<{ timestamp: true }>
+  | Readonly<{ timestamp?: false } & OrderParams>;
+
+type OrderParams =
+  | Readonly<{ order: number; padWithLeadingZeros?: number }>
+  | Readonly<{ order?: never }>;

src/modules/migrations/utils/migrationUtils.ts

@@ -23,7 +23,8 @@ export const formatDateForFileName = (date: Date) =>
   + `${("0" + date.getUTCMinutes()).slice(-2)}-`
   + `${("0" + date.getUTCSeconds()).slice(-2)}-`;
 
-export const getMigrationName = (name: string, type: "js" | "ts", prefix?: string) => `${prefix ?? ""}${name}.${type}`;
+export const getMigrationName = (name: string, type: "js" | "ts", prefix: Date | string | undefined) =>
+  `${prefix instanceof Date ? formatDateForFileName(prefix) : prefix ?? ""}${name}.${type}`;
 
 export const generateTypescriptMigration = (order: Date | number | undefined): string =>
   `import { MigrationModule } from "@kontent-ai/data-ops";