pax_global_header00006660000000000000000000000064131415041130014503gustar00rootroot0000000000000052 comment=9454484372bf7f49cc9eecf4324d1f918f698e96 detect-file-1.0.0/000077500000000000000000000000001314150411300136665ustar00rootroot00000000000000detect-file-1.0.0/.editorconfig000066400000000000000000000004051314150411300163420ustar00rootroot00000000000000root = true [*] indent_style = space end_of_line = lf charset = utf-8 indent_size = 2 trim_trailing_whitespace = true insert_final_newline = true [{**/{actual,fixtures,expected,templates}/**,*.md}] trim_trailing_whitespace = false insert_final_newline = falsedetect-file-1.0.0/.eslintrc.json000066400000000000000000000071251314150411300164670ustar00rootroot00000000000000{ "ecmaFeatures": { "modules": true, "experimentalObjectRestSpread": true }, "env": { "browser": false, "es6": true, "node": true, "mocha": true }, "globals": { "document": false, "navigator": false, "window": false }, "rules": { "accessor-pairs": 2, "arrow-spacing": [2, { "before": true, "after": true }], "block-spacing": [2, "always"], "brace-style": [2, "1tbs", { "allowSingleLine": true }], "comma-dangle": [2, "never"], "comma-spacing": [2, { "before": false, "after": true }], "comma-style": [2, "last"], "constructor-super": 2, "curly": [2, "multi-line"], "dot-location": [2, "property"], "eol-last": 2, "eqeqeq": [2, "allow-null"], "generator-star-spacing": [2, { "before": true, "after": true }], "handle-callback-err": [2, "^(err|error)$" ], "indent": [2, 2, { "SwitchCase": 1 }], "key-spacing": [2, { "beforeColon": false, "afterColon": true }], "keyword-spacing": [2, { "before": true, "after": true }], "new-cap": [2, { "newIsCap": true, "capIsNew": false }], "new-parens": 2, "no-array-constructor": 2, "no-caller": 2, "no-class-assign": 2, "no-cond-assign": 2, "no-const-assign": 2, "no-control-regex": 2, "no-debugger": 2, "no-delete-var": 2, "no-dupe-args": 2, "no-dupe-class-members": 2, "no-dupe-keys": 2, "no-duplicate-case": 2, "no-empty-character-class": 2, "no-eval": 2, "no-ex-assign": 2, "no-extend-native": 2, "no-extra-bind": 2, "no-extra-boolean-cast": 2, "no-extra-parens": [2, "functions"], "no-fallthrough": 2, "no-floating-decimal": 2, "no-func-assign": 2, "no-implied-eval": 2, "no-inner-declarations": [2, "functions"], "no-invalid-regexp": 2, "no-irregular-whitespace": 2, "no-iterator": 2, "no-label-var": 2, "no-labels": 2, "no-lone-blocks": 2, "no-mixed-spaces-and-tabs": 2, "no-multi-spaces": 2, "no-multi-str": 2, "no-multiple-empty-lines": [2, { "max": 1 }], "no-native-reassign": 0, "no-negated-in-lhs": 2, "no-new": 2, "no-new-func": 2, "no-new-object": 2, "no-new-require": 2, "no-new-wrappers": 2, "no-obj-calls": 2, "no-octal": 2, "no-octal-escape": 2, "no-proto": 0, "no-redeclare": 2, "no-regex-spaces": 2, "no-return-assign": 2, "no-self-compare": 2, "no-sequences": 2, "no-shadow-restricted-names": 2, "no-spaced-func": 2, "no-sparse-arrays": 2, "no-this-before-super": 2, "no-throw-literal": 2, "no-trailing-spaces": 0, "no-undef": 2, "no-undef-init": 2, "no-unexpected-multiline": 2, "no-unneeded-ternary": [2, { "defaultAssignment": false }], "no-unreachable": 2, "no-unused-vars": [2, { "vars": "all", "args": "none" }], "no-useless-call": 0, "no-with": 2, "one-var": [0, { "initialized": "never" }], "operator-linebreak": [0, "after", { "overrides": { "?": "before", ":": "before" } }], "padded-blocks": [0, "never"], "quotes": [2, "single", "avoid-escape"], "radix": 2, "semi": [2, "always"], "semi-spacing": [2, { "before": false, "after": true }], "space-before-blocks": [2, "always"], "space-before-function-paren": [2, "never"], "space-in-parens": [2, "never"], "space-infix-ops": 2, "space-unary-ops": [2, { "words": true, "nonwords": false }], "spaced-comment": [0, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }], "use-isnan": 2, "valid-typeof": 2, "wrap-iife": [2, "any"], "yoda": [2, "never"] } } detect-file-1.0.0/.gitattributes000066400000000000000000000002001314150411300165510ustar00rootroot00000000000000# Enforce Unix newlines * text eol=lf # binaries *.ai binary *.psd binary *.jpg binary *.gif binary *.png binary *.jpeg binary detect-file-1.0.0/.gitignore000066400000000000000000000004401314150411300156540ustar00rootroot00000000000000# always ignore files *.DS_Store *.sublime-* # test related, or directories generated by tests test/actual actual coverage .nyc* # npm node_modules npm-debug.log # yarn yarn.lock yarn-error.log # misc _gh_pages _draft _drafts bower_components vendor temp tmp TODO.md package-lock.jsondetect-file-1.0.0/.travis.yml000066400000000000000000000002401314150411300157730ustar00rootroot00000000000000sudo: false os: - linux - osx language: node_js node_js: - node - '8' - '7' - '6' - '5' - '4' - '0.12' - '0.10' matrix: fast_finish: true detect-file-1.0.0/.verb.md000066400000000000000000000010531314150411300152230ustar00rootroot00000000000000## Usage ```js var detect = require('{%= name %}'); ``` ## API {%= apidocs("index.js") %} ## 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`. 1. 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. detect-file-1.0.0/LICENSE000066400000000000000000000020771314150411300147010ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2016-2017, Brian Woodward. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.detect-file-1.0.0/README.md000066400000000000000000000071201314150411300151450ustar00rootroot00000000000000# detect-file [![NPM version](https://img.shields.io/npm/v/detect-file.svg?style=flat)](https://www.npmjs.com/package/detect-file) [![NPM monthly downloads](https://img.shields.io/npm/dm/detect-file.svg?style=flat)](https://npmjs.org/package/detect-file) [![NPM total downloads](https://img.shields.io/npm/dt/detect-file.svg?style=flat)](https://npmjs.org/package/detect-file) [![Linux Build Status](https://img.shields.io/travis/doowb/detect-file.svg?style=flat&label=Travis)](https://travis-ci.org/doowb/detect-file) [![Windows Build Status](https://img.shields.io/appveyor/ci/doowb/detect-file.svg?style=flat&label=AppVeyor)](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._detect-file-1.0.0/appveyor.yml000066400000000000000000000012111314150411300162510ustar00rootroot00000000000000# Test against this version of Node.js environment: matrix: # node.js - nodejs_version: "8.0" - nodejs_version: "7.0" - nodejs_version: "6.0" - nodejs_version: "5.0" - nodejs_version: "4.0" - nodejs_version: "0.12" - nodejs_version: "0.10" # Install scripts. (runs after repo cloning) install: # Get the latest stable version of Node.js or io.js - ps: Install-Product node $env:nodejs_version # install modules - npm install # Post-install test scripts. test_script: # Output useful info for debugging. - node --version - npm --version # run tests - npm test # Don't actually build. build: off detect-file-1.0.0/fixtures/000077500000000000000000000000001314150411300155375ustar00rootroot00000000000000detect-file-1.0.0/fixtures/a/000077500000000000000000000000001314150411300157575ustar00rootroot00000000000000detect-file-1.0.0/fixtures/a/B/000077500000000000000000000000001314150411300161405ustar00rootroot00000000000000detect-file-1.0.0/fixtures/a/B/aBc/000077500000000000000000000000001314150411300166255ustar00rootroot00000000000000detect-file-1.0.0/fixtures/a/B/aBc/DeF/000077500000000000000000000000001314150411300172635ustar00rootroot00000000000000detect-file-1.0.0/fixtures/a/B/aBc/DeF/MixedCaseFile.txt000066400000000000000000000000001314150411300224540ustar00rootroot00000000000000detect-file-1.0.0/index.js000066400000000000000000000053311314150411300153350ustar00rootroot00000000000000/*! * detect-file * * Copyright (c) 2016-2017, Brian Woodward. * Released under the MIT License. */ 'use strict'; var fs = require('fs'); var path = require('path'); /** * Detect the given `filepath` if it exists. * * ```js * var res = detect('package.json'); * console.log(res); * //=> "package.json" * * var res = detect('fake-file.json'); * console.log(res) * //=> null * ``` * * @param {String} `filepath` filepath to detect. * @param {Object} `options` Additional options. * @param {Boolean} `options.nocase` Set this to `true` to force case-insensitive filename checks. This is useful on case sensitive file systems. * @return {String} Returns the detected filepath if it exists, otherwise returns `null`. * @api public */ module.exports = function detect(filepath, options) { if (!filepath || (typeof filepath !== 'string')) { return null; } if (fs.existsSync(filepath)) { return path.resolve(filepath); } options = options || {}; if (options.nocase === true) { return nocase(filepath); } return null; }; /** * Check if the filepath exists by falling back to reading in the entire directory. * Returns the real filepath (for case sensitive file systems) if found. * * @param {String} `filepath` filepath to check. * @return {String} Returns found filepath if exists, otherwise null. */ function nocase(filepath) { filepath = path.resolve(filepath); var res = tryReaddir(filepath); if (res === null) { return null; } // "filepath" is a directory, an error would be // thrown if it doesn't exist. if we're here, it exists if (res.path === filepath) { return res.path; } // "filepath" is not a directory // compare against upper case later // see https://nodejs.org/en/docs/guides/working-with-different-filesystems/ var upper = filepath.toUpperCase(); var len = res.files.length; var idx = -1; while (++idx < len) { var fp = path.resolve(res.path, res.files[idx]); if (filepath === fp || upper === fp) { return fp; } var fpUpper = fp.toUpperCase(); if (filepath === fpUpper || upper === fpUpper) { return fp; } } return null; } /** * Try to read the filepath as a directory first, then fallback to the filepath's dirname. * * @param {String} `filepath` path of the directory to read. * @return {Object} Object containing `path` and `files` if succesful. Otherwise, null. */ function tryReaddir(filepath) { var ctx = { path: filepath, files: [] }; try { ctx.files = fs.readdirSync(filepath); return ctx; } catch (err) {} try { ctx.path = path.dirname(filepath); ctx.files = fs.readdirSync(ctx.path); return ctx; } catch (err) {} return null; } detect-file-1.0.0/package.json000066400000000000000000000021121314150411300161500ustar00rootroot00000000000000{ "name": "detect-file", "description": "Detects if a file exists and returns the resolved filepath.", "version": "1.0.0", "homepage": "https://github.com/doowb/detect-file", "author": "Brian Woodward (https://github.com/doowb)", "repository": "doowb/detect-file", "bugs": { "url": "https://github.com/doowb/detect-file/issues" }, "license": "MIT", "files": [ "index.js" ], "main": "index.js", "engines": { "node": ">=0.10.0" }, "scripts": { "test": "mocha" }, "dependencies": {}, "devDependencies": { "gulp-format-md": "*", "mocha": "*" }, "keywords": [ "detect", "exists", "file", "file exists", "file-path", "filepath", "path", "resolve", "resolve file", "resolve filepath" ], "verb": { "layout": "default", "tasks": [ "readme" ], "plugins": [ "gulp-format-md" ], "related": { "list": [ "fs-exists-sync" ] }, "reflinks": [ "verb", "verb-readme-generator" ], "lint": { "reflinks": true } } } detect-file-1.0.0/test.js000066400000000000000000000043441314150411300152100ustar00rootroot00000000000000'use strict'; require('mocha'); var path = require('path'); var assert = require('assert'); var detect = require('./'); var isLinux = process.platform === 'linux'; describe('detect', function() { it('should export a function', function() { assert.equal(typeof detect, 'function'); }); it('should be truthy a file exists', function() { assert(detect('README.md')); assert(detect('LICENSE')); }); it('should not be case sensitive', function() { assert(detect('readme.md', {nocase: isLinux})); assert(detect('license', {nocase: isLinux})); }); it('should return filepath when a file exists', function() { assert.equal(detect('README.md'), path.resolve('README.md')); assert.equal(detect('LICENSE'), path.resolve('LICENSE')); }); it('should handle case sensitive names on linux', function() { assert.equal(detect('readme.md', {nocase: true}), path.resolve(isLinux ? 'README.md' : 'readme.md')); assert.equal(detect('license', {nocase: true}), path.resolve(isLinux ? 'LICENSE' : 'license')); if (isLinux) { assert(!detect('readme.md'), 'expected null when not using the sensitive flag on linux'); assert(!detect('license'), 'expected null when not using the sensitive flag on linux'); } }); it('should handle case sensitive full filepaths on linux', function() { var fp = path.resolve('fixtures/a/B/aBc/DeF/mixedcasefile.txt'); assert.equal(detect(fp, {nocase: true}), path.resolve(isLinux ? 'fixtures/a/B/aBc/DeF/MixedCaseFile.txt' : 'fixtures/a/B/aBc/DeF/mixedcasefile.txt')); if (isLinux) { assert(!detect(fp), 'expected null when not using the sensitive flag on linux'); } }); it('should return resolve filepath for directories', function() { assert(detect('.')); assert(detect('fixtures')); assert(detect(process.cwd())); }); it('should return null when a file does not exist', function() { assert(!detect()); assert(!detect('')); assert(!detect('foofofo')); assert(!detect('foofofo.txt')); assert(!detect(path.resolve('fixtures/a/b/c/missing-file.txt'), {nocase: true})); }); it('should return null when a directory does not exist', function() { assert(!detect('lib/')); assert(!detect('whatever/')); }); });