[Pkg-javascript-commits] [node-detect-file] 01/04: Import Upstream version 0.1.0
Sruthi Chandran
srud-guest at moszumanska.debian.org
Tue Nov 1 06:35:07 UTC 2016
This is an automated email from the git hooks/post-receive script.
srud-guest pushed a commit to branch master
in repository node-detect-file.
commit 594334a432f2adc5c14447aa977d5735fa271f23
Author: Sruthi <srud at disroot.org>
Date: Tue Nov 1 10:44:40 2016 +0530
Import Upstream version 0.1.0
---
.editorconfig | 22 +++++
.eslintrc.json | 275 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
.gitattributes | 10 ++
.gitignore | 21 +++++
.travis.yml | 15 +++
.verb.md | 8 ++
LICENSE | 21 +++++
README.md | 90 ++++++++++++++++++
fixtures/.gitkeep | 0
index.js | 110 ++++++++++++++++++++++
package.json | 45 +++++++++
test.js | 56 +++++++++++
12 files changed, 673 insertions(+)
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..408d870
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,22 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+charset = utf-8
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+[**/{actual,fixtures,expected}/**]
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+[**/templates/**]
+trim_trailing_whitespace = false
+insert_final_newline = false
diff --git a/.eslintrc.json b/.eslintrc.json
new file mode 100644
index 0000000..5b78706
--- /dev/null
+++ b/.eslintrc.json
@@ -0,0 +1,275 @@
+{
+ "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"
+ ]
+ }
+}
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..660957e
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,10 @@
+# Enforce Unix newlines
+* text eol=lf
+
+# binaries
+*.ai binary
+*.psd binary
+*.jpg binary
+*.gif binary
+*.png binary
+*.jpeg binary
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..7988154
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,21 @@
+# always ignore files
+*.DS_Store
+*.sublime-*
+
+# test related, or directories generated by tests
+test/actual
+actual
+coverage
+
+# npm
+node_modules
+npm-debug.log
+
+# misc
+_gh_pages
+benchmark
+bower_components
+vendor
+temp
+tmp
+TODO.md
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..6f7779c
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,15 @@
+sudo: false
+language: node_js
+os:
+ - linux
+ - osx
+node_js:
+ - "6"
+ - "5"
+ - "4"
+ - "0.12"
+ - "0.10"
+matrix:
+ fast_finish: true
+ allow_failures:
+ - node_js: "0.10"
diff --git a/.verb.md b/.verb.md
new file mode 100644
index 0000000..8d367dd
--- /dev/null
+++ b/.verb.md
@@ -0,0 +1,8 @@
+## Usage
+
+```js
+var detect = require('{%= name %}');
+```
+
+## API
+{%= apidocs("index.js") %}
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..0fdaef2
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016, .
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e5691dd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,90 @@
+# detect-file [](https://www.npmjs.com/package/detect-file) [](https://npmjs.org/package/detect-file) [](https://travis-ci.org/doowb/detect-file)
+
+Detect if a filepath exists and resolves the full filepath.
+
+## Install
+
+Install with [npm](https://www.npmjs.com/):
+
+```sh
+$ npm install --save detect-file
+```
+
+## Usage
+
+```js
+var detect = require('detect-file');
+```
+
+## API
+
+### [detect](index.js#L34)
+
+Resolve the given `filepath` if it exists.
+
+**Params**
+
+* `filepath` **{String}**: filepath to detect.
+* `options` **{Object}**: Additional options.
+* `options.nocase` **{Boolean}**: Set this to `true` force case-insensitive filename checks. This is useful on case sensitive file systems.
+* `returns` **{String}**: Returns the resolved 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
+```
+
+## Related projects
+
+You might also be interested in these 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
+
+This document was generated by [verb-readme-generator](https://github.com/verbose/verb-readme-generator) (a [verb](https://github.com/verbose/verb) generator), please don't edit directly. Any changes to the readme must be made in [.verb.md](.verb.md). See [Building Docs](#building-docs).
+
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
+
+Or visit the [verb-readme-generator](https://github.com/verbose/verb-readme-generator) project to submit bug reports or pull requests for the readme layout template.
+
+## Building docs
+
+_(This document was generated by [verb-readme-generator](https://github.com/verbose/verb-readme-generator) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
+
+Generate readme and API documentation with [verb](https://github.com/verbose/verb):
+
+```sh
+$ npm install -g verb verb-readme-generator && verb
+```
+
+## Running tests
+
+Install dev dependencies:
+
+```sh
+$ npm install -d && npm test
+```
+
+## Author
+
+**Brian Woodward**
+
+* [github/doowb](https://github.com/doowb)
+* [twitter/doowb](http://twitter.com/doowb)
+
+## License
+
+Copyright © 2016, [Brian Woodward](https://github.com/doowb).
+Released under the [MIT license](https://github.com/doowb/detect-file/blob/master/LICENSE).
+
+***
+
+_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on July 06, 2016._
\ No newline at end of file
diff --git a/fixtures/.gitkeep b/fixtures/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/index.js b/index.js
new file mode 100644
index 0000000..16f0b0f
--- /dev/null
+++ b/index.js
@@ -0,0 +1,110 @@
+/*!
+ * detect-file (https://github.com/doowb/detect-file)
+ *
+ * Copyright (c) 2016, Brian Woodward.
+ * Licensed under the MIT License.
+ */
+
+'use strict';
+
+var fs = require('fs');
+var path = require('path');
+var exists = require('fs-exists-sync');
+
+/**
+ * Resolve 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` force case-insensitive filename checks. This is useful on case sensitive file systems.
+ * @return {String} Returns the resolved filepath if it exists, otherwise returns `null`.
+ * @api public
+ */
+
+module.exports = function detect(filepath, options) {
+ if (!filepath || (typeof filepath !== 'string')) {
+ return null;
+ }
+ if (exists(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;
+}
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..22a9d42
--- /dev/null
+++ b/package.json
@@ -0,0 +1,45 @@
+{
+ "name": "detect-file",
+ "description": "Detect if a filepath exists and resolves the full filepath.",
+ "version": "0.1.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": {
+ "fs-exists-sync": "^0.1.0"
+ },
+ "devDependencies": {
+ "gulp-format-md": "*",
+ "mocha": "*"
+ },
+ "keywords": [],
+ "verb": {
+ "layout": "default",
+ "plugins": [
+ "gulp-format-md"
+ ],
+ "related": {
+ "list": [
+ "fs-exists-sync"
+ ]
+ },
+ "reflinks": [
+ "verb",
+ "verb-readme-generator"
+ ]
+ }
+}
diff --git a/test.js b/test.js
new file mode 100644
index 0000000..6b5ee60
--- /dev/null
+++ b/test.js
@@ -0,0 +1,56 @@
+'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 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'));
+ });
+
+ it('should return null when a directory does not exist', function() {
+ assert(!detect('lib/'));
+ assert(!detect('whatever/'));
+ });
+});
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-detect-file.git
More information about the Pkg-javascript-commits
mailing list