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

nodezoo-coveralls

v3.0.0

Published

nodezoo.com micro-service handling Coveralls meta data

Downloads

6

Readme

logo-nodezoo

nodezoo-coveralls

Npm Travis Coveralls Gitter

A microservice that provides Coveralls data for NodeZoo org. This microservice depends on Coveralls and the NPM registry but also caches retrieved data to reduce load on both public registries.

Please see the Nodezoo System for more details.

If you're using this microservice, and need help, you can:

Install

  • clone this repo into a root /nodezoo folder
  • run npm install

Running

This micro-service can be ran as part of a complete system or as a single isolated unit.

As a complete system

A special system repository is available that runs the complete system using Docker and Fuge.

Isolated mode

To make testing easier this micro-service can be ran in 'isolated' mode. This mode allows testing over http using a well defined port. Please note isolated mode means patterns are not exposed via mesh.

To run in isolated mode:

  • Clone this repository locally,
  • Run npm install,
  • Run npm start isolated.

A simple http service is supported and can be called using Curl or other Rest clients. The default port is 8054. It can be changed using the COVERALLS_PORT environment variable.

Using with Curl

Any of the messages above can be run using curl in the following format in the command line

curl -d '{"role":"coveralls","cmd":"get","name":"YOUR_TEXT_HERE"}' http://localhost:8054/act

Configuration

Environment Variables

Various settings can be changed using environment variables, see the list below for all available variable names.

COVERALLS_HOST

  • The host to listen on in isolated mode or the host to be published in the Mesh network.
  • Defaults to localhost in isolated mode and to 127.0.0.1 in a Mesh network.

COVERALLS_PORT

  • The port to listen on in isolated mode.
  • Defaults to 8054.

COVERALLS_REDIS_HOST

  • The host redis listens on.
  • Defaults to localhost.

COVERALLS_REDIS_PORT

  • The port redis listens on.
  • Defaults to 6379.

COVERALLS_ISOLATED

  • Starts isolated mode.
  • Defaults to false.

COVERALLS_REGISTRY

  • Changes the Coveralls URL used to retrieve the module info.
  • Defaults to https://coveralls.io/.

NPM_REGISTRY

  • Changes the npm registry used to retrieve the module info.
  • Defaults to http://registry.npmjs.org/.

BASE_HOST

  • Mesh Base location.
  • Defaults to 127.0.0.1:39999.

Messages Handled

role:coveralls,cmd:get

Returns Coveralls specific data for the module name provided.

seneca.act(`role:coveralls,cmd:get`, {name:'seneca'}, (err, data) => {})

role:info,req:part

An alias for role:coveralls,cmd:get, allows integration into the wider nodezoo-system.

seneca.act(`role:info,req:part`, {name:'seneca'}, (err, reply) => {})

Messages Emitted

role:info,res:part,part:coveralls

Called in response to a call to role:info,req:part.

seneca.add(`role:info,res:part`, (msg, done) => {})

Data Emitted

  • name: Name of the module,
  • coverageChange: coverage changed,
  • coveredPercent: overall coverage percent,
  • badgeUrl: Url of the Coveralls badge,
  • cached: - The time the data was last cached at.

Contributing

The NodeZoo org encourages open and safe participation.

If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please get in touch.

License

Copyright (c) 2016, Mihai Dima and other contributors. Licensed under [MIT][].