feat: add option to rename empty filenames

src/commands/common.ts

@@ -1,33 +1,41 @@
 import { flag, number, option, positional, string } from 'cmd-ts';
+import { ArgParser } from 'cmd-ts/dist/cjs/argparser';
+import { ProvidesHelp } from 'cmd-ts/dist/cjs/helpdoc';
 
-export const errorDirArg = positional({
-  type: string,
-  displayName: 'error_dir',
-  description: 'Failed media will be saved here.',
-});
+type ArgTypes = Record<string, ArgParser<any> & Partial<ProvidesHelp>>;
 
-export const timeoutArg = option({
-  type: number,
-  defaultValue: () => 30000,
-  short: 't',
-  long: 'timeout',
-  description:
-    'Sets the task timeout in milliseconds that will be passed to ExifTool.',
-});
-
-export const forceArg = flag({
-  short: 'f',
-  long: 'force',
-  description: "Forces the operation if the given directories aren't empty.",
-});
-
-export const skipCorrectionsArg = flag({
-  long: 'skip-corrections',
-  description: 'Skips renaming wrong extensions identified by ExifTool.',
-});
-
-export const verboseArg = flag({
-  short: 'v',
-  long: 'verbose',
-  description: 'Enables verbose logging.',
-});
+export const commonArgs = {
+  errorDir: positional({
+    type: string,
+    displayName: 'error_dir',
+    description: 'Failed media will be saved here.',
+  }),
+  force: flag({
+    short: 'f',
+    long: 'force',
+    description: "Forces the operation if the given directories aren't empty.",
+  }),
+  timeout: option({
+    type: number,
+    defaultValue: () => 30000,
+    short: 't',
+    long: 'timeout',
+    description:
+      'Sets the task timeout in milliseconds that will be passed to ExifTool.',
+  }),
+  skipCorrections: flag({
+    long: 'skip-corrections',
+    description: 'Skips renaming wrong extensions identified by ExifTool.',
+  }),
+  verbose: flag({
+    short: 'v',
+    long: 'verbose',
+    description: 'Enables verbose logging.',
+  }),
+  renameEmpty: option({
+    type: string,
+    defaultValue: () => '_',
+    long: 'rename-empty',
+    description: 'Use this name for empty filenames.',
+  }),
+} satisfies ArgTypes;

src/commands/migrate-flat.ts

@@ -4,13 +4,7 @@ import { pathExists } from 'fs-extra';
 import { migrateDirFlatGen } from '../dir/migrate-flat';
 import { isEmptyDir } from '../fs/is-empty-dir';
 import { MediaMigrationError } from '../media/MediaMigrationError';
-import {
-  errorDirArg,
-  forceArg,
-  skipCorrectionsArg,
-  timeoutArg,
-  verboseArg,
-} from './common';
+import { commonArgs } from './common';
 
 export const migrateFlat = command({
   name: 'google-photos-migrate-flat',
@@ -25,18 +19,16 @@ export const migrateFlat = command({
       displayName: 'output_dir',
       description: 'The path to your flat output directory.',
     }),
-    errorDir: errorDirArg,
-    force: forceArg,
-    timeout: timeoutArg,
-    skipCorrections: skipCorrectionsArg,
-    verbose: verboseArg,
+    ...commonArgs,
   },
   handler: async ({
     inputDir,
     outputDir,
     errorDir,
     force,
     timeout,
+    skipCorrections,
+    renameEmpty,
     verbose,
   }) => {
     const errs: string[] = [];
@@ -83,6 +75,8 @@ export const migrateFlat = command({
       verboseLog: verbose ? console.log : undefined,
       exiftool: new ExifTool({ taskTimeoutMillis: timeout }),
       endExifTool: true,
+      skipCorrections,
+      renameEmpty,
     });
     const counts = { err: 0, suc: 0 };
     for await (const result of migGen) {

src/commands/migrate-full.ts

@@ -5,13 +5,7 @@ import { migrateDirFullGen } from '..';
 import { NoPhotosDirError } from '../dir/NoPhotosDirError';
 import { isEmptyDir } from '../fs/is-empty-dir';
 import { MediaMigrationError } from '../media/MediaMigrationError';
-import {
-  errorDirArg,
-  forceArg,
-  skipCorrectionsArg,
-  timeoutArg,
-  verboseArg,
-} from './common';
+import { commonArgs } from './common';
 
 export const migrateFull = command({
   name: 'google-photos-migrate-full',
@@ -26,11 +20,7 @@ export const migrateFull = command({
       displayName: 'output_dir',
       description: 'The path where you want the processed directories to go.',
     }),
-    errorDir: errorDirArg,
-    force: forceArg,
-    timeout: timeoutArg,
-    skipCorrections: skipCorrectionsArg,
-    verbose: verboseArg,
+    ...commonArgs,
   },
   handler: async ({
     inputDir,
@@ -39,6 +29,7 @@ export const migrateFull = command({
     force,
     timeout,
     skipCorrections,
+    renameEmpty,
     verbose,
   }) => {
     const errs: string[] = [];
@@ -78,6 +69,7 @@ export const migrateFull = command({
       exiftool: new ExifTool({ taskTimeoutMillis: timeout }),
       endExifTool: true,
       skipCorrections,
+      renameEmpty,
     });
     const counts = { err: 0, suc: 0 };
     for await (const result of migGen) {

src/dir/migration-args.ts

@@ -10,6 +10,7 @@ export type MigrationArgs = {
   exiftool?: ExifTool;
   endExifTool?: boolean;
   skipCorrections?: boolean;
+  renameEmpty?: string;
   migrationLocks?: Map<string, Promise<string>>;
 };
 
@@ -25,5 +26,6 @@ export async function migrationArgsDefaults(
     warnLog: args.warnLog ?? (() => {}),
     verboseLog: args.verboseLog ?? (() => {}),
     skipCorrections: args.skipCorrections ?? false,
+    renameEmpty: args.renameEmpty ? args.renameEmpty : '_',
   };
 }

src/media/save-to-dir.ts

@@ -44,7 +44,7 @@ export async function saveToDir(
   saveBase = saveBase ?? basename(file);
   let sanitized = sanitize(saveBase, { replacement: '_' });
   if (sanitized === '') {
-    sanitized = '_';
+    sanitized = migCtx.renameEmpty;
   }
   if (saveBase != sanitized) {
     migCtx.warnLog(`Sanitized file: ${file}` + ` (New filename: ${sanitized})`);