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

notios

v0.5.3

Published

<br /> <img src="https://raw.githubusercontent.com/frouriojs/notios/main/docs/assets/images/ogp.svg" width="1280" alt="notios" />

Downloads

697

Readme

Notios

Setup

For npm-run-all users

Just uninstall npm-run-all and install notios.

npm remove npm-run-all
npm install -D notios

Binaries (n-run-p, n-run-s and n-npm-run-all) behavies perfectly the same as npm-run-all unless starting from notios.

As an other option, you can keep npm-run-all with using n-run-p, n-run-s and n-npm-run-all binaries.

Usage

# Show help.
npx notios --help

# Start UI.
npx notios

# Or specify script name.
npx notios dev

Incompatibility

  • Flags other than -s and -p in npm-run-app are not supported when starting from notios.
  • Supplying flags over patterns like run-s 'build:* -- --watch'.

Fix npm-run-all version

Notios will check existence of @notios/npm-run-all.

npm i -D @notios/npm-run-all@npm:npm-run-all@${version}

# example for ^3
npm i -D @notios/npm-run-all@npm:npm-run-all@^3

Note that you should replace run-p, run-s and npm-run-all with n- prefixed ones.

Configuration

Notios can be configured with user level config file. Please npx notios --help to check default config file location or explicitly specify the location by --config flag.

Project level configuration is not recommended.

For linux users, ~/.config/notios/notios.config.cjs is the default location of configuration.

mkdir -p ~/.config/notios
cd ~/.config/notios
npm init -y
npm i @notios/config@latest

Then edit ~/.config/notios/notios.config.cjs like following.

// @ts-check
const { defineNotiosConfig } = require('@notios/config');

module.exports = defineNotiosConfig((defaultConfig) => ({
  ...defaultConfig,
  v1: {
    ...defaultConfig.v1,

    // your configurations...

    // Example for the configuration to show timestamp by default.
    showTimestampByDefault: true,

    // Following is just an example for keymapping.

    keymappings: {
      ...defaultConfig.v1.keymappings,
      "tree-procs": {
        ...defaultConfig.v1.keymappings["tree-procs"],

        // My original safe kill keymapping [CTRL-X then CTRL-X]
        kill: [
          {
            type: "seq",
            seq: [
              {
                type: "char",
                char: "x",
                ctrl: true,
              },
              {
                type: "char",
                char: "x",
                ctrl: true,
              },
            ],
          }
        ],

        // Add my own keymapping [CTRL-R] for restart over the default keymapping
        restart: [
          ...defaultConfig.v1.keymappings["tree-procs"].restart,
          {
            type: "char",
            char: "r",
            ctrl: true,
          }
        ],
      },

      // Common keymappings should be avoided confliction with any other keymappings
      common: {
        ...defaultConfig.v1.keymappings.common,

        // Change exit mapping from [CTRL-C] to [CTRL-Q]
        exit: [
          {
            type: "char",
            char: "q",
            ctrl: true,
          }
        ],
      },
    },
  },
}));

Utility defineNotiosConfig enables you use completion and not necessary. Directive // @ts-check enables you write configuration type-safely.

Notios never fallbacks to any value of configuration to default values. You should use defaultConfig to explicitly specify what and how you want to fallback. Spreading in any nesting level like ...defaultConfig.v1, is necessary to make your configuration working properly for various notios versions.

Until the detailed documatation is ready, please refer to the default configuration.