Create a hash checksum over a folder or a file.
The hashes are propagated upwards, the hash that is returned for a folder is generated over all the hashes of its children.
The hashes are generated with the sha1 algorithm and returned in base64 encoding.
The returned information looks like this:
{ name: 'test',
hash: 'qmUXLCsTQGOEF6p0w9V78MC7sJI=',
children: [
{ name: 'helper',
hash: 'x1CX3yVH3UuLTw7zcSitSs/PbGE=',
children: [
{ name: 'helper.js', hash: 'pHYwd8k/oZV01oABTz9MC8KovkU=' }
] },
{ name: 'test.js', hash: 'L/vqpdQhxmD5w62k24m4TuZJ1PM=' }
]
}
Each file returns a name and a hash, and each folder returns additionally an array of children (file or folder elements).
First, install the dependencies by executing npm install.
var hasher = require('folder-hash');
// pass element name and folder path separately
hasher.hashElement('node_modules', __dirname).then(function (hash) {
console.log('Result for folder "node_modules" in directory "' + __dirname + '":');
console.log(hash.toString());
});
// pass element path directly
hasher.hashElement(__dirname).then(function (hash) {
console.log('Result for folder "' + __dirname + '":');
console.log(hash.toString());
});
// pass options (example: exclude dotFiles)
var options = { excludes: ['.*'], match: { basename: true, path: false } };
hasher.hashElement(__dirname, options, function (error, hash)) {
if (error) return console.error('hashing failed:', error);
console.log('Result for folder "' + __dirname + '":');
console.log(hash.toString());
});
var hasher = require('folder-hash');
// pass element name and folder path separately
hasher.hashElement('node_modules', __dirname, function (error, hash)) {
if (error) return console.error('hashing failed:', error);
console.log('Result for folder "node_modules" in directory "' + __dirname + '":');
console.log(hash.toString());
});
// pass element path directly
hasher.hashElement(__dirname, function (error, hash)) {
if (error) return console.error('hashing failed:', error);
console.log('Result for folder "' + __dirname + '":');
console.log(hash.toString());
});
// pass options (example: exclude dotFiles)
var options = { excludes: ['**/.*'], match: { basename: false, path: true } };
hasher.hashElement(__dirname, options, function (error, hash)) {
if (error) return console.error('hashing failed:', error);
console.log('Result for folder "' + __dirname + '":');
console.log(hash.toString());
});
| Name | Type | Attributes | Description |
|---|---|---|---|
| name | string | element name or an element's path | |
| dir | string |
<optional> |
directory that contains the element (if omitted is generated from name) |
| options | Object |
<optional> |
Options object (see below) |
| callback | fn |
<optional> |
Error-first callback function |
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
| algo | string |
<optional> |
'sha1' | checksum algorithm, see options in crypto.getHashes() |
| encoding | string |
<optional> |
'base64' | encoding of the resulting hash. One of 'base64', 'hex' or 'binary' |
| excludes | Array.<string> |
<optional> |
[] | Array of optional exclude file glob patterns, see minimatch doc |
| match.basename | bool |
<optional> |
true | Match the exclude patterns to the file/folder name |
| match.path | bool |
<optional> |
true | Match the exclude patterns to the file/folder path |
The behavior is documented and verified in the unit tests. Execute npm test or mocha test, and have a look at the test subfolder.
The hashes are the same if:
- A file is checked again
- Two files have the same name and content (but exist in different folders)
The hashes are different if:
- A file was renamed or its content was changed
- Two files have the same name but different content
- Two files have the same content but different names
Content means in this case a folders children - both the files and the subfolders with their children.
The hashes are the same if:
- A folder is checked again
- Two folders have the same name and content (but have different parent folders)
The hashes are different if:
- A file somewhere in the directory structure was renamed or its content was changed
- Two folders have the same name but different content
- Two folders have the same content but different names
MIT, see LICENSE.txt
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent