Initial Code commit

README.md

@@ -1,3 +1,31 @@
 # web-helper
+A collection of little node.js scripts, I have created over the time. Hopefully this helps you.
+I try to comment the code as much as possible, if you have any questions or suggestions, feel free to leave a comment here in the issue section and I try to answer as much as possible.
 
-A collection of node.js scripts to help on every day webdev problems
+## [1. Image Helpers](https://projects.nisch.codes/nischcodes/web-helper/src/branch/main/image)
+A collection of utilities and helper utilities to work with images.<br />
+[Go to Image Helpers](https://projects.nisch.codes/nischcodes/web-helper/src/branch/main/image)
+
+### [1.1 Compare Images Helper](https://projects.nisch.codes/nischcodes/web-helper/src/branch/main/image/compare)
+This is a little tool to compare images in two different folders, to determine if they are the same or not.<br />
+[Go to Compare Images Helper](https://projects.nisch.codes/nischcodes/web-helper/src/branch/main/image/compare)
+
+### [1.2 Create Placeholder Helper (Simple Version)](https://projects.nisch.codes/nischcodes/web-helper/src/branch/main/image/create-placeholder-simple)
+This is a little tool, which copies a placeholder image for an array of strings containing the new filename. This is the simple version with no other dependencies, there is also an advanced version using an excel file.<br />
+[Go to Create Placeholder Helper (Simple Version)](https://projects.nisch.codes/nischcodes/web-helper/src/branch/main/image/create-placeholder-simple)
+
+<br />
+<br />
+<br />
+
+# FAQ
+The following questions are some of the most common questions and I wanted to provide some explaination before hand.
+
+## 1. Why do most tools use the sync version of a node function instead of the async version?
+Naturally you want to use the async version of the node function because you can distribute heavy workloads more efficient. However if you work with a compare function or a copy function, you most likely want to know if something happened before the program completes. In this case it is better to use the sync version of the node function, so the program continues after the function completes. Don't get me wrong, I love promises and async functions, but often times it is better to wait for them to complete.
+
+<br />
+<br />
+<br />
+
+## MORE COMING SOON

image/README.md

@@ -0,0 +1,14 @@
+# web-helper -> Image Helper
+A collection of utilities and helper utilities to work with images.
+
+## [1. Compare Images Helper](https://github.com/nikolas-schwarz/web-helper/tree/main/image/compare)
+This is a little tool to compare images in two different folders, to determine if they are the same or not.<br />
+[Go to Compare Images Helper](https://github.com/nikolas-schwarz/web-helper/tree/main/image/compare)
+
+## [2. Create Placeholder Helper (Simple Version)](https://github.com/nikolas-schwarz/web-helper/tree/main/image/create-placeholder-simple)
+This is a little tool, which copies a placeholder image for an array of strings containing the new filename. This is the simple version with no other dependencies, there is also an advanced version using an excel file.<br />
+[Go to Create Placeholder Helper (Simple Version)](https://github.com/nikolas-schwarz/web-helper/tree/main/image/create-placeholder-simple)
+
+&nbsp;
+## License
+[MIT License](https://github.com/nikolas-schwarz/web-helper/blob/main/LICENSE)

image/compare/README.md

@@ -0,0 +1,21 @@
+# web-helper -> Image Helper -> Compare Images Helper
+This is a little tool to compare images in two different folders, to determine if they are the same or not.
+
+## Setup
+Befor you can run this node program, you have to install the 'img-diff-js' package from https://github.com/reg-viz/img-diff-js.
+Simply type `npm install img-diff-js` into your console.
+
+## Versions
+This node programm is created with **node** version `11.15.0` and the **img-diff-js** version `0.5.0`.
+
+## Tested versions
+I can not guaranty that the program is working with a newer version. Please feel free to check for compatibility or add an issue to the github reposity, if you have any problems.
+
+| Dependency    | Version   |
+| ------------- | ---------:|
+| Node          | 11.15.0   |
+| img-diff-js   | 0.5.0     |
+
+ 
+## License
+[MIT License](https://github.com/nikolas-schwarz/web-helper/blob/main/LICENSE)

image/compare/compare.js

@@ -0,0 +1,80 @@
+'use strict';
+// load node standard libraries for filesystem, path and utils
+const fs = require('fs');
+const path = require('path');
+const util = require('util');
+// install node package from https://github.com/reg-viz/img-diff-js
+const { imgDiff } = require("img-diff-js");
+// create log file for our log function, the falg 'w' helps us to overwrite the log every time we run the script (Use 'a' if you want to keep the log file)
+let logFile = fs.createWriteStream('log.txt', { flags: 'w' }); 
+// create log function to log infos, without spamming the console output
+function log(message) {
+    logFile.write(util.format.apply(null, arguments) + '\n');
+}
+// get the current directory and create path for the 
+const scriptDir = __dirname;
+const newFolder = `${path.join(scriptDir, '/new')}`;
+const orgFolder = `${path.join(scriptDir, '/org/')}`;
+const diffFolder = `${path.join(scriptDir, '/diff/')}`;
+// create some temporary variables for statistics at the end
+let numberOfImages = 0;
+let numberOfDifferentFiles = 0;
+let numberOfSameFiles = 0;
+let numberOfUnknownFiles = 0;
+// async function to work with the await statement for image diff
+async function main() {
+    // let the user know the tests are running (going via the process stdout helps us writing the start notification and the end notification in the same line)
+    process.stdout.write('\nStart Tests...');
+    // read all files from the new folder
+    let files = fs.readdirSync(newFolder);
+    // check every file from the new folder
+    for(let index = 0; index < files.length; index++) {
+        // temporary variable for file
+        let file = files[index];
+        // create strings with the full path for the files to compare
+        let fileFromNewToCheck = `${path.join(newFolder, file)}`;
+        let fileFromOrgToCheck = `${path.join(orgFolder, file)}`;
+        // create string with the full path for the file containing the differences between the two files
+        let fileForDif = `${path.join(diffFolder, file)}`;
+        // check if the file exist in the old folder   
+        if (fs.existsSync(fileFromOrgToCheck)) {
+            // if the file exists in the old folder, check if the files are the same
+            const result = await imgDiff({
+                actualFilename: fileFromNewToCheck,
+                expectedFilename: fileFromOrgToCheck,
+                diffFilename: fileForDif,
+                generateOnlyDiffFile: true,
+            });
+            // check if the result is the same image
+            if(result.imagesAreSame) {
+                // if yes, increment the numer of same images
+                numberOfSameFiles++;
+            } else {
+                // if not, increment the numer of different images
+                numberOfDifferentFiles++;
+            }
+            // log the name for the same existing image
+            log('Tested: ' + fileFromOrgToCheck);
+            // log the result for debugging
+            log(JSON.stringify(result));
+        } else {
+            // log the unknowm file
+            log('Unknown: ' + fileFromOrgToCheck);
+            // increment the number of unknowm files
+            numberOfUnknownFiles++;
+        }
+        // increment the number of images
+        numberOfImages++;
+    }
+    // let the user know the tests are finished (going via the process stdout helps us writing the start notification and the end notification in the same line)
+    process.stdout.write('finished\n\n');
+    // printing some statistics
+    console.log('Number of images: ' + numberOfImages);
+    console.log('Number of diff images: ' + numberOfDifferentFiles);
+    console.log('Number of same images: ' + numberOfSameFiles);
+    console.log('Number of unknowm images: ' + numberOfUnknownFiles);
+    // only for cosmetic
+    process.stdout.write('\n');
+}
+// run the async function
+main();

image/create-placeholder-simple/README.md

@@ -0,0 +1,21 @@
+# web-helper -> Image Helper -> Create Placeholder Helper (Simple Version)
+This is a little tool, which copies a placeholder image for an array of strings containing the new filename. This is the simple version with no other dependencies, there is also an advanced version using an excel file.
+
+## Setup
+No other node package necessary.
+
+## Versions
+This node programm is created with **node** version `11.15.0`.
+
+## Tested versions
+I can not guaranty that the program is working with a newer version. Please feel free to check for compatibility or add an issue to the github reposity, if you have any problems.
+
+| Dependency    | Version   |
+| ------------- | ---------:|
+| Node          | 11.15.0   |
+
+ 
+## License
+[MIT License](https://github.com/nikolas-schwarz/web-helper/blob/main/LICENSE)
+
+Font used in Placeholder Image: https://www.dafont.com/8bit-wonder.font

image/create-placeholder-simple/create-placeholder-simple.js

@@ -0,0 +1,89 @@
+'use strict';
+// load node standard libraries for filesystem, path and utils
+const fs = require('fs');
+const path = require('path');
+const util = require('util');
+// create log file for our log function, the falg 'w' helps us to overwrite the log every time we run the script (Use 'a' if you want to keep the log file)
+let logFile = fs.createWriteStream('log.txt', { flags: 'w' }); 
+// create log function to log infos, without spamming the console output
+function log(message) {
+    logFile.write(util.format.apply(null, arguments) + '\n');
+}
+// get the current directory and create path for the 
+const scriptDir = __dirname;
+const placeholderJPEG = `${path.join(scriptDir, '/placeholder.jpg')}`;
+const placeholderPNG = `${path.join(scriptDir, '/placeholder.png')}`;
+const destinationPath = `${path.join(scriptDir, '/placeholder/')}`;
+// determine the output format, you can use either 'jpg' or 'png' to specify the fileformat used to generate the placeholder images
+const placeholderOutputFormat = 'jpg';          
+const placeholderImage = (placeholderOutputFormat === 'jpg') ? placeholderJPEG : placeholderPNG; 
+// a example list/array of names for the placeholder images.
+const listOfPlaceholderFilenames = [
+    { filename: 'placeholder1' },
+    { filename: 'placeholder2' },
+    { filename: 'placeholder3' },
+    { filename: 'placeholder4' },
+    { filename: 'placeholder5' },
+    { filename: 'placeholder6' },
+    { filename: 'placeholder7' },
+    { filename: 'placeholder8' },
+    { filename: 'placeholder9' },
+    { filename: 'placeholder10' },
+];   
+// create some temporary variables for statistics at the end
+let numberOfImages = 0;
+let numberOfFailedImages = 0;
+// async function to work with the await statement, if needed
+async function main() {
+    // let the user know the gereration of the placeholder images are running (going via the process stdout helps us writing the start notification and the end notification in the same line)
+    process.stdout.write('\nStart placeholder generation...');
+    // check if the destination folder does not exist
+    if(!fs.existsSync(destinationPath)) {
+        // if there is no destination folder, we will create on
+        fs.mkdirSync(destinationPath);
+    }
+    // check every file from the new folder
+    for(let index = 0; index < listOfPlaceholderFilenames.length; index++) {
+        // temporary variable for file
+        let entry = listOfPlaceholderFilenames[index];
+        // create the full path to the destination folder with the filename
+        let placeholderImageDestinationPath = `${path.join(destinationPath, `/${entry.filename}.${placeholderOutputFormat}`)}`;
+        // read the source file into a buffer
+        try { 
+            let data = fs.readFileSync(placeholderImage);
+            // next we want to copy the data buffer into the destination path via the base64 operation
+            try { 
+                fs.writeFileSync(placeholderImageDestinationPath, data, { encoding: "base64", flag: "w" });
+            } catch(err) { 
+                // if data is a string we want to log the error
+                log(`Failed to create Placeholderimage: ${placeholderImageDestinationPath}`);
+                log(err);
+                // increment the number of failed images
+                numberOfFailedImages++;
+                // and want to continue the loop
+                continue; 
+            }
+        } catch(err) { 
+            // if data is a string we want to log the error
+            log(`Failed to create Placeholderimage: ${placeholderImageDestinationPath}`);
+            log(err);
+            // increment the number of failed images
+            numberOfFailedImages++;
+            // and want to continue the loop
+            continue; 
+        }
+        // log success
+        log(`Created Placeholderimage: ${placeholderImageDestinationPath}`);
+        // increment the number of images
+        numberOfImages++;
+    }
+    // let the user know the tests are finished (going via the process stdout helps us writing the start notification and the end notification in the same line)
+    process.stdout.write('finished\n\n');
+    // printing some statistics
+    console.log('Number of images: ' + numberOfImages);
+    console.log('Number of failed images: ' + numberOfFailedImages);
+    // only for cosmetic
+    process.stdout.write('\n');
+}
+// run the async function
+main();

package-lock.json

@@ -0,0 +1,88 @@
+{
+    "name": "web-helper",
+    "version": "1.0.0",
+    "lockfileVersion": 1,
+    "requires": true,
+    "dependencies": {
+        "@types/mkdirp": {
+            "version": "1.0.1",
+            "resolved": "https://registry.npmjs.org/@types/mkdirp/-/mkdirp-1.0.1.tgz",
+            "integrity": "sha512-HkGSK7CGAXncr8Qn/0VqNtExEE+PHMWb+qlR1faHMao7ng6P3tAaoWWBMdva0gL5h4zprjIO89GJOLXsMcDm1Q==",
+            "requires": {
+                "@types/node": "*"
+            }
+        },
+        "@types/node": {
+            "version": "14.14.14",
+            "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.14.tgz",
+            "integrity": "sha512-UHnOPWVWV1z+VV8k6L1HhG7UbGBgIdghqF3l9Ny9ApPghbjICXkUJSd/b9gOgQfjM1r+37cipdw/HJ3F6ICEnQ=="
+        },
+        "@types/pixelmatch": {
+            "version": "5.2.2",
+            "resolved": "https://registry.npmjs.org/@types/pixelmatch/-/pixelmatch-5.2.2.tgz",
+            "integrity": "sha512-ndpfW/H8+SAiI3wt+f8DlHGgB7OeBdgFgBJ6v/1l3SpJ0MCn9wtXFb4mUccMujN5S4DMmAh7MVy1O3WcXrHUKw==",
+            "requires": {
+                "@types/node": "*"
+            }
+        },
+        "@types/pngjs": {
+            "version": "3.4.2",
+            "resolved": "https://registry.npmjs.org/@types/pngjs/-/pngjs-3.4.2.tgz",
+            "integrity": "sha512-LJVPDraJ5YFEnMHnzxTN4psdWz1M61MtaAAWPn3qnDk5fvs7BAmmQ9pd3KPlrdrvozMyne4ktanD4pg0L7x1Pw==",
+            "requires": {
+                "@types/node": "*"
+            }
+        },
+        "decode-tiff": {
+            "version": "0.2.1",
+            "resolved": "https://registry.npmjs.org/decode-tiff/-/decode-tiff-0.2.1.tgz",
+            "integrity": "sha512-v/7hQBv/DrOVQ+Eljg0BLMRbXZYuuw3YZ8duZuFxYpo6qUkdn7oFRkN95RZKbnh08EHNjrMXMbEUNhTLuhPvvA=="
+        },
+        "img-diff-js": {
+            "version": "0.5.0",
+            "resolved": "https://registry.npmjs.org/img-diff-js/-/img-diff-js-0.5.0.tgz",
+            "integrity": "sha512-oaM2kASTy24CCRCc29H7eTAbiDMjTSaP7bcojTjCTMpJcoh5dhtQ+QtLY7xbXgzwQJp/wQAW8rHSCZmijbAvZQ==",
+            "requires": {
+                "@types/mkdirp": "^1.0.1",
+                "@types/node": "^14.11.2",
+                "@types/pixelmatch": "^5.2.2",
+                "@types/pngjs": "^3.4.2",
+                "decode-tiff": "^0.2.0",
+                "jpeg-js": "^0.4.2",
+                "mkdirp": "^1.0.4",
+                "pixelmatch": "^5.2.1",
+                "pngjs": "^5.0.0"
+            }
+        },
+        "jpeg-js": {
+            "version": "0.4.2",
+            "resolved": "https://registry.npmjs.org/jpeg-js/-/jpeg-js-0.4.2.tgz",
+            "integrity": "sha512-+az2gi/hvex7eLTMTlbRLOhH6P6WFdk2ITI8HJsaH2VqYO0I594zXSYEP+tf4FW+8Cy68ScDXoAsQdyQanv3sw=="
+        },
+        "mkdirp": {
+            "version": "1.0.4",
+            "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
+            "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw=="
+        },
+        "pixelmatch": {
+            "version": "5.2.1",
+            "resolved": "https://registry.npmjs.org/pixelmatch/-/pixelmatch-5.2.1.tgz",
+            "integrity": "sha512-WjcAdYSnKrrdDdqTcVEY7aB7UhhwjYQKYhHiBXdJef0MOaQeYpUdQ+iVyBLa5YBKS8MPVPPMX7rpOByISLpeEQ==",
+            "requires": {
+                "pngjs": "^4.0.1"
+            },
+            "dependencies": {
+                "pngjs": {
+                    "version": "4.0.1",
+                    "resolved": "https://registry.npmjs.org/pngjs/-/pngjs-4.0.1.tgz",
+                    "integrity": "sha512-rf5+2/ioHeQxR6IxuYNYGFytUyG3lma/WW1nsmjeHlWwtb2aByla6dkVc8pmJ9nplzkTA0q2xx7mMWrOTqT4Gg=="
+                }
+            }
+        },
+        "pngjs": {
+            "version": "5.0.0",
+            "resolved": "https://registry.npmjs.org/pngjs/-/pngjs-5.0.0.tgz",
+            "integrity": "sha512-40QW5YalBNfQo5yRYmiw7Yz6TKKVr3h6970B2YE+3fQpsWcrbj1PzJgxeJ19DRQjhMbKPIuMY8rFaXc8moolVw=="
+        }
+    }
+}

package.json

@@ -0,0 +1,29 @@
+{
+    "name": "web-helper",
+    "description": "A collection of node.js scripts to help on every day webdev problems",
+    "version": "1.0.0",
+    "author": "Nikolas Schwarz",
+    "homepage": "https://evolut.solutions",
+    "contributors": [
+        "Nikolas Schwarz <nikolas.schwarz@evolut.solutions> (https://github.com/nikolas-schwarz)"
+    ],
+    "dependencies": {
+        "img-diff-js": "0.5.0"
+    },
+    "devDependencies": {
+        "img-diff-js": "0.5.0"
+    },
+    "keywords": [
+        "nodejs",
+        "node-js",
+        "helper",
+        "helper-tool"
+    ],
+    "repository": "https://github.com/nikolas-schwarz/web-helper",
+    "licenses": [
+        {
+            "type": "MIT",
+            "url": "http://opensource.org/licenses/MIT"
+        }
+    ]
+}