freecad-preview-extractor 0.1.0 → 0.1.2

package/README.md

@@ -15,11 +15,17 @@ Preview is extracted for each `FILENAME.FCStd` file as `FILENAME-preview.png`
 - **Ignore patterns**: Use an ignore config file (like `.gitignore`) to exclude specific files from batch processing
 
 ## Installation
+
+Install globally:
+
 ```bash
-git clone https://github.com/andruhon/freecad-preview-extractor.git
-cd ./freecad-preview-extractor
-npm ci
-sudo npm install -g ./
+npm install -g freecad-preview-extractor
+```
+
+Or run directly with npx:
+
+```bash
+npx freecad-preview-extractor
 ```
 
 ## Usage
@@ -42,7 +48,7 @@ fcxtc filename.FCStd
 
 ### Generate preview with FreeCAD before extraction (requires FreeCAD and desktop environment)
 
-Adding `--fit` argument will trigger `src/isofit.FCMacro` FreeCAD macros for each file,
+Adding `--fit` argument will trigger `src/isometric-fit.FCMacro` FreeCAD macros for each file,
 the macros sets model to the isometric view, does "fit into view", and saves the file.
 
 ```bash
@@ -74,7 +80,7 @@ test-model.FCStd
 
 The `--fit` option will:
 1. Open each FreeCAD file with FreeCAD
-2. Run the `isofit.FCMacro` macro to set Isometric View and Fit All
+2. Run the `isometric-fit.FCMacro` macro to set Isometric View and Fit All
 3. Save the file with the updated preview
 4. Extract the preview image as usual
 
@@ -129,13 +135,24 @@ The project exports utility functions that can be used programmatically:
 - `filterIgnoredFiles(filePaths, rootDir, patterns, enabled)` - Filter files based on patterns
 - `shouldIgnoreFile(filePath, rootDir, patterns, enabled)` - Check if a single file should be ignored
 
+## Development
+
+To set up the project for development:
+
+```bash
+git clone https://github.com/andruhon/freecad-preview-extractor.git
+cd ./freecad-preview-extractor
+npm ci
+sudo npm install -g ./
+```
+
 ## Project Files
 
 Key files of the project (not including all files):
 
 - `src/index.js` - Main CLI entry point
 - `src/extract-png-from-fcstd.js` - Thumbnail extraction logic
-- `src/isofit.FCMacro` - FreeCAD macro for isometric view and fit (used by `--fit` option)
+- `src/isometric-fit.FCMacro` - FreeCAD macro for isometric view and fit (used by `--fit` option)
 - `tests/` - Unit tests for ignore functionality
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "freecad-preview-extractor",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Script extracting freecad previews",
   "keywords": [
     "FreeCAD"

package/src/extract-png-from-fcstd.js

@@ -87,9 +87,10 @@ export async function extractThumbnailFromFCStd(zipFilePath, outputPath) {
 /**
  * Process a single .FCStd file to extract its preview
  * @param {string} filePath - Path to the .FCStd file
+ * @param {string} [customOutputPath] - Optional custom path for the output PNG
  * @returns {Promise<boolean>} True if processing was successful
  */
-export async function processSingleFile(filePath) {
+export async function processSingleFile(filePath, customOutputPath = null) {
   try {
     // Verify file exists
     if (!fs.existsSync(filePath)) {
@@ -107,7 +108,7 @@ export async function processSingleFile(filePath) {
     // Prepare output path - same directory, same name but with .png extension
     const dir = path.dirname(filePath);
     const baseName = path.basename(filePath, path.extname(filePath));
-    const pngPath = path.join(dir, `${baseName}-preview.png`);
+    const pngPath = customOutputPath || path.join(dir, `${baseName}-preview.png`);
     
     // Try to extract thumbnail from the file
     await extractThumbnailFromFCStd(filePath, pngPath);

package/src/fit-utils.js

@@ -0,0 +1,47 @@
+import path from "path";
+import { fileURLToPath } from "url";
+import { spawn } from "child_process";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// Run FreeCAD with isometric fit macro to generate preview
+async function runFreeCADIsometricFit(fcstdFile) {
+  const macroPath = path.join(__dirname, "isometric-fit.FCMacro");
+
+  return new Promise((resolve, reject) => {
+    console.log(
+      `🔧 Running FreeCAD with Isometric, Fit All macro on ${fcstdFile}...`,
+    );
+
+    const freecad = spawn("freecad", [fcstdFile, macroPath]);
+
+    freecad.stdout.on("data", (data) => {
+      // Log FreeCAD output if needed for debugging
+      // console.log(`FreeCAD: ${data}`);
+    });
+
+    freecad.stderr.on("data", (data) => {
+      // Log errors but don't fail immediately
+      // console.error(`FreeCAD stderr: ${data}`);
+    });
+
+    freecad.on("close", (code) => {
+      if (code === 0) {
+        console.log(`✅ FreeCAD processing complete for ${fcstdFile}`);
+        resolve();
+      } else {
+        reject(new Error(`FreeCAD exited with code ${code}`));
+      }
+    });
+
+    freecad.on("error", (err) => {
+      reject(
+        new Error(
+          `Failed to start FreeCAD: ${err.message}. Make sure FreeCAD is installed and available in PATH.`,
+        ),
+      );
+    });
+  });
+}
+
+export { runFreeCADIsometricFit };

package/src/index.js

@@ -8,7 +8,8 @@ import {
   extractThumbnailFromFCStd,
 } from "./extract-png-from-fcstd.js";
 import { loadIgnoreConfig, filterIgnoredFiles } from "./ignore-utils.js";
-import { readFileSync } from "fs";
+import { runFreeCADIsometricFit } from "./fit-utils.js";
+import fs from "fs";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
@@ -17,46 +18,6 @@ function getRootDir(cwd = process.cwd()) {
   return cwd;
 }
 
-// Run FreeCAD with isofit macro to generate preview
-async function runFreeCADIsofit(fcstdFile) {
-  const macroPath = path.join(__dirname, "isofit.FCMacro");
-
-  return new Promise((resolve, reject) => {
-    console.log(
-      `🔧 Running FreeCAD with Isometric, Fit All macro on ${fcstdFile}...`,
-    );
-
-    const freecad = spawn("freecad", [fcstdFile, macroPath]);
-
-    freecad.stdout.on("data", (data) => {
-      // Log FreeCAD output if needed for debugging
-      // console.log(`FreeCAD: ${data}`);
-    });
-
-    freecad.stderr.on("data", (data) => {
-      // Log errors but don't fail immediately
-      // console.error(`FreeCAD stderr: ${data}`);
-    });
-
-    freecad.on("close", (code) => {
-      if (code === 0) {
-        console.log(`✅ FreeCAD processing complete for ${fcstdFile}`);
-        resolve();
-      } else {
-        reject(new Error(`FreeCAD exited with code ${code}`));
-      }
-    });
-
-    freecad.on("error", (err) => {
-      reject(
-        new Error(
-          `Failed to start FreeCAD: ${err.message}. Make sure FreeCAD is installed and available in PATH.`,
-        ),
-      );
-    });
-  });
-}
-
 // Process all .FCStd files in current directory and subdirectories
 async function processAllFiles(runFit = false, ignoreConfig = null) {
   try {
@@ -95,10 +56,21 @@ async function processAllFiles(runFit = false, ignoreConfig = null) {
     let failureCount = 0;
 
     for (const file of fcstdFiles) {
+      let fileToProcess = file;
+      let tempFile = null;
+
       try {
-        // If --fit flag is set, run FreeCAD with isofit macro first
+        // If --fit flag is set, run FreeCAD with isometric-fit macro first
         if (runFit) {
-          await runFreeCADIsofit(file);
+          const ext = path.extname(file);
+          const dir = path.dirname(file);
+          const baseName = path.basename(file, ext);
+          tempFile = path.join(dir, `${baseName}_temp_${Date.now()}${ext}`);
+
+          fs.copyFileSync(file, tempFile);
+          fileToProcess = tempFile;
+
+          await runFreeCADIsometricFit(fileToProcess);
         }
 
         // Prepare output path - same directory, same name but with .png extension
@@ -107,11 +79,20 @@ async function processAllFiles(runFit = false, ignoreConfig = null) {
         const pngPath = path.join(dir, `${baseName}-preview.png`);
 
         // Try to extract thumbnail from the file
-        await extractThumbnailFromFCStd(file, pngPath);
+        await extractThumbnailFromFCStd(fileToProcess, pngPath);
         successCount++;
       } catch (err) {
         console.log(`❌ Error processing ${file}: ${err.message}`);
         failureCount++;
+      } finally {
+        // Clean up temp file
+        if (tempFile && fs.existsSync(tempFile)) {
+          try {
+            fs.unlinkSync(tempFile);
+          } catch (e) {
+            console.log(`⚠️ Could not delete temp file ${tempFile}: ${e.message}`);
+          }
+        }
       }
       processedCount++;
       console.log(`📊 Progress: ${processedCount}/${fcstdFiles.length} (${successCount} succeeded, ${failureCount} failed)`);
@@ -136,7 +117,7 @@ async function main() {
 
   // Check for --version or --help flags
   if (args.includes("--version") || args.includes("-v")) {
-    const pkg = JSON.parse(readFileSync(new URL("../package.json", import.meta.url)));
+    const pkg = JSON.parse(fs.readFileSync(new URL("../package.json", import.meta.url)));
     console.log(pkg.version);
     process.exit(0);
   }
@@ -184,7 +165,7 @@ Examples:
     // No arguments - process all files
     if (runFit) {
       console.log(
-        "🔍 Running FreeCAD isofit and extracting images from all FreeCAD files in current directory...",
+        "🔍 Running FreeCAD isometric-fit and extracting images from all FreeCAD files in current directory...",
       );
     } else {
       console.log(
@@ -201,19 +182,47 @@ Examples:
   } else {
     // Process specific file(s)
     const file = fileArgs[0];
+    let fileToProcess = file;
+    let tempFile = null;
+    let customOutputPath = null;
+
+    try {
+      // For single file mode, ignore config is not applied
+      if (runFit) {
+        const ext = path.extname(file);
+        const dir = path.dirname(file);
+        const baseName = path.basename(file, ext);
+        tempFile = path.join(dir, `${baseName}_temp_${Date.now()}${ext}`);
 
-    // For single file mode, ignore config is not applied
-    if (runFit) {
-      console.log(`🔧 Running FreeCAD isofit on: ${file}`);
-      await runFreeCADIsofit(file);
-    }
+        fs.copyFileSync(file, tempFile);
+        fileToProcess = tempFile;
+        
+        // Set output path based on original file
+        customOutputPath = path.join(dir, `${baseName}-preview.png`);
 
-    console.log(`🔍 Extracting image from: ${file}`);
-    await processSingleFile(file);
+        console.log(`🔧 Running FreeCAD isometric-fit on temp file: ${path.basename(tempFile)}`);
+        await runFreeCADIsometricFit(fileToProcess);
+      }
+
+      console.log(`🔍 Extracting image from: ${fileToProcess}`);
+      await processSingleFile(fileToProcess, customOutputPath);
+    } catch (err) {
+      console.error(`❌ Error processing ${file}:`, err);
+      process.exitCode = 1;
+    } finally {
+      // Clean up temp file
+      if (tempFile && fs.existsSync(tempFile)) {
+        try {
+          fs.unlinkSync(tempFile);
+        } catch (e) {
+          console.warn(`⚠️ Failed to delete temp file: ${e.message}`);
+        }
+      }
+    }
   }
 }
 
-export { processAllFiles, runFreeCADIsofit };
+export { processAllFiles };
 export { loadIgnoreConfig, filterIgnoredFiles } from "./ignore-utils.js";
 
 // Run the script

package/src/{isofit.FCMacro → isometric-fit.FCMacro}

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Macro Begin: isofit.FCMacro +++++++++++++++++++++++++++++++++++++++++++++++++
+# Macro Begin: isometric-fit.FCMacro +++++++++++++++++++++++++++++++++++++++++++++++++
 import FreeCAD
 
 try:
@@ -12,7 +12,7 @@ try:
     Gui.SendMsgToActiveView("Save")
     Gui.getMainWindow().close()
 except Exception as e:
-    print("Error in isofit macro: {}".format(e))
+    print("Error in isometric-fit macro: {}".format(e))
     Gui.getMainWindow().close()
 
-# Macro End: isofit.FCMacro +++++++++++++++++++++++++++++++++++++++++++++++++
+# Macro End: isometric-fit.FCMacro +++++++++++++++++++++++++++++++++++++++++++++++++