@open-xchange/vite-plugin-icon-sprite 0.0.2 → 0.0.3

package/CHANGELOG.md

@@ -1,9 +1,13 @@
 # Changelog
 
-## [0.0.2] - 2024-08-08
+## `0.0.3` – 2024-Sep-08
+
+- chore: bump jimp
+
+## `0.0.2` – 2024-Aug-08
 
 - chore: bump @open-xchange/vite-helper
 
-## [0.0.1] - 2024-08-08
+## `0.0.1` – 2024-Aug-08
 
 - initial release

package/README.md

@@ -322,3 +322,7 @@ Add the path to the schema file in a `yaml-language-server` directive to the map
 Adjust the number of parent path fragments according to the location of the mapping file in the project.
 
 In VS Code, the plugin [redhat.vscode-yaml](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) needs to be installed to support this directive.
+
+### Logging
+
+By default, warning messages and error messages will be logged to the shell. The environment variable `PLUGIN_REPLACE_ICON_SPRITE` can be used to change the log level of this plugin. Possible values are `info`, `warn`, `error`, and `silent`.

package/dist/plugin-png.js

@@ -1,4 +1,4 @@
-import Jimp from "jimp";
+import { Jimp, PNGColorType } from "jimp";
 import { onceFn } from "@open-xchange/vite-helper/utils";
 import { Cache } from "@open-xchange/vite-helper/cache";
 import { SpritePluginHelper } from "./helper.js";
@@ -85,7 +85,7 @@ class PngSpritePluginHelper extends SpritePluginHelper {
             // parse mapping file which collects icon paths, CSS selectors, and entry positions
             const { cssSpriteWidth, cssSpriteHeight, entries } = await this.#parseMappingOnce();
             // new image data is not clean out-of-the-box, explicitly fill with zeros
-            const sprite = new Jimp(cssSpriteWidth * factor, cssSpriteHeight * factor, 0);
+            const sprite = new Jimp({ width: cssSpriteWidth * factor, height: cssSpriteHeight * factor, color: 0 });
             // process all entries in the mapping configuration
             for (const { iconPath, x, y } of entries) {
                 // expected pixel size for the current scaling factor
@@ -93,12 +93,12 @@ class PngSpritePluginHelper extends SpritePluginHelper {
                 // load and parse the source image file
                 const path = imagesPath + "/" + srcPattern.replace("[path]", iconPath);
                 const buffer = await this.readBuffer(path);
-                const image = await Jimp.read(buffer);
+                const image = await Jimp.fromBuffer(buffer);
                 // validate the image size
                 const { width, height } = image.bitmap;
                 this.ensure((width === size) && (height === size), "wrong image width in %f (expected %s but got %s)", path, `${size}x${size}`, `${width}x${height}`);
                 // insert source image into the sprite
-                sprite.blit(image, (x + cssIconPadding) * factor, (y + cssIconPadding) * factor);
+                sprite.blit({ src: image, x: (x + cssIconPadding) * factor, y: (y + cssIconPadding) * factor });
             }
             // copy alpha of all pixels to RGB channels (alpha channel will be exported as greyscale without alpha)
             if (spriteColorType === "alpha") {
@@ -108,8 +108,12 @@ class PngSpritePluginHelper extends SpritePluginHelper {
                 }
             }
             // generate the binary PNG data (no preset constants for PNG color types in Jimp)
-            const pngColorType = { source: 6, monochrome: 4, alpha: 0 }[spriteColorType];
-            const spriteBuffer = await sprite.colorType(pngColorType).getBufferAsync(Jimp.MIME_PNG);
+            const colorType = {
+                source: PNGColorType.COLOR_ALPHA,
+                monochrome: PNGColorType.GRAYSCALE_ALPHA,
+                alpha: PNGColorType.GRAYSCALE,
+            }[spriteColorType];
+            const spriteBuffer = await sprite.getBuffer("image/png", { colorType });
             // convert to base64 encoded data URL
             const spriteDataUrl = `data:image/png;base64,${spriteBuffer.toString("base64")}`;
             const moduleSource = `export default ${JSON.stringify(spriteDataUrl)};`;

package/package.json

@@ -1,45 +1,45 @@
 {
-    "name": "@open-xchange/vite-plugin-icon-sprite",
-    "version": "0.0.2",
-    "description": "Vite plugin that builds icon sprites from SVG or PNG icon files",
-    "repository": {
-        "url": "https://gitlab.open-xchange.com/fspd/npm-packages/vite-plugin-icon-sprite"
-    },
-    "license": "MIT",
-    "engines": {
-        "node": "18.18.0 || ^20.9.0 || >=21.1.0"
-    },
-    "packageManager": "yarn@4.4.0",
-    "type": "module",
-    "exports": "./dist/index.js",
-    "scripts": {
-        "prepare": "husky",
-        "prepack": "yarn build && yarn lint",
-        "build": "npx --yes rimraf dist && tsc && npx --yes cpy-cli --flat src/*.json dist/",
-        "lint": "eslint ."
-    },
-    "lint-staged": {
-        "*.{js,ts,json}": "yarn lint"
-    },
-    "dependencies": {
-        "@open-xchange/vite-helper": "0.1.1",
-        "jimp": "0.22.12",
-        "svg-sprite": "2.0.4"
-    },
-    "devDependencies": {
-        "@open-xchange/linter-presets": "0.4.3",
-        "@types/node": "22.1.0",
-        "@types/svg-sprite": "0.0.39",
-        "@types/vinyl": "2.0.12",
-        "eslint": "9.8.0",
-        "husky": "9.1.4",
-        "typescript": "5.5.4",
-        "vite": "5.4.0"
-    },
-    "peerDependencies": {
-        "vite": "^5.3"
-    },
-    "resolutions": {
-        "semver": "^7.6.2"
-    }
-}
+  "name": "@open-xchange/vite-plugin-icon-sprite",
+  "version": "0.0.3",
+  "description": "Vite plugin that builds icon sprites from SVG or PNG icon files",
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.open-xchange.com/fspd/commons/plugins/-/tree/main/packages/vite-plugin-icon-sprite"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": "18.18.0 || ^20.9.0 || >=21.1.0"
+  },
+  "packageManager": "yarn@4.4.1",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "scripts": {
+    "prepare": "yarn build",
+    "prepack": "yarn build && yarn lint",
+    "build": "rimraf dist && tsc && cpy --flat src/*.json dist/",
+    "lint": "eslint ."
+  },
+  "dependencies": {
+    "@open-xchange/vite-helper": "0.1.1",
+    "jimp": "1.3.0",
+    "svg-sprite": "2.0.4"
+  },
+  "devDependencies": {
+    "@open-xchange/linter-presets": "0.8.1",
+    "@types/node": "22.5.4",
+    "@types/pngjs": "6.0.5",
+    "@types/svg-sprite": "0.0.39",
+    "@types/vinyl": "2.0.12",
+    "cpy-cli": "5.0.0",
+    "eslint": "9.9.1",
+    "rimraf": "6.0.1",
+    "typescript": "5.5.4",
+    "vite": "5.4.3"
+  },
+  "peerDependencies": {
+    "vite": "^5.3"
+  },
+  "resolutions": {
+    "semver": "^7.6.2"
+  }
+}

package/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-    "typescript.tsdk": "node_modules/typescript/lib"
-}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 OX Software GmbH, Germany <info@open-xchange.com>
-
-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 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.