aberlaas-compress 2.10.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Tim Carry (tim@pixelastic.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.

package/lib/dummy.js

@@ -0,0 +1,11 @@
+/**
+ * This is a temporary, dummy file to be able to test the top-level
+ * compress.run() function. I assume I'll add more compression types in addition
+ * to png, so this dummy compress is just to test that all compress are
+ * correctly called, but it doesn't do anything
+ */
+export default {
+  async run() {
+    return true;
+  },
+};

package/lib/main.js

@@ -0,0 +1,41 @@
+import { _, pMap } from 'golgoth';
+import { consoleError, firostError } from 'firost';
+import compressPng from './png.js';
+import compressDummy from './dummy.js';
+
+export default {
+  types: {
+    png: compressPng,
+    dummy: compressDummy,
+  },
+  /**
+   * Wrapper to compress all supported formats
+   * @param {object} cliArgs CLI Argument object, as created by minimist
+   * @returns {boolean} True on success
+   */
+  async run(cliArgs) {
+    const allTypesKeys = _.keys(this.types);
+    const userTypes = _.intersection(_.keys(cliArgs), allTypesKeys);
+    const typesToCompress = _.isEmpty(userTypes) ? allTypesKeys : userTypes;
+
+    let hasErrors = false;
+    await pMap(typesToCompress, async (type) => {
+      try {
+        const userPatterns = _.get(cliArgs, '_');
+        const compresser = this.types[type];
+
+        await compresser.run(userPatterns);
+      } catch (error) {
+        this.__consoleError(error.message);
+        hasErrors = true;
+      }
+    });
+
+    if (hasErrors) {
+      throw firostError('ERROR_COMPRESS', 'Error while compressing files');
+    }
+
+    return true;
+  },
+  __consoleError: consoleError,
+};

package/lib/png.js

@@ -0,0 +1,48 @@
+import { _ } from 'golgoth';
+import { firostError, run, which } from 'firost';
+import helper from 'aberlaas-helper';
+
+export default {
+  /**
+   * Find the png files to compress
+   * @param {Array} userPatterns Patterns to narrow the search down
+   * @returns {Array} Array of files
+   */
+  async getInputFiles(userPatterns) {
+    const filePatterns = _.isEmpty(userPatterns)
+      ? ['./**/*.png']
+      : userPatterns;
+    return await helper.findHostFiles(filePatterns, ['.png']);
+  },
+
+  /**
+   * Returns path to the binary to execute
+   * @returns {string|boolean} Path to the binary, or false if not found
+   */
+  async getBinaryPath() {
+    return await this.__which('pngmin');
+  },
+  /**
+   * Compress files
+   * @param {Array} userPatterns Patterns to narrow the search down
+   * @returns {boolean} True on success
+   */
+  async run(userPatterns) {
+    // Stop early if no bin
+    const binaryPath = await this.getBinaryPath();
+    if (!binaryPath) {
+      return true;
+    }
+
+    try {
+      const files = await this.getInputFiles(userPatterns);
+      const command = `${binaryPath} ${files.join(' ')}`;
+      await run(command, { stdout: false });
+    } catch (error) {
+      throw firostError('PngCompressError', error.message);
+    }
+
+    return true;
+  },
+  __which: which,
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "aberlaas-compress",
+  "type": "module",
+  "description": "aberlaas compress command: Reduce image filesize",
+  "version": "2.10.0",
+  "repository": "pixelastic/aberlaas",
+  "homepage": "https://projects.pixelastic.com/aberlaas/",
+  "author": "Tim Carry (@pixelastic)",
+  "license": "MIT",
+  "files": [
+    "lib/*.js"
+  ],
+  "exports": {
+    ".": "./lib/main.js"
+  },
+  "main": "./lib/main.js",
+  "engines": {
+    "node": ">=18.18.0"
+  },
+  "scripts": {
+    "build": "../../scripts/local/build",
+    "build:prod": "../../scripts/local/build-prod",
+    "cms": "../../scripts/local/cms",
+    "serve": "../../scripts/local/serve",
+    "ci": "../../scripts/local/ci",
+    "release": "../../scripts/local/release",
+    "update": "node ../../scripts/meta/update.js",
+    "test:meta": "../../scripts/local/test-meta",
+    "test": "../../scripts/local/test",
+    "test:watch": "../../scripts/local/test-watch",
+    "compress": "../../scripts/local/compress",
+    "lint": "../../scripts/local/lint",
+    "lint:fix": "../../scripts/local/lint-fix"
+  },
+  "dependencies": {
+    "aberlaas-helper": "^2.10.0",
+    "firost": "4.3.0",
+    "golgoth": "2.4.0"
+  },
+  "gitHead": "bcdaf87c198a588e02b5539c222f611e356d3079"
+}