Neutralize Pesky Miscreants

    auto-hash
    TypeScript icon, indicating that this package has built-in type declarations

    0.5.0 • Public • Published

    auto-hash

    npm README_CHINESE Coverage Status

    automatically create hash info for files

    Features

    • automatically generate MD5 for all files in list
    • output all heshes as an Object to the target file
    • add hash value to filename originalFilename.hash.ext(rename or create a copy of the original file)

    Install

    npm install auto-hash
    

    or

    yarn add auto-hash
    

    Usage

    run as Node.js script directly

    autohash -c auto-hash.config.json
    // add -c or -config to set configuration file

    import autoHash as a module

    const autoHash = require('auto-hash');
    autoHash({
      config: './auto-hash.config.json',
    });
    // add 'c' or 'config' to set configuration file
    // or you can pass configuration directly
    autoHash({
      files: [{
        file: "test/index.js",
        name: "testIndex"
      }],
      output: {
        file: "test/test-hash.js"
      },
      len: 8,
      rename: false,
      copy: true
    });

    output example

    • return as an object when call autoHash()
    { testIndex: '5745abcc' }
    • output as a file when output.file is provided (the object will still be returned in autoHash())
    module.exports = { testIndex: '5745abcc' };

    About file path

    ! All file paths shoud be relative to working directory

    Configuration example

    configuration file is in .json

    {
      // 'files' is the list that contains all files to be hashing
      "files": [
        {
          "file": "src/index.js", // (required) set file path in 'file' property
          "name": "index" // (optional) set 'name' property to change the property of hash in output object, default to filename
        }
      ],
      "output": {
        "file": "src/auto-hash.js" // (optional) path of output file
      },
      "len": 10, // (optional) the length of hash string to be used, default to full string.
      "rename": false, // (optional, false) rename the original file to originalFilename.hash.ext
      "copy": true // (optional, false) create a copy in originalFilename.hash.ext
    }
    

    LICENSE

    MIT License

    Copyright (c) 2017 Cheng Gu

    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.

    Install

    npm i auto-hash

    DownloadsWeekly Downloads

    8

    Version

    0.5.0

    License

    MIT

    Last publish

    Collaborators

    • gucheen