npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@japudcret/iconic

v0.2.0

Published

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity) [![Npm package

Downloads

6

Readme

MIT license Maintenance Npm package version Minimum node.js version

Iconic - Simplify your Icon usage during development!

This package provides a web ui for visualizing your icons and making them easier to find.

Basic usage npx @japudcret/iconic --icon-path src/icons/

Sometimes the npx package gets cached and then executed from the cache. In that case you have to manually delete the cached package.

CLI

$ npx @japudcret/iconic -h

Usage: npx @japudcret/iconic --icon-path <path-to-icons> [-v] [-p port] [-r regex] [-h]


Options:
      --version                Show version number                     [boolean]
  -v, --verbose                Debug Mode             [boolean] [default: false]
  -p, --port                   Port                     [number] [default: 5000]
  -i, --icon-path              Icon Path (e.g. src/icons/)            [required]
  -r, --regex                  Regular Expression to find the icon files
                 [default: "([^.]+).(apng|avif|gif|jpg|jpeg|ico|svg|png|webp)$"]
      --findReferences         If references to the Icon files should be
                               searched for            [boolean] [default: true]
  -s, --sources                The source folder, where references will be
                               searched for                    [default: "src/"]
      --sourceSearchDepth      The reference depth which should be discovered
                                                                    [default: 1]
      --omittedFileExtensions  File Extensions that get omitted during import
                                                  [default: ".jsx,.js,.tsx,.ts"]
      --excludes               Excludes directories from being searched
                                          [default: "node_modules,build,target"]
  -h, --help                   Show help                               [boolean]

Development

Local testing

You can locally test the functionality by starting the backend and the frontend separately.

Start the backend (express dev server)

Start a local server that will mimic the environment created by npx

npm run start-express

This server uses only static source files found under build/ and assumes you have icons under test/.

Start the frontend (React dev server)

npm run start-react

Test the package

Compile with

npm run build

Create a package

npm pack

Publish the package to your local (global) repository

npm install -g japudcret-iconic-0.2.0.tgz

Afterwards you can use npx iconic to test your latest version.