Absent Files

Getting Started

These instructions will get you a copy of absent-files on your local machine.

Installing

absent-files is available via npm

npm i absent-files --save

Built With

• node-tap - Unit testing
• lodash - Default options

Versioning

We use SemVer for versioning.

Contributing

If you would like to contribute to this project, first of all, thank you. Checkout the CONTRIBUTING file before you make a Pull Request.

Authors

• Martin Cox - Initial work

License

This project is licensed under the MIT License - see the LICENSE file for details

Usage

This is how you can use absent-files.

Basic Usage

The most basic usage of absent-files

With the following structure in the ./ directory (absent-files is case insensitive):

• README.md
• LICENSE
• changelog.md

Example

const absentFiles = require('absent-files')

absentFiles(['readme.md', 'license', 'changelog.md'], './').then(result => {
    console.log(result)
})
// output: false
// "Indicating that no files are absent"

However, with the following structure in the ./ directory:

• README
• LICENSE
• changelog

absent-files outputs an Array of the files that are absent.

// These files are absent from the provided directory
// output: ['readme.md', 'changelog.md']

Advanced Usage

You can however provid an options Object with the property ignoreExtensions set to true to ignore the extensions of filenames when checking.

With the following structure in the ./ directory:

• README
• LICENSE
• changelog

Example

const absentFiles = require('absent-files')

absentFiles(['readme.md', 'license', 'changelog.md'], './', { ignoreExtensions: true }).then(result => {
    console.log(result)
})
// output: false

API Reference

Below is absent-files's API reference.

Note: You can either supply the first two arguments as files and directory followed by an optional options Object. Or you can just provide an options Object (with files and directory properties) as the only argument to absent-files.

files

File(s) to check for

• Type: Array|String
• Required: true
• Default: none

Example

const absentFiles = require('absent-files')

absentFiles({
    files: 'LICENSE',
    directory: './'
}).then(result => {
    console.log(result)
})

directory

Directory to search for files in

• Type: String
• Required: true
• Default: none

Example

const absentFiles = require('absent-files')

absentFiles({
    files: 'index.js',
    directory: 'path/to/my/files'
}).then(result => {
    console.log(result)
})

ignoreExtensions

Whether or not to ignore extensions when checking the files

• Type: Boolean
• Default: false

Example

const absentFiles = require('absent-files')

absentFiles({
    files: 'index.js',
    directory: 'path/to/my/files',
    ignoreExtensions: true
}).then(result => {
    console.log(result)
})
// Will match `index.js` or `index`

caseSensitive

Whether or not use case sensitivity when checking for files

• Type: Boolean
• Default: false

Example

const absentFiles = require('absent-files')

absentFiles({
    files: 'README.md',
    directory: './',
    caseSensitive: true
}).then(result => {
    console.log(result)
})
// Will only match `README.md` and not `readme.md`