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

@jundao/zut

v1.2.0

Published

Pretty error overlay for browser side JS errors.

Downloads

7

Readme

Pretty error overlay for browser side JS errors.

Zut (French word for "damn", pronouced /zyt/)

license checks npm

Features

  • UI Agnostic - Built with vanilla JS and DOM & works with any framework.
  • Useful - Uses source maps when available to preview the exact source code.
  • Language Agnostic - Config options for extending default preview languages.
  • Type Safe - Entirely coded in Typescript.
  • Modern - Uses the latest available ES & CSS features.

Usage

Install @jundao/zut:

npm install @jundao/zut
# or
yarn add @jundao/zut
# or
pnpm add @jundao/zut

Import and run:

import Zut from "@jundao/zut";


try {
  yourCode();
} catch (error) { // Supports any throwable
  new Zut(error);
}

:sparkles: All done!

API

.close()

Programmatically close the overlay.

const zut = new Zut(error);

zut.close();

Options

interface ZutOptions {
  maxHighlightLenght?: number;
  noStacktraceTranslation?: string;
  unknownTranslation?: string;
  toggleMutedTranslation?: string;
  presetExtension?: Record<string, string>;
  mutedEntries?: RegExp[];
  closable?: boolean;
  theme?: Partial<ZutTheme>;
}

maxHighlightLenght

Maximum code length to highlight (freezes on large files).

new Zut(error, {
  maxHighlightLenght: 4000, // length in characters
});

noStacktraceTranslation, unknownTranslation, toggleMutedTranslation

new Zut(error, {
  noStacktraceTranslation: "No Stacktrace",
  unknownTranslation: "Unknown",
  toggleMutedTranslation: "Show All",
});

presetExtension

Preview highlight languages (values from highlight.js) per file extension (key).

new Zut(error, {
  presetExtension: {
    coffee: "coffeescript",
  },
});

mutedEntries

Stacklist entries to mute (regex matched on file path).

new Zut(error, {
  mutedEntries: [
    /my_folder/,
  ],
});

closable

Whether the overlay should close when clicked outside. (defaults to true)

new Zut(error, {
  closable: false,
});

theme

interface ZutTheme {
  background: string; // color
  activeBackground: string; // color
  hoverBackground: string; // color
  highlightedBackground: string; // color
  textColor: string; // color
  mutedOpacity: number; // from 0 to 1
  accentColor: string; // color
  sansFont: string; // font name
  monoFont: string; // font name
}
new Zut(error, {
  theme: {
    background: "#000",
    ...
}});

Contributing

Before contributing please refer to CONTRIBUTING.md.

All contributions are moderated under the Contributor Covenant Code of Conduct.