Add --preview-file flag

material-extensions · Jul 1, 2024 · a2fb8d7 · a2fb8d7
1 parent b76b878
commit a2fb8d7
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 3 deletions.
diff --git a/src/cli/commands/printHelp.ts b/src/cli/commands/printHelp.ts
@@ -13,6 +13,7 @@ const printHelp = () => {
     --help, -h  Show help
     --silent, -s  Not showing any output
     --version, -v  Show version
+    --previewFile, -p  Specify a custom name for the output file. If not provided, no file will be generated.
     `
   );
 };

diff --git a/src/cli/config/flags.ts b/src/cli/config/flags.ts
@@ -7,6 +7,7 @@ export type CliFlags = {
   debug?: boolean;
   silent?: boolean;
   bigIcon?: boolean;
+  previewFile?: string; // Allows specifying a custom name for the output file using a --preview-file flag
 };
 
 const flags: minimist.Opts | undefined = {
@@ -17,7 +18,10 @@ const flags: minimist.Opts | undefined = {
     'silent',
     'bigIcon',
   ] satisfies (keyof (CliFlags & Config))[],
-  alias: { v: 'version', h: 'help', d: 'debug', s: 'silent', b: 'bigIcon' },
+  string: [
+    'previewFile',
+  ],
+  alias: { v: 'version', h: 'help', d: 'debug', s: 'silent', b: 'bigIcon', p: 'previewFile' },
   unknown: (a) => true,
   default: { lang: 'en' },
   '--': true,

diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -24,6 +24,7 @@ const run = async () => {
     debug: args.debug ?? false,
     silent: args.silent ?? false,
     bigIcon: args.bigIcon ?? false,
+    previewFile: args.previewFile,
   });
 };
 

diff --git a/src/core/generate-preview.ts b/src/core/generate-preview.ts
@@ -9,8 +9,14 @@ import { createScreenshot } from './utils/screenshot';
  * Generates a preview of dark and light theme of SVG icons.
  *
  * @param fileNames List of SVG file names
+ * @param config Configuration including custom name for the output file. If not provided, no file will be generated.
  */
 export const generatePreview = async (fileNames: string[], config: Config) => {
+  if (!config.previewFile) {
+    console.log(red('No output file name provided. Skipping preview generation.'));
+    return;
+  }
+
   const darkTheme = createTheme(
     'dark',
     fileNames.filter((f) => !f.includes('_light')),
@@ -34,7 +40,7 @@ export const generatePreview = async (fileNames: string[], config: Config) => {
   writeFileSync(previewHtmlPath, previewTemplate);
 
   try {
-    await createScreenshot(previewHtmlPath, 'preview');
+    await createScreenshot(previewHtmlPath, config.previewFile);
 
     if (config.silent) return;
     if (config.debug) {
@@ -46,7 +52,7 @@ export const generatePreview = async (fileNames: string[], config: Config) => {
       green(`Successfully created preview image!`)
     );
   } catch (error) {
-    throw Error(red(`Error while creating  preview image`));
+    throw Error(red(`Error while creating preview image`));
   }
 };