is-relative - npm Package Compare versions

Comparing version 0.2.1 to 1.0.0

index.js

@@ -5,8 +5,9 @@ 'use strict';
 
-module.exports = function isRelative(fp) {
-  if (typeof fp !== 'string') {
-    throw new TypeError('isRelative expects a string.');
+module.exports = function isRelative(filepath) {
+  if (typeof filepath !== 'string') {
+    throw new TypeError('expected filepath to be a string');
   }
+
   // Windows UNC paths are always considered to be absolute.
-  return !isUncPath(fp) && !/^([a-z]:)?[\\\/]/i.test(fp);
+  return !isUncPath(filepath) && !/^([a-z]:)?[\\\/]/i.test(filepath);
 };

package.json

 {
   "name": "is-relative",
   "description": "Returns `true` if the path appears to be relative.",
-  "version": "0.2.1",
+  "version": "1.0.0",
   "homepage": "https://github.com/jonschlinkert/is-relative",
   "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
+  "contributors": [
+    "Jon Schlinkert (http://twitter.com/jonschlinkert)",
+    "Shinnosuke Watanabe (https://shinnn.github.io)"
+  ],
   "repository": "jonschlinkert/is-relative",
@@ -12,6 +16,6 @@ "bugs": {
   "license": "MIT",
-  "main": "index.js",
   "files": [
     "index.js"
   ],
+  "main": "index.js",
   "engines": {
@@ -24,6 +28,7 @@ "node": ">=0.10.0"
   "dependencies": {
-    "is-unc-path": "^0.1.1"
+    "is-unc-path": "^1.0.0"
   },
   "devDependencies": {
-    "mocha": "*"
+    "gulp-format-md": "^1.0.0",
+    "mocha": "^3.4.2"
   },
@@ -50,9 +55,20 @@ "keywords": [
         "is-absolute",
-        "is-relative",
         "is-dotfile",
         "is-glob",
+        "is-relative",
         "is-unc-path"
       ]
+    },
+    "toc": false,
+    "layout": "default",
+    "tasks": [
+      "readme"
+    ],
+    "plugins": [
+      "gulp-format-md"
+    ],
+    "lint": {
+      "reflinks": true
     }
   }
-}
+}

README.md

@@ -1,2 +0,2 @@
-# is-relative [![NPM version](https://badge.fury.io/js/is-relative.svg)](http://badge.fury.io/js/is-relative)
+# is-relative [![NPM version](https://img.shields.io/npm/v/is-relative.svg?style=flat)](https://www.npmjs.com/package/is-relative) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-relative.svg?style=flat)](https://npmjs.org/package/is-relative) [![NPM total downloads](https://img.shields.io/npm/dt/is-relative.svg?style=flat)](https://npmjs.org/package/is-relative) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-relative.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-relative)
 
@@ -7,6 +7,6 @@ > Returns `true` if the path appears to be relative.
 
-Install with [npm](https://www.npmjs.com/)
+Install with [npm](https://www.npmjs.com/):
 
 ```sh
-$ npm i is-relative --save
+$ npm install --save is-relative
 ```
@@ -18,39 +18,62 @@
 var isRelative = require('is-relative');
-isRelative('README.md');
+console.log(isRelative('README.md'));
 //=> true
+
+console.log(isRelative('/User/dev/foo/README.md'));
+//=> false
 ```
 
-## Other projects
+## About
 
-* [is-absolute](https://github.com/jonschlinkert/is-absolute): Return true if a file path is absolute.
-* [is-dotfile](https://github.com/jonschlinkert/is-dotfile): Return true if a file path is (or has) a dotfile.
-* [is-glob](https://github.com/jonschlinkert/is-glob): Returns `true` if the given string looks like a glob pattern.
-* [is-unc-path](https://github.com/jonschlinkert/is-unc-path): Returns true if a filepath is a windows UNC file path.
+### Related projects
 
-## Running tests
+* [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-dotfile](https://www.npmjs.com/package/is-dotfile): Return true if a file path is (or has) a dotfile. Returns false if the… [more](https://github.com/jonschlinkert/is-dotfile) | [homepage](https://github.com/jonschlinkert/is-dotfile "Return true if a file path is (or has) a dotfile. Returns false if the path is a dot directory.")
+* [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-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.")
+* [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.")
 
-Install dev dependencies:
+### Contributing
 
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
+
+### Contributors
+
+| **Commits** | **Contributor** | 
+| --- | --- |
+| 13 | [jonschlinkert](https://github.com/jonschlinkert) |
+| 3 | [shinnn](https://github.com/shinnn) |
+
+### 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 i -d && npm test
+$ npm install -g verbose/verb#dev verb-generate-readme && verb
 ```
 
-## Contributing
+### Running tests
 
-Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/is-relative/issues/new)
+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:
 
-## Author
+```sh
+$ npm install && npm test
+```
 
+### Author
+
 **Jon Schlinkert**
 
-+ [github/jonschlinkert](https://github.com/jonschlinkert)
-+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
+* [github/jonschlinkert](https://github.com/jonschlinkert)
+* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
 
-## License
+### License
 
-Copyright © 2014-2015 [Jon Schlinkert](https://github.com/jonschlinkert)
-Released under the MIT license.
+Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT License](LICENSE).
 
 ***
 
-_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on July 11, 2015._
+_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

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

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

Total package byte prevSize

6586

increased by70.14%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

77

increased by42.59%

Worsened metrics

Dev dependency count

2

increased by100%

Dependency changes

• + Addedis-unc-path@1.0.0(transitive)

• - Removedis-unc-path@0.1.2(transitive)

• Updatedis-unc-path@^1.0.0