Reformat code

README.md

@@ -2,4 +2,12 @@
 
 ![npm (scoped)](https://img.shields.io/npm/v/@nplayfair/npe_gerber)
 
-Requires node version 10 or higher
+Requires node version 10 or higher
+
+Image processing configuration example:
+
+const config = {
+  resizeWidth: 600,
+  density: 1000,
+  compLevel: 1,
+}

fileProcessor.js

@@ -1,84 +0,0 @@
-const StreamZip = require('node-stream-zip');
-const fs = require('fs-extra');
-const path = require('path');
-
-// Filenames we need to extract from the archive
-const gerberFiles = [
-  'CAMOutputs/DrillFiles/drills.xln',
-  'CAMOutputs/GerberFiles/copper_top.gbr',
-  'CAMOutputs/GerberFiles/silkscreen_top.gbr',
-  'CAMOutputs/GerberFiles/soldermask_top.gbr',
-  'CAMOutputs/GerberFiles/solderpaste_top.gbr',
-  'CAMOutputs/GerberFiles/profile.gbr'
-]
-
-/**
- * Extracts the passed in zip file
- * @param {string} fileName
- * @returns {Promise} Promise object represents number of files extracted
- */
-async function extractArchive(fileName) {
-  // Configure archive to use
-  const archive =  new StreamZip({
-    file: fileName,
-    storeEntries: true
-  });
-  return new Promise((resolve, reject) => {
-    // Try to extract
-    archive.on('ready', () => {
-      let extDir = path.join(__dirname, 'gerber', 'tmp', 'archive');
-      fs.mkdirSync(extDir, { recursive: true });
-      archive.extract(null, extDir, (err, count) => {
-        if(!err) {
-          archive.close();
-          resolve(count);
-        } else {
-          const errMsg = 'Error extracting archive';
-          console.err(errMsg);
-          archive.close();
-          reject(errMsg)
-        }
-      })
-    })
-  })
-}
-
-async function getLayers(fileName) {
-  return new Promise((resolve, reject) => {
-    const tempDir = path.join(__dirname, 'gerber', 'tmp', 'archive');
-    extractArchive(fileName)
-      .then(numfiles => {
-        console.log(`${numfiles} files extracted successfully`);
-        const layers = gerberFiles.map(fileName => ({
-          filename: fileName,
-          gerber: fs.createReadStream(path.join(tempDir, fileName))
-        }));
-        if(numfiles > 0) {
-          // Some files were extracted
-          resolve(layers);
-        } else {
-          const errMsg = 'No files were extracted';
-          reject(errMsg);
-        }
-      })
-      .catch(e => {
-        console.log(e);
-      })
-  })
-}
-
-function cleanupFiles() {
-  try {
-    let folder = path.join(__dirname, 'gerber', 'tmp');
-    fs.emptyDirSync(folder);
-    console.log('Temp files removed.');
-  } catch (err) {
-    console.error(err);
-  }
-}
-
-module.exports = {
-  extractArchive,
-  getLayers,
-  cleanupFiles
-}

index.js

@@ -1,46 +1,162 @@
+const StreamZip = require('node-stream-zip');
+const fs = require('fs-extra');
+const path = require('path');
 const pcbStackup  = require('pcb-stackup');
-const sharp       = require('sharp');
+const sharp = require('sharp');
-const path        = require('path');
-const fileProc    = require('./fileProcessor.js');
 
-// Configuration
+// Filenames we need to extract from the archive
-const config = {
+const gerberFiles = [
-  resizeWidth: 600,
+  'CAMOutputs/DrillFiles/drills.xln',
-  density: 1000,
+  'CAMOutputs/GerberFiles/copper_top.gbr',
-  compLevel: 1,
+  'CAMOutputs/GerberFiles/silkscreen_top.gbr',
+  'CAMOutputs/GerberFiles/soldermask_top.gbr',
+  'CAMOutputs/GerberFiles/solderpaste_top.gbr',
+  'CAMOutputs/GerberFiles/profile.gbr'
+]
+
+/**
+ * Configures the folders used
+ * @param {Object} folderConfig Object with properties tmpDir and imgDir containing paths to temporary and image output folders
+ */
+function config(folderConfig) {
+  // Create tmpDir if it does not exist
+  fs.ensureDirSync(folderConfig.tmpDir);
+  // Create imgDir if it does not exist
+  fs.ensureDirSync(folderConfig.imgDir);
 }
 
-// Functions
+/**
-async function gerberToImage(gerber, imageName) {
+ * Handle errors, log to console and return the error object
+ * @param {Object} Error object
+ * @returns {Object} Error object
+ */
+function handleError(e) {
+  // Clean up temp files
+  // cleanupFiles();
+  console.error(e);
+  return e;
+}
+
+/**
+ * Extracts the passed in zip file
+ * @param {string} fileName Name of the file to be extracted
+ * @param {string} tmpDir Temporary directory to extract to
+ * @returns {Promise} Promise object represents number of files extracted
+ */
+function extractArchive(fileName, tmpDir) {
+  // Configure archive to use
+  const archive =  new StreamZip({
+    file: fileName,
+    storeEntries: true
+  });
   return new Promise((resolve, reject) => {
-    const destFile = path.join(__dirname, 'gerber', 'pcb', imageName);
+    // Try to extract
-    fileProc.getLayers(gerber)
+    archive.on('ready', () => {
-      .then(layers => {
+      let extDir = path.join(tmpDir, 'archive');
-        pcbStackup(layers).then(stackup => {
+      fs.mkdirSync(extDir, { recursive: true });
-          // Create buffer from SVG string
+      archive.extract(null, extDir, (err, count) => {
-          sharp(Buffer.from(stackup.top.svg), { density: config.density })
+        if(!err) {
-          .resize({ width: config.resizeWidth })
+          archive.close();
-          .png({ 
+          resolve(count);
-            compressionLevel: config.compLevel })
+        } else {
-          .toFile(destFile)
+          const errMsg = 'Error extracting archive';
-          .then((info) => {
+          console.err(errMsg);
-            // Succesful
+          archive.close();
-            fileProc.cleanupFiles();
+          reject(errMsg)
-            resolve(info);
+        }
-          })
+      })
-          .catch((e) => {
-            fileProc.cleanupFiles();
-            reject(e);
-          })
-        })
-      .catch((e) => {
-        reject(e);
-      });
     })
   })
 }
 
-gerberToImage('./gerber/Timmy.zip', 'timmy.png').then(info => console.log(info))
+/**
-  .catch(e => {
+ * Take in a zip file and return an array of the layers files
-    console.error(e);
+ * @param {string} fileName Name of the file to be extracted
+ * @param {string} tmpDir Temporary directory to extract to
+ * @returns {Array} Array of paths to the layers files
+ */
+function getLayers(fileName, tmpDir) {
+  return new Promise((resolve, reject) => {
+    const extractDir = path.join(tmpDir, 'archive');
+    extractArchive(fileName, tmpDir)
+      .then(numfiles => {
+        console.log(`${numfiles} files extracted successfully`);
+        const layers = gerberFiles.map(fileName => ({
+          filename: fileName,
+          gerber: fs.createReadStream(path.join(extractDir, fileName))
+        }));
+        if(numfiles > 0) {
+          // Some files were extracted
+          resolve(layers);
+        } else {
+          const errMsg = 'No files were extracted';
+          reject(errMsg);
+        }
+      })
+      .catch(e => {
+        console.log(e);
+      })
   })
+}
+
+/**
+ * Clean up the archive folder in the specified directory
+ * @param {string} dir Path to a directory to clean up
+ */
+function cleanupFiles(dir) {
+  try {
+    let folder = path.join(dir, 'archive');
+    fs.emptyDirSync(folder);
+    console.log('Temp files removed.');
+  } catch (err) {
+    console.error(err);
+  }
+}
+
+/**
+ * Take an archive containing gerber files, config object, temporary dir 
+ * and output dir and create a PNG image from the gerber in the output dir
+ * @param {string} gerber Path to an archive file containing gerber
+ * @param {Object} config Object containing sharp settings for resizeWidth, compLevel and density
+ * @param {string} tmpDir Temporary directory to extract the archive to
+ * @param {string} outputDir Directory to save the image to
+ */
+function gerberToImage(gerber, config, tmpDir, outputDir) {
+  // Set filenames
+  const imageName = path.basename(gerber, '.zip');
+  const destFile = path.join(outputDir, imageName) + '.png';
+
+  // Make sure output dir exists
+  try {
+    fs.ensureDirSync(outputDir);
+  } 
+  catch (e) {
+    console.error(e)
+  }
+
+  return new Promise((resolve, reject) => {
+    getLayers(gerber, tmpDir)
+      .then(pcbStackup)
+      .then(stackup => {
+        sharp(Buffer.from(stackup.top.svg), { density: config.density })
+        .resize({ width: config.resizeWidth })
+        .png({ 
+          compressionLevel: config.compLevel })
+        .toFile(destFile)
+      })
+      .then(() => {
+        cleanupFiles(tmpDir);
+        resolve(destFile);
+      })
+      .catch((e) => {
+        cleanupFiles(tmpDir)
+        handleError(e);
+        reject(e);
+      })
+  });
+}
+
+module.exports = {
+  config,
+  gerberToImage
+}