picslim 0.0.8 → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
 # 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.
+**Picslim** is a Node.js package that allows you to efficiently optimize images within a specified directory. It supports **JPEG** and **PNG** images, image formats, offering fine-grained control over image quality and resizing options during the optimization process. With **Picslim**, you can effortlessly reduce file sizes and enhance the loading performance of your images.
 
 ## Installation
 
@@ -10,6 +10,12 @@ You can install picslim globally using npm:
 npm install -g picslim
 ```
 
+or
+
+```bash
+npx picslim
+```
+
 # Usage
 
 Once installed, you can use the optimizimage command in your terminal. Here's how you can use it:
@@ -18,17 +24,43 @@ Once installed, you can use the optimizimage command in your terminal. Here's ho
 picslim [options]
 ```
 
-Options:
+### Options
+
+- `-c, --config <path>`: Path to the configuration file. (default: 'config.json')
+- `-q, --quality <number>`: Image quality (0-100).
+- `-l, --compressionLevel <number>`: PNG compression level (0-9).
+- `-w, --maxWidth <number>`: Maximum width allowed for images.
+- `-h, --maxHeight <number>`: Maximum height allowed for images.
+- `-i, --input <path>`: Path to the input directory.
+- `-o, --output <path>`: Path to the output directory.
+
+### Configuration File
+
+You can create a `config.json` file in your project directory to specify default settings. Here's an example configuration:
+
+```json
+{
+  "inputDir": "./in",
+  "outputDir": "./min",
+  "quality": 80,
+  "maxWidth": null,
+  "maxHeight": null,
+  "compressionLevel": 9
+}
+```
 
-**-q, --quality [value]:** Set the image quality (1 to 100, default: 80).<br>
-**-mw, --maxWidth [value]:** Set the maximum width allowed (default: null).<br>
-**-mh, --maxHeight [value]:** Set the maximum height allowed (default: null).<br>
-**-c, --compressionLevel [value]:** Set the compression level (0 to 9, default: 9).
+### Example:
 
-Example:
+Optimize images using default settings from the configuration file:
 
 ```bash
-picslim -q 90 -w 1920
+picslim
+```
+
+Optimize images with custom settings:
+
+```bash
+picslim -q 90 -w 800 -h 600 -l 4 -i input_images -o output_images
 ```
 
 This will optimize all JPEG and PNG images in the current directory, and the optimized images will be saved in a 'min' directory.
@@ -65,3 +97,7 @@ This project is licensed under the MIT License. See the LICENSE file for details
 ### Author
 
 Ivan Mercedes
+
+### Contributors
+
+- [Elminson De Oleo Baez](https://github.com/elminson)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "picslim",
-  "version": "0.0.8",
+  "version": "1.0.0",
   "description": "Picslim is a Node.js package that allows you to optimize images in a specified directory.",
   "main": "picslim.js",
   "bin": {

package/picslim.js

@@ -14,14 +14,56 @@ function parseArguments () {
       demandOption: false,
       type: 'string',
       default: 'config.json'
+    },
+    q: {
+      alias: 'quality',
+      describe: 'Image quality',
+      demandOption: false,
+      type: 'number',
+      default: null
+    },
+    l: {
+      alias: 'compressionLevel',
+      describe: 'PNG compression level',
+      demandOption: false,
+      type: 'number',
+      default: null
+    },
+    w: {
+      alias: 'maxWidth',
+      describe: 'Maximum width allowed',
+      demandOption: false,
+      type: 'number',
+      default: null
+    },
+    h: {
+      alias: 'maxHeight',
+      describe: 'Maximum height allowed',
+      demandOption: false,
+      type: 'number',
+      default: null
+    },
+    i: {
+      alias: 'input',
+      describe: 'Path to the input directory',
+      demandOption: false,
+      type: 'string',
+      default: null
+    },
+    o: {
+      alias: 'output',
+      describe: 'Path to the output directory',
+      demandOption: false,
+      type: 'string',
+      default: null
     }
   }).argv
 }
 
 /**
- * Verifies if the output directory exists; if not, creates it.
- *
- * @param {string} dir - The directory to verify.
+ * Creates an output directory if it doesn't exist.
+ * @param {string} dir - The directory path to create.
+ * @returns {Promise<void>}
  */
 async function createOutputDirectory (dir) {
   try {
@@ -61,64 +103,37 @@ async function processImage (inputPath, outputPath, file, maxWidth, maxHeight, q
       console.log(`Optimized PNG image: ${file}`)
     }
   } catch (error) {
-    console.error(`Optimization error ${file}: `, error)
+    // console.error(`Optimization error ${file}: `, error)
   }
 }
 
 /**
- * Load settings from a configuration file.
+ * Load settings from a configuration file. If the specified configuration file doesn't exist,
+ * it will use the default 'config.json' from the package.
  *
  * @param {string} configFile - Path to the configuration file.
  */
 async function loadConfig (configFile) {
+  let config
   try {
     const configData = await fs.readFile(configFile, 'utf8')
-
-    if (configData.trim() === '') {
-      console.error('Configuration file is empty.')
-      process.exit(1)
-    }
-
-    if (!validateJson(configData)) {
-      console.error('Configuration file is not a valid JSON object.')
-      process.exit(1)
-    }
-
-    const config = JSON.parse(configData)
-
-    validateConfig(config)
-
-    if (typeof config !== 'object' || Array.isArray(config)) {
-      console.error('Configuration file is not a valid JSON object.')
-      process.exit(1)
-    }
-
-    if (!config.inputDir || !config.outputDir) {
-      console.error("Configuration error: 'inputDir' and 'outputDir' are required fields.")
-      process.exit(1)
-    }
-
-    return config
+    config = JSON.parse(configData)
   } catch (error) {
-    console.error('Error loading or parsing the configuration file: ', error)
-    process.exit(1)
+    console.error('Using the default configuration from the package. ✅')
+    config = require('./config.json') // Load default configuration from the package
   }
-}
 
