Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add plenty of rules (#2, #3, #5, #6, #7 and #8) #11

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions docs/rules/max-asserts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Limit the number of assertions in a test

Limit the amount of assertions in a test to enforce splitting up large tests into smaller ones.

Skipped assertions are counted.


## Fail

```js
/*eslint max-asserts: [2, 5]*/
const test = require('ava');

test('tests with too may asserts', (t) => {
const array = getArrayUpTo(6);

t.is(array.length, 6);
t.is(array[0], 1);
t.is(array[1], 2);
t.is(array[2], 3);
t.is(array[3], 4);
t.is(array[4], 5);
t.is(array[5], 6);
});
```


## Pass

```js
const test = require('ava');

test('my test name', (t) => {

test('tests with too may asserts', (t) => {
const array = getArrayUpTo(6);

t.same(array, [1, 2, 3, 4, 5, 6]);
});
```

## Options

The rule takes one option, a number, which is the maximum number of assertions for each test. The default is 5.

You can set the option in configuration like this:

"max-asserts": [2, 5]
26 changes: 26 additions & 0 deletions docs/rules/no-cb-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Ensure no `test.cb()` is used

Disallow the use of `test.cb()`.


## Fail

```js
const test = require('ava');

test.cb('some test', (t) => {
t.pass();
t.end();
});
```


## Pass

```js
const test = require('ava');

test('some test', (t) => {
t.pass();
});
```
37 changes: 37 additions & 0 deletions docs/rules/no-identical-rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Ensure no tests have the same title

Disallow tests with identical titles as it makes it hard to differentiate them.


## Fail

```js
const test = require('ava');

test('some test', (t) => {
t.pass();
});

test('some test', (t) => {
t.pass();
});
```


## Pass

```js
const test = require('ava');

test((t) => {
t.pass();
});

test('some test', (t) => {
t.pass();
});

test('some other test', (t) => {
t.pass();
});
```
27 changes: 27 additions & 0 deletions docs/rules/no-only-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Ensure no test.only() are present

It's easy to run only one test with test.only() and then forget about it. It's visible in the results, but still easily missed.


## Fail

```js
const test = require('ava');

test.only('some title', (t) => {
t.pass();
t.end();
});
```


## Pass

```js
const test = require('ava');

test('some title', (t) => {
t.pass();
t.end();
});
```
27 changes: 27 additions & 0 deletions docs/rules/no-skip-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Ensure no tests are skipped

It's easy to make a test skipped with test.skip() and then forget about it. It's visible in the results, but still easily missed.


## Fail

```js
const test = require('ava');

test.skip('some title', (t) => {
t.pass();
t.end();
});
```


## Pass

```js
const test = require('ava');

test('some title', (t) => {
t.pass();
t.end();
});
```
35 changes: 35 additions & 0 deletions docs/rules/test-title.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Ensure tests have a title

Tests should have a title.


## Fail

```js
const test = require('ava');

test((t) => {
t.pass();
t.end();
});
```


## Pass

```js
const test = require('ava');

test('my test name', (t) => {
t.pass();
t.end();
});
```

## Options

The rule takes one option, a string, which could be either `"always"` or `"if-multiple"`. The default is `"always"`. If the option is set to `"if-multiple"`, the rule will only trigger if there are multiple tests in a file.

You can set the option in configuration like this:

"test-title": [2, "always"]
16 changes: 14 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,21 @@

module.exports = {
rules: {
'test-ended': require('./rules/test-ended')
'max-asserts': require('./rules/max-asserts'),
'no-cb-test': require('./rules/no-cb-test'),
'no-identical-title': require('./rules/no-identical-title'),
'no-only-test': require('./rules/no-only-test'),
'no-skip-test': require('./rules/no-skip-test'),
'test-ended': require('./rules/test-ended'),
'test-title': require('./rules/test-title')
},
rulesConfig: {
'test-ended': 0
'max-asserts': [0, 5],
'no-cb-test': 0,
'no-identical-title': 0,
'no-only-test': 0,
'no-skip-test': 0,
'test-ended': 0,
'test-title': [0, 'always']
}
};
14 changes: 13 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,13 @@ Configure it in package.json.
"ava"
],
"rules": {
"ava/test-ended": 2
"ava/max-asserts": [2, 5],
"ava/no-cb-test": 2,
"ava/no-identical-title": 2,
"ava/no-only-test": 2,
"ava/no-skip-test": 2,
"ava/test-ended": 2,
"ava/test-title": [2, "always"]
}
}
}
Expand All @@ -33,7 +39,13 @@ Configure it in package.json.

