es6-template-regex - npm Package Compare versions

Comparing version 0.1.1 to 1.0.0

index.js

 /*!
  * es6-template-regex <https://github.com/jonschlinkert/es6-template-regex>
- * Copyright (c) 2014-2015, Jon Schlinkert, 2014 Lo-Dash 2.4.1 <http://lodash.com/>
+ * Copyright (c) 2014-2017, Jon Schlinkert,
+ * Copyright (c) 2014 Lo-Dash 2.4.1 <http://lodash.com/>
  * Licensed under the MIT License.
@@ -5,0 +6,0 @@ *

package.json

 {
   "name": "es6-template-regex",
   "description": "Regular expression for matching es6 template delimiters in a string.",
-  "version": "0.1.1",
-  "homepage": "https://github.com/jonschlinkert/es6-template-regex",
+  "version": "1.0.0",
+  "homepage": "https://github.com/regexhq/es6-template-regex",
   "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
-  "repository": "jonschlinkert/es6-template-regex",
+  "contributors": [
+    "Anders D. Johnson (https://andrz.me)",
+    "Jon Schlinkert (http://twitter.com/jonschlinkert)"
+  ],
+  "repository": "regexhq/es6-template-regex",
   "bugs": {
-    "url": "https://github.com/jonschlinkert/es6-template-regex/issues"
+    "url": "https://github.com/regexhq/es6-template-regex/issues"
   },
@@ -22,5 +26,5 @@ "license": "MIT",
   },
-  "dependencies": {},
   "devDependencies": {
-    "mocha": "*"
+    "gulp-format-md": "^0.1.12",
+    "mocha": "^3.3.0"
   },
@@ -30,7 +34,29 @@ "keywords": [
     "es",
+    "es6",
     "expression",
     "regex",
     "regexp",
-    "regular"
-  ]
+    "regular",
+    "template"
+  ],
+  "verb": {
+    "toc": false,
+    "layout": "default",
+    "tasks": [
+      "readme"
+    ],
+    "plugins": [
+      "gulp-format-md"
+    ],
+    "related": {
+      "list": [
+        "to-regex-range",
+        "unc-path-regex",
+        "whitespace-regex"
+      ]
+    },
+    "lint": {
+      "reflinks": true
+    }
+  }
 }

README.md

@@ -1,2 +0,2 @@
-# es6-template-regex [![NPM version](https://badge.fury.io/js/es6-template-regex.svg)](http://badge.fury.io/js/es6-template-regex)
+# es6-template-regex [![NPM version](https://img.shields.io/npm/v/es6-template-regex.svg?style=flat)](https://www.npmjs.com/package/es6-template-regex) [![NPM monthly downloads](https://img.shields.io/npm/dm/es6-template-regex.svg?style=flat)](https://npmjs.org/package/es6-template-regex) [![NPM total downloads](https://img.shields.io/npm/dt/es6-template-regex.svg?style=flat)](https://npmjs.org/package/es6-template-regex) [![Linux Build Status](https://img.shields.io/travis/regexhq/es6-template-regex.svg?style=flat&label=Travis)](https://travis-ci.org/regexhq/es6-template-regex)
 
@@ -7,6 +7,6 @@ > Regular expression for matching es6 template delimiters in a string.
 
-Install with [npm](https://www.npmjs.com/)
+Install with [npm](https://www.npmjs.com/):
 
 ```sh
-$ npm i es6-template-regex --save
+$ npm install --save es6-template-regex
 ```
@@ -16,7 +16,12 @@
 
-The top-level export of this module is a function:
+The main export of this module is a function that must be called:
 
 ```js
-var re = require('es6-template-regex');
+var regex = require('es6-template-regex');
+console.log(regex());
+```
 
+## Example
+
+```js
 function interpolate(str, data) {
@@ -34,28 +39,53 @@ return str.replace(re(), function(m, prop) {
 
-## Running tests
+## About
 
-Install dev dependencies:
+### Related projects
 
+* [to-regex-range](https://www.npmjs.com/package/to-regex-range): Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than… [more](https://github.com/micromatch/to-regex-range) | [homepage](https://github.com/micromatch/to-regex-range "Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than 2.78 million test assertions.")
+* [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.")
+* [whitespace-regex](https://www.npmjs.com/package/whitespace-regex): Regular expression for matching the whitespace in a string. | [homepage](https://github.com/regexps/whitespace-regex "Regular expression for matching the whitespace in a string.")
+
+### Contributing
+
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
+
+### Contributors
+
+| **Commits** | **Contributor** | 
+| --- | --- |
+| 7 | [jonschlinkert](https://github.com/jonschlinkert) |
+| 1 | [adjohnson916](https://github.com/adjohnson916) |
+
+### 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/es6-template-regex/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 August 10, 2015._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 07, 2017._

New alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

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

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6423

increased by82.78%

Lines of code

12

increased by9.09%

Number of low maintenance alerts

1

decreased by-50%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

88

increased by51.72%

Worsened metrics

Dev dependency count

2

increased by100%

No dependency changes