-function validateJson (json) {
-  const isJson = (str) => {
-    try {
-      JSON.parse(str)
-    } catch (e) {
-      // Error
-      // JSON is not okay
-      return false
-    }
+  if (!validateConfigObject(config)) {
+    console.error('Invalid configuration object.')
+    process.exit(1)
+  }
 
-    return true
+  if (!config.inputDir || !config.outputDir) {
+    console.error("Configuration error: 'inputDir' and 'outputDir' are required fields.")
+    process.exit(1)
   }
 
-  return isJson(json)
+  return config
 }
 
 /**
@@ -126,11 +141,28 @@ function validateJson (json) {
  *
  * @param {object} config - The loaded configuration object.
  */
-function validateConfig (config) {
-  if (!config.inputDir || !config.outputDir) {
-    console.error("Configuration error: 'inputDir' and 'outputDir' are required fields.")
-    process.exit(1)
+function validateConfigObject (config) {
+  return (
+    typeof config === 'object' &&
+    !Array.isArray(config) &&
+    config.inputDir &&
+    config.outputDir
+  )
+}
+
+/**
+ * Returns the input directory path based on the provided arguments and configuration.
+ * If the provided arguments or configuration are '.', returns the current working directory.
+ * @param {string} argvInput - The input directory path provided as an argument.
+ * @param {string} configInputDir - The input directory path provided in the configuration.
+ * @returns {string} - The input directory path.
+ */
+function getInputDirectory (argvInput, configInputDir) {
+  if (argvInput === '.' || configInputDir === '.') {
+    return process.cwd()
   }
+
+  return argvInput || configInputDir
 }
 
 /**
@@ -139,13 +171,12 @@ function validateConfig (config) {
 async function main () {
   const argv = parseArguments()
   const config = await loadConfig(argv.config)
-
-  const inputDir = config.inputDir
-  const outputDir = config.outputDir
-  const quality = config.quality
-  const maxWidth = config.maxWidth
-  const maxHeight = config.maxHeight
-  const compressionLevel = config.compressionLevel
+  const inputDir = getInputDirectory(argv.input, config.inputDir)
+  const outputDir = getInputDirectory(argv.output, config.outputDir)
+  const quality = argv.quality ? argv.quality : config.quality
+  const maxWidth = argv.maxWidth ? argv.maxWidth : config.maxWidth
+  const maxHeight = argv.maxHeight ? argv.maxHeight : config.maxHeight
+  const compressionLevel = argv.compressionLevel ? argv.compressionLevel : config.compressionLevel
 
   await createOutputDirectory(outputDir)