icomoon-build

library0.2.8jsnpmunverified

IcoMoon Build is a command-line interface (CLI) tool designed to automate the generation of SCSS or LESS stylesheets and font files directly from an IcoMoon project file. Its primary purpose is to streamline the workflow for developers who frequently update or add icons, eliminating the need to manually copy icon declarations from IcoMoon's output into their custom stylesheets. The current stable version is 0.2.8, released in August 2016. Due to its specific niche and dependence on the IcoMoon website structure and underlying tools like PhantomJS, its release cadence was historically tied to bug fixes and compatibility updates. It differentiates itself by providing a robust, scriptable solution for integrating custom icon sets into front-end build processes, particularly for projects utilizing Sass or Less.

devops

npm install icomoon-build

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ICOMOON-BUILD

icomoon-build

devopsjavascriptv0.2.8

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

icomoon-build (CLI execution via npx)

✓ npx icomoon-build -p path/to/project.json --scss path/to/output.scss --fonts path/to/fonts/

✗ import { icomoonBuild } from 'icomoon-build';

This package is primarily a command-line interface (CLI) tool. Its functionality is accessed by executing the `icomoon-build` command, typically via `npx` for project-local installations.

icomoon-build (CLI execution globally)

✓ npm install -g icomoon-build icomoon-build -p path/to/project.json --scss path/to/output.scss --fonts path/to/fonts/

Installing globally allows direct execution from the terminal. However, using `npx` with a local installation is generally recommended to ensure project-specific versioning and avoid global package pollution.

Illustrates how to install `icomoon-build` locally and execute it via `node_modules/.bin` to process an IcoMoon project file. It generates an SCSS stylesheet and font files, and comments explain how to integrate these into a front-end project.

npm install icomoon-build # Example: Process an IcoMoon project and generate files # Assuming an IcoMoon project file at 'my-icons/project.json' # Output SCSS stylesheet to 'src/styles/icons.scss' # Output font files to 'public/fonts/' node_modules/.bin/icomoon-build \ -p my-icons/project.json \ --scss src/styles/icons.scss \ --fonts public/fonts/ console.log('IcoMoon icon processing initiated. Check specified output paths for generated files.'); // To integrate the generated SCSS into a main stylesheet (e.g., main.scss): // @font-face { // font-family: "icons"; // src: url("../fonts/icons.eot"); /* Ensure paths are correct relative to your CSS */ // src: url("../fonts/icons.eot?#iefix") format("embedded-opentype"), // url("../fonts/icons.woff") format("woff"), // url("../fonts/icons.ttf") format("truetype"), // url("../fonts/icons.svg#icons") format("svg"); // font-weight: normal; // font-style: normal; // } // // .icon:before { // display: inline-block; /* Example common styles for icons */ // position: relative; // font-family: "icons"; // font-style: normal; // font-weight: normal; // speak: none; // text-decoration: inherit; // line-height: 99%; // text-align: center; // vertical-align: baseline; // -webkit-font-smoothing: antialiased; // -moz-osx-font-smoothing: grayscale; // } // // @import "src/styles/icons.scss"; // Import the generated icon definitions // @include icon-classes; // Include the mixin generated by icomoon-build to apply classes

icomoon-build --version

Debug

Known issues

breakingThe `icomoon-build` package is effectively abandoned (last updated August 2016) and relies on `phantomjs`, an insecure and officially deprecated headless browser. Using this package introduces significant security risks due to unpatched vulnerabilities in its core dependency and the complete lack of ongoing maintenance.

fix

It is strongly recommended to migrate to a modern icon management solution or utilize an actively maintained tool that uses up-to-date and secure dependencies (e.g., based on Playwright or Puppeteer). Avoid using `icomoon-build` in any production environment.

affects: >=0.0.1

gotchaThe tool's core functionality depends on its ability to interact with the IcoMoon.io website's internal structure and APIs via a headless browser. Consequently, any future updates or changes to the IcoMoon app or website are highly likely to break `icomoon-build`'s processing capabilities. Given its abandoned status, no further updates will be released to address such incompatibilities.

fix

Manually verify the tool's functionality against the current IcoMoon.io website. For reliable icon management, consider actively maintained alternatives or be prepared to manually download and integrate IcoMoon font packages.

affects: >=0.0.1

gotchaPrior to version 0.1.2, `icomoon-build` might fail to connect to the IcoMoon website due to the deprecation of the SSLv3 protocol, leading to connection errors from the underlying PhantomJS process.

fix

Upgrade to `icomoon-build` version 0.1.2 or later, which includes a fix that configures PhantomJS to choose newer, more secure SSL/TLS protocols. If an upgrade is not feasible, manually attempting to specify `--ssl-protocol=any` in the command line might mitigate the issue, though its effectiveness with very old PhantomJS versions may vary.

affects: <0.1.2

Errors

Common errors & fixes

PhantomJS failed to render page

This error or similar messages like 'Error: The command `phantomjs` does not exist' often indicate problems with the bundled `phantomjs` binary, its installation, or a broken internal script interaction with the IcoMoon website. Version 0.2.6 specifically addressed a breakage by an updated `phantomjs` version.

fix

Ensure `phantomjs` is correctly installed and accessible by the `icomoon-build` tool. If the error persists despite correct installation, it's likely an incompatibility with the current IcoMoon website or an unfixable bug within the abandoned `icomoon-build` project.

QUOTA_EXCEEDED_ERR

An internal error occurring within the PhantomJS headless browser, typically related to browser local storage limits or other resource quotas being exceeded during the execution of the IcoMoon web application's scripts.

fix

This issue was specifically addressed and fixed in `icomoon-build` version 0.2.3. Upgrading to 0.2.3 or a later version should resolve this error.

Error: stdout max buffer exceeded

The output generated by the internal PhantomJS process, often for very large IcoMoon projects with numerous icons, exceeded the default buffer limit allocated for Node.js child process execution, causing the process to terminate.

fix

This issue was addressed in `icomoon-build` version 0.1.1. Upgrading to 0.1.1 or a later version will relax the stdout buffer limit, allowing larger outputs to be processed without error.

Upgrade

Version history

0.2.8latest on npm

Audit

Dependencies

phantomjsrequiredCore dependency for headless browser automation to interact with the IcoMoon website. This dependency is deprecated and has known security vulnerabilities.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/SAPikachu/icomoon-build ↗

packagehttps://www.npmjs.com/package/icomoon-build ↗

homepagehttps://icomoon.io ↗