Merge pull request #10 from ahmadalfy/feature/ignore-extension

Scrum · web-flow · commit 72a2cb6fddb4 · 2020-02-25T17:40:16.000+03:00
Feature/ignore extension
diff --git a/README.md b/README.md
@@ -59,7 +59,14 @@ Example: `image.jpg => image.webp (instead of image.jpg.webp)`
 Type: `Array<string>`  
 Default: `[]`  
 Description: *list of classes for which the transformation will be ignored*  
-Example: `image.jpg => image.webp (instead of image.jpg.webp)`
+Example: `classIgnore: ['ignore-webp']` will ignore transformation for images with the class `ignore-web` 
+
+#### `extensionIgnore`
+
+Type: `Array<string>`  
+Default: `[]`  
+Description: *list of extension for which the transformation will be ignored*  
+Example: `extensionIgnore: ['svg']` will ignore transformation for images with the `svg` extension
 
 ### License [MIT](LICENSE)
 
diff --git a/lib/index.js b/lib/index.js
@@ -5,10 +5,14 @@ module.exports = function (options) {
     options = {}
   }
 
-  if (!options.classIgnore) {
+  if (options.classIgnore === undefined) {
     options.classIgnore = []
   }
 
+  if (options.extensionIgnore === undefined) {
+    options.extensionIgnore = []
+  }
+
   if (options.replaceExtension === undefined) {
     options.replaceExtension = false
   }
@@ -17,7 +21,10 @@ module.exports = function (options) {
     tree.match([{ tag: 'img' }, { tag: 'amp-img' }], function (imgNode) {
       if (imgNode.skip) return imgNode
       var classes = imgNode.attrs && imgNode.attrs.class && (imgNode.attrs.class.split(' ') || [])
-      var isIgnore = options.classIgnore.filter(className => classes.includes(className)).length > 0
+      var extension = imgNode.attrs.src.split('.').pop()
+      var isIgnoredByClass = options.classIgnore.filter(className => classes.includes(className)).length > 0
+      var isIgnoredByExtension = options.extensionIgnore.filter(fileExtension => fileExtension === extension).length > 0
+      var isIgnore = isIgnoredByClass || isIgnoredByExtension
       if (isIgnore) return imgNode
       switch (imgNode.tag) {
         case 'amp-img':
diff --git a/test/fixtures/ignore-extension.expected.html b/test/fixtures/ignore-extension.expected.html
@@ -0,0 +1,9 @@
+<!doctype html>
+<html>
+    <body>
+        <img src="photo.svg">
+        <img src="photo.gif">
+        <picture><source type="image/webp" srcset="photo.jpg.webp"><img src="photo.jpg"></picture>
+        <picture><source type="image/webp" srcset="photo.png.webp"><img src="photo.png"></picture>
+    </body>
+</html>
diff --git a/test/fixtures/ignore-extension.html b/test/fixtures/ignore-extension.html
@@ -0,0 +1,9 @@
+<!doctype html>
+<html>
+    <body>
+        <img src="photo.svg">
+        <img src="photo.gif">
+        <img src="photo.jpg">
+        <img src="photo.png">
+    </body>
+</html>
diff --git a/test/test.js b/test/test.js
@@ -39,6 +39,12 @@ test('Class ignore', (t) => {
   })
 })
 
+test('Extension ignore', (t) => {
+  return compare(t, 'ignore-extension', {
+    extensionIgnore: ['gif', 'svg']
+  })
+})
+
 function compare (t, name, options) {
   const html = readFileSync(path.join(fixtures, `${name}.html`), 'utf8')
   const expected = readFileSync(path.join(fixtures, `${name}.expected.html`), 'utf8')
