is-dotdir - npm Package Compare versions

Comparing version 0.1.0 to 1.0.0

index.js

 /*!
  * is-dotdir <https://github.com/jonschlinkert/is-dotdir>
  *
- * Copyright (c) 2015, Jon Schlinkert.
- * Licensed under the MIT License.
+ * Copyright (c) 2015, 2017, Jon Schlinkert.
+ * Released under the MIT License.
  */
@@ -10,6 +10,6 @@
 
-var re = require('dotdir-regex');
+var dotdirRegex = require('dotdir-regex');
 
-module.exports = function (str) {
-  return re().test(str);
+module.exports = function(str) {
+  return dotdirRegex().test(str);
 };

package.json

 {
   "name": "is-dotdir",
   "description": "Returns true if a path is a dot-directory.",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "homepage": "https://github.com/jonschlinkert/is-dotdir",
@@ -26,5 +26,29 @@ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
   "devDependencies": {
-    "mocha": "^2.2.5"
+    "gulp-format-md": "^0.1.12",
+    "mocha": "^3.4.2"
   },
-  "keywords": []
+  "keywords": [
+    "dotdir",
+    "is"
+  ],
+  "verb": {
+    "toc": false,
+    "layout": "default",
+    "tasks": [
+      "readme"
+    ],
+    "plugins": [
+      "gulp-format-md"
+    ],
+    "related": {
+      "list": [
+        "is-dotfile",
+        "dotdir-regex",
+        "dotfile-regex"
+      ]
+    },
+    "lint": {
+      "reflinks": true
+    }
+  }
 }

README.md

@@ -1,2 +0,2 @@
-# is-dotdir [![NPM version](https://badge.fury.io/js/is-dotdir.svg)](http://badge.fury.io/js/is-dotdir)
+# is-dotdir [![NPM version](https://img.shields.io/npm/v/is-dotdir.svg?style=flat)](https://www.npmjs.com/package/is-dotdir) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-dotdir.svg?style=flat)](https://npmjs.org/package/is-dotdir) [![NPM total downloads](https://img.shields.io/npm/dt/is-dotdir.svg?style=flat)](https://npmjs.org/package/is-dotdir) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-dotdir.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-dotdir)
 
@@ -7,6 +7,6 @@ > Returns true if a path is a dot-directory.
 
-Install with [npm](https://www.npmjs.com/)
+Install with [npm](https://www.npmjs.com/):
 
 ```sh
-$ npm i is-dotdir --save
+$ npm install --save is-dotdir
 ```
@@ -16,2 +16,11 @@
 
+To be considered a dot **directory**:
+
+* the path must contain a dot that is at the beginning of the string or following a slash
+* the next character after the dot must not be another dot
+* one or more non-slash characters must follow the dot
+* a slash must follow after at least one non-dot, non-slash character
+
+To check for dot **files**, use [is-dotfile](https://github.com/jonschlinkert/is-dotfile) instead.
+
 ```js
@@ -27,38 +36,46 @@ var isDotdir = require('is-dotdir');
 
-## Related projects
+## About
 
-* [dotdir-regex](https://github.com/regexps/dotdir-regex): Regex for matching dot-directories, like `.git/`
-* [dotfile-regex](https://github.com/regexps/dotfile-regex): Regular expresson for matching dotfiles.
-* [ext-regex](https://github.com/regexps/ext-regex): Regular expression for matching file extensions. Matches single and/or multiple file extensions, like `.min.js`.
-* [filename-regex](https://github.com/regexps/filename-regex): Regular expression for matching file names, with or without extension.
-* [is-glob](https://github.com/jonschlinkert/is-glob): Returns `true` if the given string looks like a glob pattern.
-* [is-dotfile](https://github.com/jonschlinkert/is-dotfile): Return true if a file path is (or has) a dotfile.
-* [path-regex](https://github.com/regexps/path-regex): Regular expression for matching the parts of a file path.
+### Related projects
 
-## Running tests
+* [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-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.")
 
-Install dev dependencies:
+### 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 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-dotdir/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 © 2015 Jon Schlinkert
-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 07, 2015._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 30, 2017._

Fixed alerts

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

5520

increased by44.84%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

78

increased by27.87%

Worsened metrics

Dev dependency count

2

increased by100%

No dependency changes