https://github.com/focusaurus/writers-digest

Store files on disk by digest a la .git/objects
https://github.com/focusaurus/writers-digest

Last synced: 12 days ago
JSON representation

Store files on disk by digest a la .git/objects

• Host: GitHub
• URL: https://github.com/focusaurus/writers-digest
• Owner: focusaurus
• Created: 2012-08-04T14:38:46.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-03-03T03:14:48.000Z (over 6 years ago)
• Last Synced: 2024-09-16T23:28:34.514Z (2 months ago)
• Language: JavaScript
• Size: 41 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# writers-digest

Store files on disk based on their SHA1 digest the way git does.

Each file is digested with tha Secure Hash Algorithm SHA1 method and stored on disk based on this 40-character hexidecimal value. A parent directory is created based on the first two characters of the digest, and the remaining 38 characters become the filename within that parent directory.

For example, given a digest of `68ce1ed198f097294448ab7a47e4c4922ef46048`, the files will be stored at path `68/ce1ed198f097294448ab7a47e4c4922ef46048`.

This module exports a single function with the following parameters:

- filePath

  - path to the existing file to store

  - can be relative or absolute

  - this file will be moved (renamed, not copied) into the destination location

- baseDir (optional)

  - base directory for the tree of files stored by digest

  - if omitted, files will be stored below the current directory

- callback

  - callback function arguments:

    - error (if any operations fail)

    - result (on success)

       - this will be an object with attributes:

       - path: full path to the stored file

       - digest: the 40-char hexidecimal SHA1 digest of the file

## Example usage

```javascript

var store = require('writers-digest')

store('someFile', function (error, result) {

  // 'someFile' has been moved to path result.path

  // result.digest is the hexidecimal SHA1 digest of the contents of 'someFile'

  console.dir(result)

})

```

## Badges

[![Build Status](https://semaphoreci.com/api/v1/focusaurus/writers-digest/branches/master/badge.svg)](https://semaphoreci.com/focusaurus/writers-digest)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Greenkeeper badge](https://badges.greenkeeper.io/focusaurus/writers-digest.svg)](https://greenkeeper.io/)

## License: MIT License

Copyright (c) 2016 Peter Lyons LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.