Skip to content

Commit b4bad54

Browse files
PlaneshifterPlaneshifter
committed
refactor: rename lint rule
1 parent 40f61ce commit b4bad54

11 files changed

Lines changed: 31 additions & 31 deletions

File tree

‎etc/eslint/rules/stdlib.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4427,7 +4427,7 @@ rules[ 'stdlib/section-headers' ] = 'error';
44274427
/**
44284428
* Ensure that a tape file starts with the expected test.
44294429
*
4430-
* @name tape-first-test
4430+
* @name first-unit-test
44314431
* @memberof rules
44324432
* @type {string}
44334433
* @default 'error'
@@ -4455,7 +4455,7 @@ rules[ 'stdlib/section-headers' ] = 'error';
44554455
* t.end();
44564456
* });
44574457
*/
4458-
rules[ 'stdlib/tape-first-test' ] = 'error';
4458+
rules[ 'stdlib/first-unit-test' ] = 'error';
44594459

44604460
/**
44614461
* Require parentheses around ternary conditions.

lib/node_modules/@stdlib/_tools/eslint/rules/tape-first-test/README.md renamed to lib/node_modules/@stdlib/_tools/eslint/rules/first-unit-test/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ limitations under the License.
1818
1919
-->
2020

21-
# tape-first-test
21+
# first-unit-test
2222

2323
> [ESLint rule][eslint-rules] to enforce that a [tape][tape] file starts with the expected test.
2424
@@ -33,7 +33,7 @@ limitations under the License.
3333
## Usage
3434

3535
```javascript
36-
var rule = require( '@stdlib/_tools/eslint/rules/tape-first-test' );
36+
var rule = require( '@stdlib/_tools/eslint/rules/first-unit-test' );
3737
```
3838

3939
#### rule
@@ -83,7 +83,7 @@ tape( 'main export is a function', function test( t ) {
8383

8484
```javascript
8585
var Linter = require( 'eslint' ).Linter;
86-
var rule = require( '@stdlib/_tools/eslint/rules/tape-first-test' );
86+
var rule = require( '@stdlib/_tools/eslint/rules/first-unit-test' );
8787

8888
var linter = new Linter();
8989
var result;
@@ -105,11 +105,11 @@ code = [
105105
'});'
106106
].join( '\n' );
107107

108-
linter.defineRule( 'tape-first-test', rule );
108+
linter.defineRule( 'first-unit-test', rule );
109109

110110
config = {
111111
'rules': {
112-
'tape-first-test': 'error'
112+
'first-unit-test': 'error'
113113
}
114114
};
115115
result = linter.verify( code, config, {
@@ -118,7 +118,7 @@ result = linter.verify( code, config, {
118118
console.log( result );
119119
/* =>
120120
{
121-
'ruleId': 'tape-first-test',
121+
'ruleId': 'first-unit-test',
122122
'severity': 2,
123123
'message': 'The first test in a test file should start with a call to `t.ok( true, __filename );`',
124124
'line': 3,

lib/node_modules/@stdlib/_tools/eslint/rules/tape-first-test/examples/index.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/first-unit-test/examples/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ code = [
4141
'});'
4242
].join( '\n' );
4343

44-
linter.defineRule( 'tape-first-test', rule );
44+
linter.defineRule( 'first-unit-test', rule );
4545

4646
config = {
4747
'rules': {
48-
'tape-first-test': 'error'
48+
'first-unit-test': 'error'
4949
}
5050
};
5151
result = linter.verify( code, config, {
@@ -54,7 +54,7 @@ result = linter.verify( code, config, {
5454
console.log( result );
5555
/* =>
5656
{
57-
'ruleId': 'tape-first-test',
57+
'ruleId': 'first-unit-test',
5858
'severity': 2,
5959
'message': 'The first test in a test file should start with a call to `t.ok( true, __filename );`',
6060
'line': 3,

lib/node_modules/@stdlib/_tools/eslint/rules/tape-first-test/lib/index.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/first-unit-test/lib/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919
'use strict';
2020

2121
/**
22-
* ESLint rule to enforce enforce that a tape file starts with the expected test.
22+
* ESLint rule to enforce enforce that a test file starts with the expected test.
2323
*
24-
* @module @stdlib/_tools/eslint/rules/tape-first-test
24+
* @module @stdlib/_tools/eslint/rules/first-unit-test
2525
*
2626
* @example
27-
* var rule = require( '@stdlib/_tools/eslint/rules/tape-first-test' );
27+
* var rule = require( '@stdlib/_tools/eslint/rules/first-unit-test' );
2828
*
2929
* console.log( rule );
3030
*/

