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

@kbase/narrative-utils

v0.0.6

Published

Utility modules and functions for the Jupyterlab Narrative

Downloads

8

Readme

narrative-utils

Utility modules and APIs and such for the Jupyterlab Narrative

This is all written in TypeScript for the Shiny New KBase-UI. It's packaged and stored on NPM in the @kbase namespace.

Installation for other modules

> npm install @kbase/narrative-utils

Testing

  1. Fetch this repo.
> git clone https://github.com/kbaseIncubator/narrative-utils
> cd narrative-utils
  1. Build it
> npm install
  1. Run the tests
> npm run test

Contributing

Adding code

All the code is under src/ in various .ts (TypeScript) modules. When adding a new module or function, be sure that it is included in index.ts as an export statement, as that's the main entrypoint.

This is (currently) meant to be a catchall utility module for the new Narrative-Jupyterlab interface. It might eventually be broken down into sub-utilities, or more specialized things. For now, though, anything goes. Just decompose as logic dictates.

Be sure to run npm run build and npm run test occcasionally to test your stuff!

Testing

Each added module should be accompanied by tests. This uses Mocha as the test runner and Chai as the runner language. All test specs are included under test/. They're expected to run in a Node environment. If your module expects some browser features, you might need to add those to the test runner. See test/authSpec.js for an example of using jsdom to dummy up a window and document feature.