Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doowb/detect-file
Uses a breadth-first search, when necessary, to resolve the file path using the correct casing, and verify that the file actually exists. Returns consistent results regardless of case sensitivity of the file path and/or operating system.
https://github.com/doowb/detect-file
case-insensitive detect-file-exists file file-exists filepath find-files fs
Last synced: about 2 months ago
JSON representation
Uses a breadth-first search, when necessary, to resolve the file path using the correct casing, and verify that the file actually exists. Returns consistent results regardless of case sensitivity of the file path and/or operating system.
- Host: GitHub
- URL: https://github.com/doowb/detect-file
- Owner: doowb
- License: mit
- Created: 2016-07-06T20:43:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-01T20:26:14.000Z (over 7 years ago)
- Last Synced: 2024-04-26T13:05:10.454Z (8 months ago)
- Topics: case-insensitive, detect-file-exists, file, file-exists, filepath, find-files, fs
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# detect-file [](https://www.npmjs.com/package/detect-file) [](https://npmjs.org/package/detect-file) [](https://npmjs.org/package/detect-file) [](https://travis-ci.org/doowb/detect-file) [](https://ci.appveyor.com/project/doowb/detect-file)
> Detects if a file exists and returns the resolved filepath.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save detect-file
```
Install with [yarn](https://yarnpkg.com):
```sh
$ yarn add detect-file
```
## Usage
```js
var detect = require('detect-file');
```
## API
### [detect](index.js#L33)
Detect the given `filepath` if it exists.
**Params**
* `filepath` **{String}**: filepath to detect.
* `options` **{Object}**: Additional options.
* `options.nocase` **{Boolean}**: Set this to `true` to force case-insensitive filename checks. This is useful on case sensitive file systems.
* `returns` **{String}**: Returns the detected filepath if it exists, otherwise returns `null`.
**Example**
```js
var res = detect('package.json');
console.log(res);
//=> "package.json"
var res = detect('fake-file.json');
console.log(res)
//=> null
```
## Case sensitive file systems
When using the `nocase` option, this library will attempt to detect the filepath with the following methods:
1. Try to read all files in the `filepath` using `fs.readdirSync`. If successful and `filepath` is a directory, return the `filepath`.
2. Try to read all files in the `filepath`'s directory using `fs.readdirSync`. If successful, do case insensitive comparasions of the `filepath` to the files in `filepath`'s directory.
## About
### Related projects
[fs-exists-sync](https://www.npmjs.com/package/fs-exists-sync): Drop-in replacement for `fs.existsSync` with zero dependencies. Other libs I found either have crucial differences… [more](https://github.com/jonschlinkert/fs-exists-sync) | [homepage](https://github.com/jonschlinkert/fs-exists-sync "Drop-in replacement for `fs.existsSync` with zero dependencies. Other libs I found either have crucial differences from fs.existsSync, or unnecessary dependencies. See README.md for more info.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
### Author
**Brian Woodward**
* [github/doowb](https://github.com/doowb)
* [twitter/doowb](https://twitter.com/doowb)
### License
Copyright © 2017, [Brian Woodward](https://github.com/doowb).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on August 05, 2017._