-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
709c025
commit 2b860dc
Showing
2 changed files
with
90 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
/** | ||
* @fileoverview Rule to flag use of skipped test blocks, preventing ignored tests being committed accidentally | ||
* @author Levi Buzolic | ||
*/ | ||
|
||
'use strict'; | ||
|
||
//------------------------------------------------------------------------------ | ||
// Rule Definition | ||
//------------------------------------------------------------------------------ | ||
|
||
const defaultOptions = { | ||
match: ['xit', 'xdescribe', 'xcontext', 'xtape', 'xtest'], | ||
fix: false, | ||
}; | ||
|
||
module.exports = { | ||
meta: { | ||
docs: { | ||
description: 'disallow skipped tests', | ||
category: 'Possible Errors', | ||
recommended: true, | ||
url: 'https://github.com/levibuzolic/eslint-plugin-no-only-tests', | ||
}, | ||
fixable: true, | ||
schema: [ | ||
{ | ||
type: 'object', | ||
properties: { | ||
match: { | ||
type: 'array', | ||
items: { | ||
type: 'string', | ||
}, | ||
uniqueItems: true, | ||
default: defaultOptions.match, | ||
}, | ||
fix: { | ||
type: 'boolean', | ||
default: defaultOptions.fix, | ||
}, | ||
}, | ||
additionalProperties: false, | ||
}, | ||
], | ||
}, | ||
create(context) { | ||
const options = Object.assign({}, defaultOptions, context.options[0]); | ||
const blocks = options.block || []; | ||
const focus = options.focus || []; | ||
const fix = !!options.fix; | ||
|
||
return { | ||
Identifier(node) { | ||
const parentObject = node.parent && node.parent.object; | ||
if (parentObject == null) return; | ||
if (focus.indexOf(node.name) === -1) return; | ||
|
||
const callPath = getCallPath(node.parent).join('.'); | ||
|
||
// comparison guarantees that matching is done with the beginning of call path | ||
if ( | ||
blocks.find(block => { | ||
// Allow wildcard tail matching of blocks when ending in a `*` | ||
if (block.endsWith('*')) return callPath.startsWith(block.replace(/\*$/, '')); | ||
return callPath.startsWith(`${block}.`); | ||
}) | ||
) { | ||
context.report({ | ||
node, | ||
message: callPath + ' not permitted', | ||
fix: fix ? fixer => fixer.removeRange([node.range[0] - 1, node.range[1]]) : undefined, | ||
}); | ||
} | ||
}, | ||
}; | ||
}, | ||
}; | ||
|
||
function getCallPath(node, path = []) { | ||
if (node) { | ||
const nodeName = node.name || (node.property && node.property.name); | ||
if (node.object) return getCallPath(node.object, [nodeName, ...path]); | ||
if (node.callee) return getCallPath(node.callee, path); | ||
return [nodeName, ...path]; | ||
} | ||
return path; | ||
} |