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

dco

v1.1.0

Published

Tools for analyzing and validating DCO signatures in git repositories.

Downloads

75

Readme

DCO: Developer's Certificate of Origin

Tools for analyzing and validating DCO signatures in git repositories.

Support this project by donating on Gittip.

Installation

npm install dco

Usage

var dco = require( "dco" );

dco.getCommits({
	path: ".",
	exceptionalAuthors: {
		"[email protected]": "John Doe"
	}
}, function( error, commits ) {
	console.log( commits );
});

API

person objects

Person objects represent authors, committers, and signers. They are plain objects with the following properties:

  • name (String): The person's name.
  • email (String): The person's email.

commit objects

Commit objects represent a single commit within a repository. They are plain objects with the following properties:

  • hash (String): The SHA-1 for the commit.
  • author (Object): A person object containing the author's information.
  • committer (Object): A person object containing the committer's information.
  • license (Array): An array of person objects containing all signers of the commit.

dco.getCommits( options, callback )

Gets commit and signature information for a repository.

  • options (Object): Options for getting the commits.
    • path (String): The path to the repository.
    • committish (String): Committish range to analyze.
    • exceptionalAuthors (Object): A hash of email addresses and names for authors who may commit without signing their commits.
  • callback (Function; function( error, commits )): Function to invoke after getting the commits.

dco.getCommitErrors( options, callback )

Gets commit errors for a repositry. Errors include invalid email addresses for authors, committers, and signers, as well as missing signatures for commits.

  • options (Object): Options for getting the commits.
    • path (String): The path to the repository.
    • committish (String): Committish range to analyze.
    • exceptionalAuthors (Object): A hash of email addresses and names for authors who may commit without signing their commits.
  • callback (Function; function( error, errors, commits )): Function to invoke after determining the commit errors.
    • errors (Array): An array of error messages for each invalid commit.
    • commits (Array): An array of commit objects for the repository.

License

Copyright 2014 Scott González. Released under the terms of the MIT license.


Support this project by donating on Gittip.