The rules will only activate in test files.

- [max-asserts](docs/rules/max-asserts) - Limit the number of assertions in a test.
- [no-cb-test](docs/rules/no-cb-test.md) - Ensure no `test.cb()` is used.
- [no-identical-title](docs/rules/no-identical-title.md) - Ensure no tests have the same title.
- [no-only-test](docs/rules/no-only-test.md) - Ensure no test.only() are present.
- [no-skip-test](docs/rules/no-skip-test.md) - Ensure no tests are skipped.
- [test-ended](docs/rules/test-ended.md) - Ensure callback tests are explicitly ended.
- [test-title](docs/rules/test-title.md) - Ensure tests have a title.


## License
Expand Down
33 changes: 33 additions & 0 deletions rules/max-asserts.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
'use strict';
var util = require('../util');

module.exports = function (context) {
var maxAssertions = context.options[0] || 5;
var isTestFile = false;
var assertionCount = 0;

return {
CallExpression: function (node) {
if (util.isTestFile(node)) {
isTestFile = true;
return;
}

var callee = node.callee;
var name = callee.type === 'MemberExpression' ? callee.object.name : callee.name;
if (name === 'test') {
assertionCount = 0;
}
},

MemberExpression: function (node) {
// node.parent.type !== 'MemberExpression' --> don't count `t.skip.is(...)` twice
if (isTestFile && node.parent.type !== 'MemberExpression' && util.isAssertion(node)) {
assertionCount++;
if (assertionCount > maxAssertions) {
context.report(node, 'Too many assertions.');
}
}
}
};
};
20 changes: 20 additions & 0 deletions rules/no-cb-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
'use strict';
var util = require('../util');

module.exports = function (context) {
var isTestFile = false;

return {
CallExpression: function (node) {
if (util.isTestFile(node)) {
isTestFile = true;
}
},

MemberExpression: function (node) {
if (isTestFile && node.property.name === 'cb' && util.isCallFromTestObject(node)) {
context.report(node, 'No tests should be skipped.');
}
}
};
};
30 changes: 30 additions & 0 deletions rules/no-identical-title.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
'use strict';
var util = require('../util');

module.exports = function (context) {
var isTestFile = false;
var usedTitles = [];

return {
CallExpression: function (node) {
if (util.isTestFile(node)) {
isTestFile = true;
return;
}

if (isTestFile) {
var callee = node.callee;
var name = callee.type === 'MemberExpression' ? callee.object.name : callee.name;
if (name === 'test') {
var args = node.arguments;
var title = args.length > 1 ? args[0].value : undefined;
if (usedTitles.indexOf(title) !== -1) {
context.report(node, 'Test title is used multiple times in the same file.');
return;
}
usedTitles.push(title);
}
}
}
};
};
20 changes: 20 additions & 0 deletions rules/no-only-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
'use strict';
var util = require('../util');

module.exports = function (context) {
var isTestFile = false;

return {
CallExpression: function (node) {
if (util.isTestFile(node)) {
isTestFile = true;
}
},

MemberExpression: function (node) {
if (isTestFile && node.property.name === 'only' && util.isCallFromTestObject(node)) {
context.report(node, 'test.only() should not be used.');
}
}
};
};
20 changes: 20 additions & 0 deletions rules/no-skip-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
'use strict';
var util = require('../util');

module.exports = function (context) {
var isTestFile = false;

return {
CallExpression: function (node) {
if (util.isTestFile(node)) {
isTestFile = true;
}
},

MemberExpression: function (node) {
if (isTestFile && node.property.name === 'skip' && util.isCallFromTestObject(node)) {
context.report(node, 'No tests should be skipped.');
}
}
};
};
Loading