Skip to content

Commit 62b461e

Browse files
kgrytekgryte
committed
Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop
2 parents 4b5be2c + 608944a commit 62b461e

89 files changed

Lines changed: 151 additions & 117 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎etc/eslint/rules/stdlib.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ rules[ 'stdlib/empty-line-before-comment' ] = 'error';
3939
/**
4040
* Require that only allowed JSDoc tags are used.
4141
*
42-
* @name jsdoc-check-tag-names
42+
* @name jsdoc-tag-names
4343
* @memberof rules
4444
* @type {string}
4545
* @default 'error'
@@ -78,12 +78,12 @@ rules[ 'stdlib/empty-line-before-comment' ] = 'error';
7878
* return x*x;
7979
* }
8080
*/
81-
rules[ 'stdlib/jsdoc-check-tag-names' ] = 'error';
81+
rules[ 'stdlib/jsdoc-tag-names' ] = 'error';
8282

8383
/**
8484
* Require that JSDoc descriptions start with an uppercase letter and end with a period.
8585
*
86-
* @name jsdoc-description-sentence
86+
* @name jsdoc-leading-description-sentence
8787
* @memberof rules
8888
* @type {string}
8989
* @default 'error'
@@ -120,7 +120,7 @@ rules[ 'stdlib/jsdoc-check-tag-names' ] = 'error';
120120
* return Math.random();
121121
* }
122122
*/
123-
rules[ 'stdlib/jsdoc-description-sentence' ] = 'error';
123+
rules[ 'stdlib/jsdoc-leading-description-sentence' ] = 'error';
124124

125125
/**
126126
* Enforce that require() calls have only string literals as parameters.

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/README.md renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# jsdoc-description-sentence
1+
# jsdoc-leading-description-sentence
22

33
> [ESLint rule][eslint-rules] to enforce that JSDoc descriptions start with an uppercase letter and end with a period.
44
@@ -13,7 +13,7 @@
1313
## Usage
1414

1515
```javascript
16-
var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-description-sentence' );
16+
var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence' );
1717
```
1818

1919
#### rule
@@ -22,7 +22,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-description-sentence' );
2222

2323
**Bad**:
2424

25-
<!-- eslint-disable stdlib/jsdoc-description-sentence -->
25+
<!-- eslint-disable stdlib/jsdoc-leading-description-sentence -->
2626

2727
```javascript
2828
/**
@@ -66,7 +66,7 @@ function rand() {
6666

6767
```javascript
6868
var Linter = require( 'eslint' ).Linter;
69-
var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-description-sentence' );
69+
var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence' );
7070

7171
var linter = new Linter();
7272
var result;
@@ -88,18 +88,18 @@ code = [
8888
'}'
8989
].join( '\n' );
9090

91-
linter.defineRule( 'jsdoc-description-sentence', rule );
91+
linter.defineRule( 'jsdoc-leading-description-sentence', rule );
9292

9393
result = linter.verify( code, {
9494
'rules': {
95-
'jsdoc-description-sentence': 'error'
95+
'jsdoc-leading-description-sentence': 'error'
9696
}
9797
});
9898
console.log( result );
9999
/* =>
100100
[
101101
{
102-
'ruleId': 'jsdoc-description-sentence',
102+
'ruleId': 'jsdoc-leading-description-sentence',
103103
'severity': 2,
104104
'message': 'Description must start with an uppercase letter and end with a period',
105105
'line': 1,

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/examples/index.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/examples/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@ code = [
2323
'}'
2424
].join( '\n' );
2525

26-
linter.defineRule( 'jsdoc-description-sentence', rule );
26+
linter.defineRule( 'jsdoc-leading-description-sentence', rule );
2727

2828
result = linter.verify( code, {
2929
'rules': {
30-
'jsdoc-description-sentence': 'error'
30+
'jsdoc-leading-description-sentence': 'error'
3131
}
3232
});
3333
console.log( result );
3434
/* =>
3535
[
3636
{
37-
'ruleId': 'jsdoc-description-sentence',
37+
'ruleId': 'jsdoc-leading-description-sentence',
3838
'severity': 2,
3939
'message': 'Description must start with an uppercase letter and end with a period',
4040
'line': 1,

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-check-tag-names/lib/get_jsdoc_comment.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/lib/get_jsdoc_comment.js

File renamed without changes.

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/lib/index.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/lib/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
/**
44
* ESLint rule to enforce that JSDoc descriptions start with an uppercase letter and end with a period.
55
*
6-
* @module @stdlib/_tools/eslint/rules/jsdoc-description-sentence
6+
* @module @stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence
77
*
88
* @example
9-
* var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-description-sentence' );
9+
* var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence' );
1010
*
1111
* console.log( rule );
1212
*/

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/lib/main.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/lib/main.js

File renamed without changes.

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/package.json renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@stdlib/_tools/eslint/rules/jsdoc-description-sentence",
2+
"name": "@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence",
33
"version": "0.0.0",
44
"description": "ESLint rule to enforce that JSDoc descriptions start with an uppercase letter and end with a period.",
55
"license": "MIT AND Apache-2.0",

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/test/fixtures/invalid.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/test/fixtures/invalid.js

File renamed without changes.

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/test/fixtures/unvalidated.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/test/fixtures/unvalidated.js

File renamed without changes.

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/test/fixtures/valid.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/test/fixtures/valid.js

File renamed without changes.

0 commit comments

Comments
 (0)