picslim 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2023 Ivan Mercedes
+
+Permission is hereby granted, free
+of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice
+(including the next paragraph) shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,65 @@
+# PicSlim
+
+**Picslim** is a Node.js package that allows you to optimize images in a specified directory. It supports JPEG and PNG images, and you can control the quality and resizing of the images during optimization.
+
+## Installation
+
+You can install picslim globally using npm:
+
+```bash
+npm install -g picslim
+```
+
+# Usage
+
+Once installed, you can use the optimizimage command in your terminal. Here's how you can use it:
+
+```
+picslim [options]
+```
+
+Options:
+
+**-q, --quality [value]:** Set the image quality (1 to 100, default: 80).
+**-w, --width [value]:** Set the maximum width allowed (default: 1366).
+
+Example:
+
+```bash
+picslim -q 90 -w 1920
+```
+
+This will optimize all JPEG and PNG images in the current directory, and the optimized images will be saved in a 'min' directory.
+
+### Example
+Suppose you have a directory with the following images:
+
+- image1.jpg
+- image2.jpg
+- image3.png
+- image4.png
+
+You can optimize all these images with the following command:
+
+```bash
+picslim -q 90 -w 1920
+```
+
+After running the command, you will have the following directory structure:
+
+```markdown
+- min
+  - image1.jpg
+  - image2.jpg
+  - image3.png
+  - image4.png
+```
+
+###  License
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+
+### Author
+
+Ivan Mercedes
+

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "picslim",
+  "version": "0.0.4",
+  "description": "Picslim is a Node.js package that allows you to optimize images in a specified directory.",
+  "main": "picslim.js",
+  "bin": {
+    "picslim": "picslim.js"
+  },
+  "source": "picslim.js",
+  "scripts": {
+    "start": "node picslim.js  -q 80"
+  },
+  "keywords": [
+    "optimization",
+    "images",
+    "package",
+    "Node.js",
+    "cli"
+  ],
+  "author": "Ivan Mercedes <ivanmercede@gmail.com> (https://ivanmercedes.com/)",
+  "homepage": "https://github.com/ivanmercedes/picslim#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ivanmercedes/picslim.git"
+  },
+  "license": "MIT",
+  "files": [
+    "picslim.js",
+    "package.json",
+    "README.md"
+  ],
+  "dependencies": {
+    "sharp": "^0.32.6",
+    "yargs": "^17.7.2"
+  }
+}

package/picslim.js

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+const fs = require("fs");
+const sharp = require("sharp");
+const yargs = require("yargs");
+
+/**
+ * Parses command line arguments using yargs library.
+ *
+ * @typedef {Object} Argv
+ * @property {number} quality - Image quality (1 to 100)
+ * @property {number} width - Maximum width allowed
+ */
+
+const argv = yargs.options({
+  q: {
+    alias: "quality",
+    describe: "Image quality (1 to 100)",
+    demandOption: false,
+    type: "number",
+    default: 80,
+  },
+  w: {
+    alias: "width",
+    describe: "Maximum width allowed",
+    demandOption: false,
+    type: "number",
+    default: 1366,
+  },
+
+}).argv;
+
+const inputDir = "./";
+const outputDir = "./min";
+const quality = argv.quality;
+const maxWidth = argv.width;
+
+/**
+ * Verifies if the output directory exists; if not, creates it.
+ *
+ * @param {string} dir - The directory to verify.
+ */
+if (!fs.existsSync(outputDir)) {
+  fs.mkdirSync(outputDir);
+}
+
+fs.readdir(inputDir, (err, files) => {
+  if (err) {
+    console.error("Error reading input directory: ", err);
+    return;
+  }
+
+  files.forEach((file) => {
+    const inputPath = `${inputDir}/${file}`;
+    const outputPath = `${outputDir}/${file}`;
+
+    if (file.match(/\.(jpg|jpeg)$/i)) {
+      sharp(inputPath)
+        .metadata()
+        .then((metadata) => {
+          const originalWidth = metadata.width;
+          sharp(inputPath)
+            .resize(originalWidth > maxWidth ? maxWidth : null)
+            .jpeg({
+              quality,
+            })
+            .toFile(outputPath, (err, info) => {
+              if (err) {
+                console.error(`Optimization error ${file}: `, err);
+              } else {
+                console.log(`Optimized PNG image: ${file}`);
+              }
+            });
+        });
+    } else if (file.match(/\.(png)$/i)) {
+      const compressionLevel = (quality / 100) * 10;
+      const limitedCompressionLevel = Math.min(
+        Math.max(compressionLevel, 0),
+        9,
+      );
+      sharp(inputPath)
+        .metadata()
+        .then((metadata) => {
+          const originalWidth = metadata.width;
+
+          sharp(inputPath)
+            .resize(originalWidth > maxWidth ? maxWidth : null)
+            .png({ compressionLevel: limitedCompressionLevel })
+            .toFile(outputPath, (err, info) => {
+              if (err) {
+                console.error(`Optimization error ${file}: `, err);
+              } else {
+                console.log(`Optimized PNG image: ${file}`);
+              }
+            });
+        });
+    }
+  });
+});