Nearsighted Paramecium Multiverse

    @magic/fs

    0.0.27 • Public • Published

    @magic/fs

    exports all fs.promises + exists + mkdirp + rmrf + getFiles + getDirs functions.

    NPM version Linux Build Status Windows Build Status Coverage Status Greenkeeper badge Known Vulnerabilities

    html-docs

    installation

    be in a nodejs project

    npm install @magic/fs

    import

    import fs from '@magic/fs'
    
    const run = async () => {
      await fs.mkdirp('./test_235235/dir/to/create')
      console.log('dir created')
      await fs.rmrf('./test_235235')
      console.log('dir deleted, even though it had contents.')
    }
    run()

    promises

    promises from fs:

    access
    copyFile
    open
    opendir
    rename
    truncate
    rmdir
    mkdir
    readdir
    readlink
    symlink
    lstat
    stat
    link
    unlink
    chmod
    lchmod
    lchown
    chown
    utimes
    realpath
    mkdtemp
    writeFile
    appendFile
    readFile
    exists
    readDir
    readfile
    rmDir
    

    export overloads:

    rmdir, rmDir
    readfile, readFile
    readdir, readDir

    Additional functions:

    mkdirp

    same as mkdir -p on unix

    await fs.mkdirp('./path/to/dir')

    rmrf

    same as rm -rf on unix.

    will not work outside process.cwd()

    await fs.rmrf('./path/to/dir')

    exists

    same as fs.exists, but promisified and ready for esmodules.

    getDirectories

    get a list of directories in a directory, recursively.

    import fs from '@magic/fs'
    
    const run = async () => {
      // first level directories
      const directories = await fs.getDirectories(process.cwd(), false)
      console.log(directories)
    
      // first level again
      const dirs = await fs.getDirectories(process.cwd(), { depth: false })
    
      // recursive run
      const deepDirectories = await fs.getDirectories(process.cwd())
      console.log(deepDirectories)
    
      // recursive run with specified depth
      const deepDirectoriesDepth2 = await fs.getDirectories(process.cwd(), { depth: 2 })
      console.log(deepDirectoriesDepth2)
    
      // use /some/dir as root instead of process.cwd()
      const deepDirWithRoot = await fs.getDirectories(process.cwd(), { depth: true, root: '/some/dir' })
      console.log(deepDirWithRoot)
    }
    run()

    getFiles

    get a list of files in a directory, recursively.

    import fs from '@magic/fs'
    
    const run = async () => {
      // first level directories
      const files = await fs.getFiles(process.cwd())
      console.log(files)
    
      // recursive run
      const deepFiles = await fs.getFiles(process.cwd(), { depth: true })
      console.log(deepFiles)
    
      // recursive run with specified depth,
      const deepFilesDepth2 = await fs.getFiles(process.cwd(), { depth: 2 })
      console.log(deepFilesDepth2)
    }
    run()

    getFileType

    get the file type of a file, based on extension, and defaulting to "txt"

    import fs from '@magic/fs'
    
    const fileType = fs.getFileType('html.html')
    console.log(fileType, fileType === 'html')
    
    const nonFileType = fs.getFileType()
    console.log(nonFileType, nonFileType === 'txt')

    changelog

    0.0.1

    first release

    0.0.2

    • bump required node version
    • update dependencies

    0.0.3

    better error messages

    0.0.4

    rmrf returns true if directory does not exist.

    0.0.5

    use @magic/mime-types to export contentTypes

    0.0.6

    bump required node version to 14.2.0

    0.0.7

    rmrf: add dryRun option

    0.0.8

    update dependencies

    0.0.9

    • remove unused imports from getDirectories
    • getDirectories and getFiles now accept a number as second argument.
    // if a number is given instead of true/false, then this is the depth of recursion.
    getFiles(directory, 2) // two levels down
    

    0.0.10

    • bump required node version to 14.15.4
    • update dependencies
    0.0.11

    update dependencies (@magic/mime-types)

    0.0.12

    export all functions from native fs

    0.0.13
    • getDirectories, getFiles: default root to process.cwd() if first argument is an array and root is not passed
    • update dependencies
    0.0.14

    update dependencies (@magic/mime-types)

    0.0.15

    update @magic/types to avoid circular dependency

    0.0.16

    add deprecation warning for calls to fs.getDirectories, fs.getFilePath and fs.getFiles that do not use an options object

    0.0.17

    update dependencies

    0.0.18

    update mime-types

    0.0.19

    update dependencies

    0.0.20

    update dependencies

    0.0.21
    • add missing @magic/fs dependency
    • update dependencies
    0.0.22

    update dependencies

    0.0.23

    update dependencies

    0.0.24

    getFiles: allow files to be filtered by extension, using the .extension key of the second parameter

    0.0.25

    update dependencies

    0.0.26

    update dependencies

    0.0.27

    update dependencies

    0.0.28 - unreleased

    ...

    Keywords

    none

    Install

    npm i @magic/fs

    DownloadsWeekly Downloads

    445

    Version

    0.0.27

    License

    AGPL-3.0

    Unpacked Size

    52.1 kB

    Total Files

    14

    Last publish

    Collaborators

    • jascha
    • jaeh