Skip to content

Commit 0fc666e

Browse files
committed
run verb to generate readme documentation
1 parent f35e493 commit 0fc666e

File tree

2 files changed

+56
-28
lines changed

2 files changed

+56
-28
lines changed

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,9 @@
3939
],
4040
"related": {
4141
"list": [
42-
"copyright-regex",
43-
"todo-regex"
42+
"es6-template-regex",
43+
"year-range-regex",
44+
"to-regex-range"
4445
]
4546
},
4647
"lint": {

readme.md

Lines changed: 53 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,90 @@
1-
# quoted-string-regex [![NPM version](https://badge.fury.io/js/quoted-string-regex.svg)](http://badge.fury.io/js/quoted-string-regex) [![Build Status](https://travis-ci.org/regexps/quoted-string-regex.svg)](https://travis-ci.org/regexps/quoted-string-regex)
1+
# quoted-string-regex [![NPM version](https://img.shields.io/npm/v/quoted-string-regex.svg?style=flat)](https://www.npmjs.com/package/quoted-string-regex) [![NPM monthly downloads](https://img.shields.io/npm/dm/quoted-string-regex.svg?style=flat)](https://npmjs.org/package/quoted-string-regex) [![NPM total downloads](https://img.shields.io/npm/dt/quoted-string-regex.svg?style=flat)](https://npmjs.org/package/quoted-string-regex) [![Linux Build Status](https://img.shields.io/travis/regexps/quoted-string-regex.svg?style=flat&label=Travis)](https://travis-ci.org/regexps/quoted-string-regex)
22

33
> JavaScript regular expression for matching a quoted string.
44
5-
Originally [posted here](https://github.com/less/less.js/issues/2339#issuecomment-67211009).
5+
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
66

77
## Install
88

9-
Install with [npm](https://www.npmjs.com/)
9+
Install with [npm](https://www.npmjs.com/):
1010

1111
```sh
12-
$ npm i quoted-string-regex --save
12+
$ npm install --save quoted-string-regex
1313
```
1414

1515
## Usage
1616

1717
```js
1818
var regex = require('quoted-string-regex');
19-
('var foo = \'bar\';').match(regex());
19+
console.log(regex().exec('var foo = \'bar\';')[2]);
2020
//=> ['bar']
2121

22-
('var foo = "bar";').match(regex());
23-
//=> ['"bar"'']
22+
console.log(regex().exec('var foo = "bar";')[2]);
23+
//=> ['bar']
24+
25+
console.log(regex().exec('var foo = "bar";\nvar bar = \'baz\'')[2]);
26+
//=> ['bar']
2427

25-
('var foo = "bar";\nvar bar = \'baz\'').match(regex());
26-
//=> ['"bar"', '\'baz\'']
28+
console.log('var foo = "one";\nvar bar = \'two\';\nvar baz = `three`'.match(regex()));
29+
//=> [ '"one"', '\'two\'', '`three`' ]
2730

28-
('foo bar ". // \' \\ . // \' \\ ." baz').match(regex());
29-
//=> ['". // \' \\ . // \' \\ ."']
31+
console.log(regex().exec('foo bar ". // \' \\ . // \' \\ ." baz')[2]);
32+
//=> ['. // \' \\ . // \' \\ .']
3033
```
3134

32-
## Related projects
35+
## About
36+
37+
<details>
38+
<summary><strong>Contributing</strong></summary>
3339

34-
* [copyright-regex](https://www.npmjs.com/package/copyright-regex): Regex for matching and parsing copyright statements. | [homepage](https://github.com/regexps/copyright-regex)
35-
* [todo-regex](https://www.npmjs.com/package/todo-regex): Regular expression for matching TODO statements in a string. | [homepage](https://github.com/regexps/todo-regex)
40+
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
3641

37-
## Running tests
42+
</details>
3843

39-
Install dev dependencies:
44+
<details>
45+
<summary><strong>Running Tests</strong></summary>
46+
47+
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:
4048

4149
```sh
42-
$ npm i -d && npm test
50+
$ npm install && npm test
4351
```
4452

45-
## Contributing
53+
</details>
54+
<details>
55+
<summary><strong>Building docs</strong></summary>
56+
57+
_(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.)_
58+
59+
To generate the readme, run the following command:
60+
61+
```sh
62+
$ npm install -g verbose/verb#dev verb-generate-readme && verb
63+
```
64+
65+
</details>
66+
67+
### Related projects
68+
69+
You might also be interested in these projects:
4670

47-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/regexps/quoted-string-regex/issues/new).
71+
* [es6-template-regex](https://www.npmjs.com/package/es6-template-regex): Regular expression for matching es6 template delimiters in a string. | [homepage](https://github.com/regexhq/es6-template-regex "Regular expression for matching es6 template delimiters in a string.")
72+
* [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.")
73+
* [year-range-regex](https://www.npmjs.com/package/year-range-regex): Generates a regular expression for validating a range of years. | [homepage](https://github.com/jonschlinkert/year-range-regex "Generates a regular expression for validating a range of years.")
4874

49-
## Author
75+
### Author
5076

5177
**Jon Schlinkert**
5278

53-
+ [github/jonschlinkert](https://github.com/jonschlinkert)
54-
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
79+
* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)
80+
* [github/jonschlinkert](https://github.com/jonschlinkert)
81+
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
5582

56-
## License
83+
### License
5784

58-
Copyright © 2015 Jon Schlinkert
59-
Released under the MIT license.
85+
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
86+
Released under the [MIT License](LICENSE).
6087

6188
***
6289

63-
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on November 02, 2015._
90+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on January 15, 2018._

0 commit comments

Comments
 (0)