New functionality

Added the ability to convert images from one specific type to another using an object.

Now, when using the usual (in the documentation below - general) parameter objects, the original images are also transmitted as a result optimized.

Author: Ulyanov-programmer

README.md

@@ -4,7 +4,7 @@
 
 ## What is this
 ### With this thing you can: <br>
-- Optimize your images
+- Optimize your images.
 - Convert your images to other formats (including, but not limited to `.webp` and `.avif`).
 ### Features
 - Using the [sharp](https://www.npmjs.com/package/sharp) plugin.
@@ -13,7 +13,7 @@
 
 ## Why is this
 
-- [imagemin](https://www.npmjs.com/package/imagemin) is unmaintained, [see the issue](https://github.com/imagemin/imagemin/issues/385)
+- [imagemin](https://www.npmjs.com/package/imagemin) is unmaintained, [see the issue](https://github.com/imagemin/imagemin/issues/385).
 - [gulp-libsquoosh](https://www.npmjs.com/package/gulp-libsquoosh) uses the outdated library [@squoosh/lib](https://www.npmjs.com/package/@squoosh/lib), which does not have support for node > 16.0.0. In addition, the squoosh lib is no longer maintained.
 - [@donmahallem/gulp-sharp](https://www.npmjs.com/package/@donmahallem/gulp-sharp) does not have normal documentation.
 - I have not found a single plugin that would simultaneously allow you to use the [sharp library](https://www.npmjs.com/package/sharp), convert and optimize images.

index.js

@@ -3,94 +3,120 @@ import sharp from 'sharp'
 import Vinyl from 'vinyl'
 
 const ALLOWED_EXTENTIONS = [
-	'.gif',
-	'.png',
-	'.jpg', '.jpeg',
-	'.webp',
-	'.avif',
-	'.tiff',
-	'.heif',
+  '.gif',
+  '.png',
+  '.jpg', '.jpeg',
+  '.webp',
+  '.avif',
+  '.tiff',
+  '.heif',
 ]
 const optionsByDefualt = {
-	quality: 90,
-	lossless: false,
-	chromaSubsampling: '4:2:0'
+  quality: 90,
+  lossless: false,
+  chromaSubsampling: '4:2:0'
 }
 
 
 export default function sharpOptimizeImages(options) {
-	return obj(async function (file, enc, callback) {
-		if (file.isNull()) {
-			return callback(null, file)
-		}
-		if (ALLOWED_EXTENTIONS.includes(file.extname) == false) {
-			console.error(`${file.basename} not supported, just copy.`)
-
-			return callback(null, file)
-		}
-		if (typeof options !== 'object') {
-			throw new Error('Invalid parameters, they must be an object.')
-		}
-
-		let convertedImages = []
-		let optionObjects = Object.entries(options)
-
-		for (let [optionObjectFormat, optionObjectProps] of optionObjects) {
-			let convertedFile = await convert(file, optionObjectFormat, optionObjectProps)
-			convertedImages.push(convertedFile)
-		}
-
-		for (let convertedImage of convertedImages) {
-			this.push(convertedImage)
-		}
-
-		return callback()
-	})
+  return obj(async function (file, enc, callback) {
+    if (file.isNull()) {
+      return callback(null, file)
+    }
+    if (ALLOWED_EXTENTIONS.includes(file.extname) == false) {
+      console.error(`${file.basename} not supported, just copy.`)
+
+      return callback(null, file)
+    }
+    if (typeof options !== 'object') {
+      throw new Error('Invalid parameters, they must be an object.')
+    }
+
+    let convertedImages = []
+    let optionObjects = Object.entries(options)
+
+    for (let [optionObjectFormat, optionObjectProps] of optionObjects) {
+      let splitedObjectName = optionObjectFormat.split('_to_')
+      let convertFromOfGeneralExtname = splitedObjectName[0]
+      let convertToExtname = splitedObjectName[1]
+
+      if (extnamesIsCorrect(convertFromOfGeneralExtname, convertToExtname) == false) {
+        throw new Error('Invalid name of an object! Make sure you have spelled the extension names correctly.')
+      }
+
+      if (convertToExtname == undefined) {
+        let optimizedFile = await convert(file, file.extname.replace('.', ''), optionObjectProps)
+        let convertedFile = await convert(file, convertFromOfGeneralExtname, optionObjectProps)
+
+        convertedImages.push(optimizedFile, convertedFile)
+      }
+      else if (file.extname == `.${convertFromOfGeneralExtname}`) {
+        let convertedFile = await convert(file, convertToExtname, optionObjectProps)
+        convertedImages.push(convertedFile)
+      }
+    }
+
+    for (let convertedImage of convertedImages) {
+      this.push(convertedImage)
+    }
+
+    return callback()
+  })
 }
 
 async function convert(file, newFileFormat, options) {
-	let sharpInstance = sharp(file.contents, { animated: true, limitInputPixels: false, })
-
-	switch (newFileFormat) {
-		case 'gif':
-			sharpInstance = sharpInstance.gif(Object.assign(optionsByDefualt, options))
-			break
-		case 'png':
-			sharpInstance = sharpInstance.png(Object.assign(optionsByDefualt, options))
-			break
-		case 'jpg':
-		case 'jpeg':
-			sharpInstance = sharpInstance.jpeg(Object.assign(optionsByDefualt, options))
-			break
-		case 'webp':
-			sharpInstance = sharpInstance.webp(Object.assign(optionsByDefualt, options))
-			break
-		case 'tiff':
-			sharpInstance = sharpInstance.tiff(Object.assign(optionsByDefualt, options))
-			break
-		case 'avif':
-			sharpInstance = sharpInstance.avif(Object.assign(optionsByDefualt, options))
-			break
-		case 'heif':
-			sharpInstance = sharpInstance.heif(Object.assign(optionsByDefualt, options))
-			break
-		default:
-			return false
-	}
-
-	let buffer = await sharpInstance.toBuffer()
-	return toVinyl(buffer, newFileFormat, file)
+  let sharpInstance = sharp(file.contents, { animated: true, limitInputPixels: false, })
+
+  switch (newFileFormat) {
+    case 'gif':
+      sharpInstance = sharpInstance.gif(Object.assign(optionsByDefualt, options))
+      break
+    case 'png':
+      sharpInstance = sharpInstance.png(Object.assign(optionsByDefualt, options))
+      break
+    case 'jpg':
+    case 'jpeg':
+      sharpInstance = sharpInstance.jpeg(Object.assign(optionsByDefualt, options))
+      break
+    case 'webp':
+      sharpInstance = sharpInstance.webp(Object.assign(optionsByDefualt, options))
+      break
+    case 'tiff':
+      sharpInstance = sharpInstance.tiff(Object.assign(optionsByDefualt, options))
+      break
+    case 'avif':
+      sharpInstance = sharpInstance.avif(Object.assign(optionsByDefualt, options))
+      break
+    case 'heif':
+      sharpInstance = sharpInstance.heif(Object.assign(optionsByDefualt, options))
+      break
+    default:
+      return false
+  }
+
+  let buffer = await sharpInstance.toBuffer()
+  return toVinyl(buffer, newFileFormat, file)
 }
 
 function toVinyl(buffer, newFileFormat, file) {
-	if (file.extname != '.' + newFileFormat) {
-		file.extname = '.' + newFileFormat
-	}
-
-	return new Vinyl({
-		cwd: file.cwd,
-		base: file.base,
-		path: file.path,
-		contents: buffer,
-	})
+  let newFileName = file.basename.substr(0, file.basename.lastIndexOf(".")) + `.${newFileFormat}`
+  let newFilePath = `${file.dirname}\\${newFileName}`
+
+  return new Vinyl({
+    cwd: file.cwd,
+    base: file.base,
+    path: newFilePath,
+    contents: buffer,
+  })
+}
+
+
+function extnamesIsCorrect(...extnames) {
+  for (let extname of extnames) {
+    if (extname && ALLOWED_EXTENTIONS.includes(`.${extname}`) == false) {
+      return false
+    } else {
+      return true
+    }
+  }
 }

package.json

@@ -21,7 +21,7 @@
 		"images",
 		"image",
 		"compress",
-		"conventer",
+		"converter",
 		"convert",
 		"png",
 		"jpg",
@@ -45,4 +45,4 @@
 		"@types/through2": "^4.0.2",
 		"@types/vinyl": "^3.0.0"
 	}
-}
+}