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

glob-hash

v1.0.5

Published

npm module to hash the contents of files matched by globs

Downloads

925

Readme

glob-hash

npm module to hash the contents of files matched by globs

MIT License Badge npm Build Status Build status Code Climate

Via Command line

Install

npm install -g glob-hash

Use

Note: option -i/--include is mandatory

Usage: glob-hash [options]

Options:

-h, --help                output usage information
-V, --version             output the version number
-i, --include <glob>      Files to include. Mandatory. May be used multiple times.
-e, --exclude [glob]      Files to exclude. May be used multiple times.
-a, --algorithm [string]  The hashing algorithm to use. Defaults to "sha256".
-f, --files               Show matched files and exit.
-j, --jail [path]         A jail path. Reading outside the jail path will throw an error.
-n, --filenames           Include filenames in the hash.

Via API

Install

npm install glob-hash --save

Use

Sample

var globHash = require('glob-hash');

globHash(options)
.then(function(hash) {
    console.log(hash);
}, function(error) {
    console.log(error);
});

Options

Array include - An array of globs used to match the files to hash. Mandatory option.

Array exclude - An array of globs to exclude from the search.

String algorithm - The hashing algorithms to use. Defaults to "sha256", see crypto.getHashes.

Boolean files - Returns an array of files matched by the globs, instead of returning the hash.

String jail - A jail path. Reading outside the jail path will throw an error. Defaults to never throwing.

Boolean filenames - Include filename in the file hash. If used in combination with jail path, filename includes relative path from jail, otherwise it includes full path.

More samples

// Get hash
globHash({
    include: ['src/**/*.js', '**/*.json'],
    exclude: ['package.json'],
    algorithm: 'sha256' // This is the default
})
.then(
    function(result) {
        console.log(result);
    },
    function(error) {
        console.log(error);
    }
);
// Get list of matched files
globHash({
    include: ['src/**/*.js', '**/*.json'],
    exclude: ['package.json'],
    files: true
})
.then(
    function(result) {
        console.log(result);
    },
    function(error) {
        console.log(error);
    }
);

Test

npm test