lib/node_modules/@stdlib/_tools/eslint/rules/tape-first-test/lib/main.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/first-unit-test/lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var rule;
3333
// FUNCTIONS //
3434

3535
/**
36-
* Rule for ensuring that tape files start with a test of a specific structure and name.
36+
* Rule for ensuring that test files start with a test of a specific structure and name.
3737
*
3838
* @param {Object} context - ESLint context
3939
* @returns {Object} validators
@@ -156,7 +156,7 @@ function main( context ) {
156156
rule = {
157157
'meta': {
158158
'docs': {
159-
'description': 'ensure that each tape file starts with the expected test.'
159+
'description': 'ensure that each test file starts with the expected test.'
160160
},
161161
'schema': [],
162162
'fixable': 'code'

lib/node_modules/@stdlib/_tools/eslint/rules/tape-first-test/package.json renamed to lib/node_modules/@stdlib/_tools/eslint/rules/first-unit-test/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/tape-first-test",
2+
"name": "@stdlib/_tools/eslint/rules/first-unit-test",
33
"version": "0.0.0",
44
"description": "ESLint rule to enforce that a tape file starts with the expected test.",
55
"license": "Apache-2.0",

lib/node_modules/@stdlib/_tools/eslint/rules/tape-first-test/test/fixtures/invalid.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/first-unit-test/test/fixtures/invalid.js

File renamed without changes.

lib/node_modules/@stdlib/_tools/eslint/rules/tape-first-test/test/fixtures/unvalidated.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/first-unit-test/test/fixtures/unvalidated.js

File renamed without changes.

lib/node_modules/@stdlib/_tools/eslint/rules/tape-first-test/test/fixtures/valid.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/first-unit-test/test/fixtures/valid.js

File renamed without changes.

lib/node_modules/@stdlib/_tools/eslint/rules/tape-first-test/test/test.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/first-unit-test/test/test.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ tape( 'main export is an object', function test( t ) {
4040
t.end();
4141
});
4242

43-
tape( 'the function positively validates tape files that start with a correctly formatted test for the main export', function test( t ) {
43+
tape( 'the function positively validates test files that start with a correctly formatted test for the main export', function test( t ) {
4444
var tester = new RuleTester();
4545

4646
try {
47-
tester.run( 'tape-test-main-export', rule, {
47+
tester.run( 'first-unit-test', rule, {
4848
'valid': valid,
4949
'invalid': []
5050
});
@@ -55,11 +55,11 @@ tape( 'the function positively validates tape files that start with a correctly
5555
t.end();
5656
});
5757

58-
tape( 'the function negatively validates tape files that do not start with a correctly formatted test for the main export', function test( t ) {
58+
tape( 'the function negatively validates test files that do not start with a correctly formatted test for the main export', function test( t ) {
5959
var tester = new RuleTester();
6060

6161
try {
62-
tester.run( 'tape-test-main-export', rule, {
62+
tester.run( 'first-unit-test', rule, {
6363
'valid': [],
6464
'invalid': invalid
6565
});
@@ -74,7 +74,7 @@ tape( 'the function does not validate other files', function test( t ) {
7474
var tester = new RuleTester();
7575

7676
try {
77-
tester.run( 'tape-test-main-export', rule, {
77+
tester.run( 'first-unit-test', rule, {
7878
'valid': unvalidated,
7979
'invalid': []
8080
});

0 commit comments

Comments
 (0)