JarCasting
JarCasting JarCasting

package-hash

WebJar for package-hash

License

License

ISC
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

package-hash
Last Version

Last Version

3.0.0
Release Date

Release Date
Type

Type

jar
Description

Description

package-hash
WebJar for package-hash
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/novemberborn/package-hash

Download package-hash

Filename Size
package-hash-3.0.0.pom
package-hash-3.0.0.jar 6 KB
package-hash-3.0.0-sources.jar 22 bytes
package-hash-3.0.0-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/package-hash/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>package-hash</artifactId>
    <version>3.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/package-hash/
implementation 'org.webjars.npm:package-hash:3.0.0'
// https://jarcasting.com/artifacts/org.webjars.npm/package-hash/
implementation ("org.webjars.npm:package-hash:3.0.0")
'org.webjars.npm:package-hash:jar:3.0.0'
<dependency org="org.webjars.npm" name="package-hash" rev="3.0.0">
  <artifact name="package-hash" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='package-hash', version='3.0.0')
)
libraryDependencies += "org.webjars.npm" % "package-hash" % "3.0.0"
[org.webjars.npm/package-hash "3.0.0"]

Dependencies

compile (4)

Group / Artifact Type Version
org.webjars.npm : graceful-fs jar [4.1.15,5)
org.webjars.npm : hasha jar [3.0.0,4)
org.webjars.npm : lodash.flattendeep jar [4.4.0,5)
org.webjars.npm : release-zalgo jar [1.0.0,2)

Project Modules

There are no modules declared in this project.

package-hash

Generates a hash for an installed npm package, useful for salting caches. AVA for example caches precompiled test files. It generates a salt for its cache based on the various packages that are used when compiling the test files.

package-hash can generate an appropriate hash based on the package location (on disk) and the package.json file. This hash is salted with a hash for the package-hash itself.

package-hash can detect when the package-to-be-hashed is a Git repository. In the AVA example this is useful when you're debugging one of the packages used to compile the test files. You can clone it locally and use npm link so AVA can find the clone. The hash will include the HEAD (.git/HEAD) and its corresponding ref (e.g. .git/refs/heads/master), any packed refs (.git/packed-refs), as well as the diff (git diff) for any non-committed changes. This makes it really easy to test your changes without having to explicitly clear the cache in the parent project.

Installation

$ npm install --save package-hash

Usage

const packageHash = require('package-hash')

// Asynchronously:
const hash = await packageHash(require.resolve('babel-core/package.json'))

// Synchronously:
const hash = packageHash.sync(require.resolve('babel-core/package.json'))

packageHash() / packageHash.sync() must be called with a file path for an existing package.json file. To get the path to an npm package it's easiest to use require.resolve('the-name/package.json').

You can provide multiple paths:

const hash = await packageHash([
  require.resolve('babel-core/package.json'),
  require.resolve('babel-preset-es2015/package.json')
])

An optional salt value can also be provided:

const hash = await packageHash(require.resolve('babel-core/package.json'), 'salt value')

API

packageHash(paths, salt?)

paths: string | string[] ➜ can be a single file path, or an array of paths.

salt: Array | Buffer | Object | string ➜ optional. If an Array or Object (not null) it is first converted to a JSON string.

Returns a promise for the hex-encoded hash string.

packageHash.sync(paths, salt?)

paths: string | string[] ➜ can be a single file path, or an array of paths.

salt: Array | Buffer | Object | string ➜ optional. If an Array or Object (not null) it is first converted to a JSON string.

Returns a hex-encoded hash string.

Compatibility

package-hash has been tested with Node.js 8 and above, including Windows support.

Versions

Version
3.0.0