is-unc-path - npm Package Compare versions

Comparing version 0.1.2 to 1.0.0

index.js

 'use strict';
 
-var regex = require('unc-path-regex');
+var regex = require('unc-path-regex')();
 
-module.exports = function isUNC(fp) {
-  if (typeof fp !== 'string') return false;
-  return regex().test(fp);
+module.exports = function(filepath) {
+  if (typeof filepath !== 'string') {
+    throw new TypeError('expected a string');
+  }
+  return regex.test(filepath);
 };

package.json

 {
   "name": "is-unc-path",
   "description": "Returns true if a filepath is a windows UNC file path.",
-  "version": "0.1.2",
+  "version": "1.0.0",
   "homepage": "https://github.com/jonschlinkert/is-unc-path",
@@ -23,7 +23,7 @@ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
   "dependencies": {
-    "unc-path-regex": "^0.1.0"
+    "unc-path-regex": "^0.1.2"
   },
   "devDependencies": {
-    "gulp-format-md": "^0.1.11",
-    "mocha": "*"
+    "gulp-format-md": "^1.0.0",
+    "mocha": "^3.4.2"
   },
@@ -47,13 +47,2 @@ "keywords": [
   "verb": {
-    "related": {
-      "list": [
-        "dirname-regex",
-        "dotdir-regex",
-        "dotfile-regex",
-        "is-glob",
-        "is-unc-path",
-        "path-regex",
-        "unc-path-regex"
-      ]
-    },
     "toc": false,
@@ -70,7 +59,10 @@ "layout": "default",
     },
-    "reflinks": [
-      "verb",
-      "verb-generate-readme"
-    ]
+    "related": {
+      "list": [
+        "is-relative",
+        "is-absolute",
+        "is-glob"
+      ]
+    }
   }
 }

README.md

@@ -1,2 +0,2 @@
-# is-unc-path [![NPM version](https://img.shields.io/npm/v/is-unc-path.svg?style=flat)](https://www.npmjs.com/package/is-unc-path) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-unc-path.svg?style=flat)](https://npmjs.org/package/is-unc-path)  [![NPM total downloads](https://img.shields.io/npm/dt/is-unc-path.svg?style=flat)](https://npmjs.org/package/is-unc-path) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-unc-path.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-unc-path)
+# is-unc-path [![NPM version](https://img.shields.io/npm/v/is-unc-path.svg?style=flat)](https://www.npmjs.com/package/is-unc-path) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-unc-path.svg?style=flat)](https://npmjs.org/package/is-unc-path) [![NPM total downloads](https://img.shields.io/npm/dt/is-unc-path.svg?style=flat)](https://npmjs.org/package/is-unc-path) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-unc-path.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-unc-path)
 
@@ -26,3 +26,8 @@ > Returns true if a filepath is a windows UNC file path.
 isUncPath('\\\\foo/bar');
-isUncPath('\\\\foo\\admin
+isUncPath('\\\\foo\\admin$');
+isUncPath('\\\\foo\\admin$\\system32');
+isUncPath('\\\\foo\\temp');
+isUncPath('\\\\/foo/bar');
+isUncPath('\\\\\\/foo/bar');
+```
 
@@ -59,89 +64,10 @@ **false**
 
-## About
+## Release history
 
-### Related projects
+### v1.0.0 - 2017-07-12
 
-* [dirname-regex](https://www.npmjs.com/package/dirname-regex): Regular expression for matching the directory part of a file path. | [homepage](https://github.com/regexps/dirname-regex "Regular expression for matching the directory part of a file path.")
-* [dotdir-regex](https://www.npmjs.com/package/dotdir-regex): Regex for matching dot-directories, like `.git/` | [homepage](https://github.com/regexps/dotdir-regex "Regex for matching dot-directories, like `.git/`")
-* [dotfile-regex](https://www.npmjs.com/package/dotfile-regex): Regular expresson for matching dotfiles. | [homepage](https://github.com/regexps/dotfile-regex "Regular expresson for matching dotfiles.")
-* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet")
-* [is-unc-path](https://www.npmjs.com/package/is-unc-path): Returns true if a filepath is a windows UNC file path. | [homepage](https://github.com/jonschlinkert/is-unc-path "Returns true if a filepath is a windows UNC file path.")
-* [path-regex](https://www.npmjs.com/package/path-regex): Regular expression for matching the parts of a file path. | [homepage](https://github.com/regexps/path-regex "Regular expression for matching the parts of a file path.")
-* [unc-path-regex](https://www.npmjs.com/package/unc-path-regex): Regular expression for testing if a file path is a windows UNC file path. Can… [more](https://github.com/regexhq/unc-path-regex) | [homepage](https://github.com/regexhq/unc-path-regex "Regular expression for testing if a file path is a windows UNC file path. Can also be used as a component of another regexp via the `.source` property.")
+**Changes**
 
-### Contributing
+* now throws a `TypeError` if value is not a string
 
-Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
-
-### Building docs
-
-_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (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).)_
-
-To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
-
-```sh
-$ npm install -g verb verb-generate-readme && verb
-```
-
-### Running tests
-
-Install dev dependencies:
-
-```sh
-$ npm install -d && npm test
-```
-
-### Author
-
-**Jon Schlinkert**
-
-* [github/jonschlinkert](https://github.com/jonschlinkert)
-* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
-
-### License
-
-Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
-Released under the [MIT license](https://github.com/jonschlinkert/is-unc-path/blob/master/LICENSE).
-
-***
-
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 07, 2016._
-
-);
-isUncPath('\\foo\admin$\system32');
-isUncPath('\\foo\temp');
-isUncPath('\\/foo/bar');
-isUncPath('\\\/foo/bar');
-
-```
-**false**
-
-Returns false for non-UNC paths:
-
-```js
-isUncPath('/foo/bar');
-isUncPath('/');
-isUncPath('/foo');
-isUncPath('/foo/');
-isUncPath('c:');
-isUncPath('c:.');
-isUncPath('c:./');
-isUncPath('c:./file');
-isUncPath('c:/');
-isUncPath('c:/file');
-```
-
-**Customization**
-
-Use `.source` to use the regex as a component of another regex:
-
-```js
-var myRegex = new RegExp(isUncPath.source + 'foo');
-```
-
-**[Rules for UNC paths](http://resources.esri.com/help/9.3/ArcGISDesktop/com/Gp_ToolRef/sharing_tools_and_toolboxes/pathnames_explained_colon_absolute_relative_unc_and_url.htm)**
-
-* The computer name is always preceded by a double backward-slash (`\\`).
-* UNC paths cannot contain a drive letter (such as `D:`)
-
 ## About
@@ -151,9 +77,5 @@
 
-* [dirname-regex](https://www.npmjs.com/package/dirname-regex): Regular expression for matching the directory part of a file path. | [homepage](https://github.com/regexps/dirname-regex "Regular expression for matching the directory part of a file path.")
-* [dotdir-regex](https://www.npmjs.com/package/dotdir-regex): Regex for matching dot-directories, like `.git/` | [homepage](https://github.com/regexps/dotdir-regex "Regex for matching dot-directories, like `.git/`")
-* [dotfile-regex](https://www.npmjs.com/package/dotfile-regex): Regular expresson for matching dotfiles. | [homepage](https://github.com/regexps/dotfile-regex "Regular expresson for matching dotfiles.")
+* [is-absolute](https://www.npmjs.com/package/is-absolute): Polyfill for node.js `path.isAbolute`. Returns true if a file path is absolute. | [homepage](https://github.com/jonschlinkert/is-absolute "Polyfill for node.js `path.isAbolute`. Returns true if a file path is absolute.")
 * [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet")
-* [is-unc-path](https://www.npmjs.com/package/is-unc-path): Returns true if a filepath is a windows UNC file path. | [homepage](https://github.com/jonschlinkert/is-unc-path "Returns true if a filepath is a windows UNC file path.")
-* [path-regex](https://www.npmjs.com/package/path-regex): Regular expression for matching the parts of a file path. | [homepage](https://github.com/regexps/path-regex "Regular expression for matching the parts of a file path.")
-* [unc-path-regex](https://www.npmjs.com/package/unc-path-regex): Regular expression for testing if a file path is a windows UNC file path. Can… [more](https://github.com/regexhq/unc-path-regex) | [homepage](https://github.com/regexhq/unc-path-regex "Regular expression for testing if a file path is a windows UNC file path. Can also be used as a component of another regexp via the `.source` property.")
+* [is-relative](https://www.npmjs.com/package/is-relative): Returns `true` if the path appears to be relative. | [homepage](https://github.com/jonschlinkert/is-relative "Returns `true` if the path appears to be relative.")
 
@@ -166,8 +88,8 @@ ### Contributing
 
-_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (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).)_
+_(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 and API documentation with [verb](https://github.com/verbose/verb):
+To generate the readme, run the following command:
 
 ```sh
-$ npm install -g verb verb-generate-readme && verb
+$ npm install -g verbose/verb#dev verb-generate-readme && verb
 ```
@@ -177,6 +99,6 @@
 
-Install dev dependencies:
+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 -d && npm test
+$ npm install && npm test
 ```
@@ -189,11 +111,11 @@
 * [github/jonschlinkert](https://github.com/jonschlinkert)
-* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
+* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
 
 ### License
 
-Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
-Released under the [MIT license](https://github.com/jonschlinkert/is-unc-path/blob/master/LICENSE).
+Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT License](LICENSE).
 
 ***
 
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 07, 2016._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 13, 2017._

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Lines of code

8

increased by33.33%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

6513

decreased by-43.12%

Number of lines in readme file

115

decreased by-40.41%

Dependency changes

• Updatedunc-path-regex@^0.1.2