heroicons_helper 0.1.0

data/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "heroicons_helper",
+  "private": true,
+  "devDependencies": {
+    "cheerio": "1.0.0-rc.11",
+    "heroicons": "^1.0.6",
+    "fs-extra": "^7.0.1",
+    "globby": "11.0.0",
+    "lodash.merge": "4.6.2",
+    "trim-newlines": "3.0.1",
+    "yargs": "15.1.0"
+  }
+}

data/script/keywords.json

@@ -0,0 +1,3 @@
+{
+  "archive": ["box", "catalog"]
+}

data/script/update_heroicons

@@ -0,0 +1,169 @@
+#!/usr/bin/env node
+/* eslint-env node */
+const fs = require("fs-extra");
+const path = require("path");
+const globby = require("globby");
+const cheerio = require("cheerio");
+const trimNewlines = require("trim-newlines");
+const yargs = require("yargs");
+const merge = require("lodash.merge");
+const keywords = require("./keywords.json");
+
+// This script generates a JSON file that contains
+// information about input SVG files.
+const { argv } = yargs
+  .usage("Usage: $0 --output <output filepath>")
+  .example("$0 --input icons/**/*.svg --output build/data.json")
+  .option("input", {
+    alias: "i",
+    type: "array",
+    describe: "Input SVG files",
+    default: [
+      "node_modules/heroicons/outline/*.svg",
+      "node_modules/heroicons/solid/*.svg",
+    ],
+  })
+  .option("output", {
+    alias: "o",
+    type: "string",
+    describe:
+      "Output JSON file. Defaults to stdout if no output file is provided.",
+    default: "lib/heroicons_helper/data.json",
+  });
+
+const filepaths = globby.sync(argv.input);
+const svgFilepaths = filepaths.filter(
+  (filepath) => path.parse(filepath).ext === ".svg"
+);
+
+if (svgFilepaths.length === 0) {
+  // eslint-disable-next-line no-console
+  console.error(`No input SVG file(s) found in ${icon_file_path.join(", ")}`);
+  process.exit(1);
+}
+
+let exitCode = 0;
+
+const validTypes = ["solid", "outline"];
+const defaultOutlineWidth = "24";
+const defaultSolidWidth = "20";
+
+const icons = svgFilepaths.map((filepath) => {
+  try {
+    let filename = path.parse(filepath).base;
+    const type = path.parse(filepath).dir.split("/").pop();
+    let widthSize;
+    switch (type) {
+      case "outline":
+        widthSize = defaultOutlineWidth;
+        break;
+      case "solid":
+        widthSize = defaultSolidWidth;
+        break;
+      default:
+        throw new Error(`Unknown icon type: ${type}`);
+    }
+
+    const filenamePattern = /(.+)(?:-[0-9]{1,2})?-([0-9]{2}).svg$/;
+    const filenameReplacePattern = /\.svg$/;
+
+    if (!filenamePattern.test(filename)) {
+      filename = filename.replace(filenameReplacePattern, `-${widthSize}.svg`);
+    }
+
+    const [, name, height] = filename.match(filenamePattern);
+
+    const svg = fs.readFileSync(path.resolve(filepath), "utf8");
+    const svgElement = cheerio.load(svg)("svg");
+    let svgWidth = parseInt(svgElement.attr("width"));
+    let svgHeight = parseInt(svgElement.attr("height"));
+    const svgViewBox = svgElement.attr("viewBox");
+    const svgPath = trimNewlines(svgElement.html()).trim();
+
+    if (!svgWidth) {
+      svgWidth = parseInt(widthSize);
+      svgElement.attr("width", svgWidth);
+    }
+
+    if (!svgHeight) {
+      svgHeight = parseInt(widthSize);
+      svgElement.attr("height", svgHeight);
+    }
+
+    if (!svgViewBox) {
+      throw new Error(`${filename}: Missing viewBox attribute.`);
+    }
+
+    if (svgHeight != parseInt(height)) {
+      throw new Error(
+        `${filename}: Height in filename (${height}) does not match height attribute of SVG (${svgHeight})`
+      );
+    }
+
+    const viewBoxPattern = /0 0 ([0-9]+) ([0-9]+)/;
+
+    if (!viewBoxPattern.test(svgViewBox)) {
+      throw new Error(
+        `${filename}: Invalid viewBox attribute. The viewBox attribute should be in the following format: "0 0 <width> <height>"`
+      );
+    }
+
+    const [, viewBoxWidth, viewBoxHeight] = svgViewBox.match(viewBoxPattern);
+
+    if (svgWidth !== parseInt(viewBoxWidth)) {
+      throw new Error(
+        `${filename}: width attribute and viewBox width do not match.`
+      );
+    }
+
+    if (svgHeight !== parseInt(viewBoxHeight)) {
+      throw new Error(
+        `${filename}: height attribute and viewBox height do not match.`
+      );
+    }
+
+    return {
+      name,
+      keywords: keywords[name] || [],
+      type: type,
+      width: svgWidth,
+      height: svgHeight,
+      path: svgPath,
+    };
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error(error);
+    // Instead of exiting immediately, we set exitCode to 1 and continue
+    // iterating through the rest of the SVGs. This allows us to identify all
+    // the SVGs that have errors, not just the first one. An exit code of 1
+    // indicates that an error occurred.
+    // Reference: https://nodejs.org/api/process.html#process_exit_codes
+    exitCode = 1;
+    return null;
+  }
+});
+
+// Exit early if any errors occurred.
+if (exitCode !== 0) {
+  process.exit(exitCode);
+}
+
+const iconsByName = icons.reduce(
+  (acc, icon) =>
+    merge(acc, {
+      [icon.name]: {
+        name: icon.name,
+        keywords: icon.keywords,
+        variants: {
+          [icon.type]: {
+            width: icon.width,
+            height: icon.height,
+            path: icon.path,
+          },
+        },
+      },
+    }),
+  {}
+);
+
+fs.outputJsonSync(path.resolve(argv.output), iconsByName);

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: heroicons_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen J. Torikian
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-09 00:00:00.000000000 Z
+dependencies: []
+description: A package that distributes Heroicons as a gem, for easy inclusion in
+  Ruby projects.
+email:
+- gjtorikian@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- heroicons_helper.gemspec
+- lib/heroicons_helper.rb
+- lib/heroicons_helper/data.json
+- lib/heroicons_helper/icon.rb
+- lib/heroicons_helper/version.rb
+- package-lock.json
+- package.json
+- script/keywords.json
+- script/update_heroicons
+homepage: https://github.com/gjtorikian/heroicons_helper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gjtorikian/heroicons_helper
+  source_code_uri: https://github.com/gjtorikian/heroicons_helper
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 4.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.13
+signing_key:
+specification_version: 4
+summary: Heroicons port for Ruby
+test_files: []