fs Utils

npm version Testing codecov

Extended functionality for fs, when you need to know something in disk exists or want to ensure it exists.

Install

Copy 
npm install @universal-packages/fs-utils

Global methods

checkDirectory(location: String)

Checks if a string is a valid path to a directory and expands it. It throw verbose errors depending on why the directory is not valid.

Copy 
import { checkDirectory } from '@universal-packages/fs-utils'

const finalPath = checkDirectory('./src')

console.log(finalPath)

// > /Users/david/project/src
Copy 
import { checkDirectory } from '@universal-packages/fs-utils'

try {
  const finalPath = checkDirectory('./src/fake')
} catch (error) {
  console.log(error)
}

// > Error "/Users/david/project/src/fake" does not exists
// > Error "/Users/david/project/src/fake" is not a directory or can not be accessed

quickCheckDirectory(location: String)

It does the same as checkDirectory but returns false if the directory is not valid instead of throwing an error.

Copy 
import { quickCheckDirectory } from '@universal-packages/fs-utils'

const finalPath = quickCheckDirectory('./src/fake')

console.log(finalPath)

// > false

checkFile(location: String)

Checks if a string is a valid path to a file and expands it. It throw verbose errors depending on why the file is not valid.

Copy 
import { checkFile } from '@universal-packages/fs-utils'

const finalPath = checkFile('./src/README.md')

console.log(finalPath)

// > /Users/david/project/src/README.md
Copy 
import { checkFile } from '@universal-packages/fs-utils'

try {
  const finalPath = checkFile('./src/NOT.md')
} catch (error) {
  console.log(error)
}

// > Error "/Users/david/project/src/NOT.md" does not exists
// > Error "/Users/david/project/src/NOT.md" is not a file or can not be accessed

quickCheckFile(location: String)

It does the same as checkFile but throw verbose errors depending on why the file is not valid.

Copy 
import { quickCheckFile } from '@universal-packages/fs-utils'

const finalPath = quickCheckFile('./src/README.md')

console.log(finalPath)

// > /Users/david/project/src/README.md

ensureDirectory(location: String)

Checks and expand a path and tries to create the directory if the check fails.

Copy 
import { ensureDirectory } from '@universal-packages/fs-utils'

const finalPath = ensureDirectory('./src/tmp')

console.log(finalPath)

// > /Users/david/project/src/tmp

Any other case is thrown as an error.

Copy 
import { ensureDirectory } from '@universal-packages/fs-utils'

try {
  const finalPath = ensureDirectory('/new')
} catch (error) {
  console.log(error)
}

// > Error Directory "/new" is an invalid path or greater permissions are required

ensureFile(location: String)

Checks and expand a path and tries to create an empty file if the check fails

Copy 
import { ensureFile } from '@universal-packages/fs-utils'

const finalPath = ensureFile('./src/tmp/development.log')

console.log(finalPath)

// > /Users/david/project/src/tmp/development.log

Any other case is thrown as an error.

Copy 
import { ensureFile } from '@universal-packages/fs-utils'

try {
  const finalPath = ensureFile('/file.rb')
} catch (error) {
  console.log(error)
}

// > Error File location "/file.rb" is an invalid path or greater permissions are required

expandPath(location: String)

Tries to expand a path by resolving the tilde and resolving to an absolute path.

Copy 
import { expandPath } from '@universal-packages/fs-utils'

console.log(expandPath('./src/tmp'))
console.log(expandPath('~/directory'))

// > /Users/david/directory

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

License

MIT licensed.

Edit this page on GitHub