dat-ignore

    2.1.2 • Public • Published

    dat-ignore

    default ignore for dat

    npm travis standard

    Check if a file should be ignored for Dat:

    • Ignore .dat by default
    • Use the .datignore file
    • Optionally ignore all hidden files
    • Add in other custom ignore matches

    Install

    npm install dat-ignore
    

    Usage

    var datIgnore = require('dat-ignore')
    var ignore = datIgnore('/data/dir')
     
    console.log(ignore('.dat')) // true
    console.log(ignore('.git')) // true
    console.log(ignore('dat-data')) // false
    console.log(ignore('cat.jpg')) // false

    Uses anymatch to match file paths.

    Example Options

    Common configuration options.

    Add custom ignore

    var ignore = datIgnore('/data/dir', {
        ignore: [
          '**/node_modules/**', 
          'path/to/file.js',
          'path/anyjs/**/*.js'
        ]
      })

    Allow Hidden Files

    var ignore = datIgnore('/data/dir', { ignoreHidden: false })

    Change Dat Ignore Path

    var ignore = datIgnore('/data/dir', {
        datignorePath: '~/.datignore'
      })

    .datignore as string/buffer

    Pass in a string as a newline delimited list of things to ignore.

    var datIgnoreFile = fs.readFileSync('~/.datignore')
    datIgnoreFile += '\n' + fs.readFileSync(path.join(dir, '.datignore'))
    datIgnoreFile += '\n' + fs.readFileSync(path.join(dir, '.gitignore'))
     
    var ignore = datIgnore('/data/dir', { datignore: datIgnoreFile })

    API

    var ignore = datIgnore(dir, [opts])

    Returns a function that checks if a path should be ignored:

    ignore('.dat') // true
    ignore('.git') // true
    ignore('data/cats.csv') // false

    dir

    dir is the file root to compare to. It is also used to find .datignore, if not specified.

    Options:

    • opts.ignore - Extend custom ignore with any anymatch string or array.
    • opts.useDatIgnore - Use the .datignore file in dir (default: true)
    • opts.ignoreHidden - Ignore all hidden files/folders (default: true)
    • opts.datignorePath - Path to .datignore file (default: dir/.datignore)
    • opts.datignore - Pass .datignore as buffer or string

    License

    MIT

    Keywords

    Install

    npm i dat-ignore

    DownloadsWeekly Downloads

    128

    Version

    2.1.2

    License

    MIT

    Unpacked Size

    11.6 kB

    Total Files

    7

    Last publish

    Collaborators

    • karissa
    • maxogden
    • yoshuawuyts
    • mafintosh
    • jhand
    • rangermauve
    • juliangruber
    • zootella
    • serapath
    • ninabreznik
    • cblgh
    • frando
    • pfrazee
    • the-real-dk
    • leichtgewicht