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.

Sign up for GitHub

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

Jump to bottom

Make no-mocha-arrows rule fixable #112

Merged
merged 9 commits into from
Nov 3, 2016
Merged

Make no-mocha-arrows rule fixable #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3eda08b
Make no-mocha-arrows rule fixable
rhysd Oct 26, 2016
9125080
Add missing 'return' on translating arrow function to normal function
rhysd Oct 27, 2016
aa09e6e
Add tests for generator function, async function and 'done' callback
rhysd Oct 27, 2016
b479d36
Fix the case where async function is passed
rhysd Oct 27, 2016
55055b1
Consider async() => ... pattern (no space before params)
rhysd Oct 27, 2016
f132ec7
Separate test runner by ecmaVersion
rhysd Oct 27, 2016
c5c28f1
DRY common errors
rhysd Oct 27, 2016
d025cee
Separate a function to fix as a helper
rhysd Oct 27, 2016
153ec6d
Use one test runner for all test cases
rhysd Nov 2, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 39 additions & 1 deletion lib/rules/no-mocha-arrows.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,38 @@ module.exports = function (context) {
return !R.find(R.propEq('name', name), scope.variables);
}

function fixArrowFunction(fixer, fn) {
var sourceCode = context.getSourceCode(),
paramsLeftParen = sourceCode.getFirstToken(fn),
paramsRightParen = sourceCode.getTokenBefore(sourceCode.getTokenBefore(fn.body)),
paramsFullText =
sourceCode.text.slice(paramsLeftParen.range[0], paramsRightParen.range[1]),
functionKeyword = 'function ',
bodyText;

if (fn.async) {
// When 'async' specified, take care about the keyword.
functionKeyword = 'async function';
// Strip 'async (...)' to ' (...)'
paramsFullText = paramsFullText.slice(5);
}

if (fn.body.type === 'BlockStatement') {
// When it((...) => { ... }),
// simply replace '(...) => ' with 'function () '
return fixer.replaceTextRange(
[ fn.start, fn.body.start ],
functionKeyword + paramsFullText + ' '
);
}

bodyText = sourceCode.text.slice(fn.body.range[0], fn.body.range[1]);
return fixer.replaceTextRange(
[ fn.start, fn.end ],
functionKeyword + paramsFullText + ' { return ' + bodyText + '; }'
);
}

return {
CallExpression: function (node) {
var name = getCalleeName(node.callee),
Expand All @@ -50,7 +82,13 @@ module.exports = function (context) {
fnArg = node.arguments.slice(-1)[0];
if (fnArg && fnArg.type === 'ArrowFunctionExpression') {
if (isLikelyMochaGlobal(context.getScope(), name)) {
context.report(node, 'Do not pass arrow functions to ' + name + '()');
context.report({
node: node,
message: 'Do not pass arrow functions to ' + name + '()',
fix: function (fixer) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this function is starting to get pretty big, declare it somewhere else and pass the needed info

function fix(context, fnArg, ...) {
  return function (fixer) {
     var sourceCode = context.getSourceCode(),
           paramsLeftParen = sourceCode.getFirstToken(fnArg),
     // ...
  };
}

// ...
context.report({
  node: node,
  message: // ...
  fix: fix(context, fnArg, ...)
});

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree :)

return fixArrowFunction(fixer, fnArg);
}
});
}
}
}
Expand Down
64 changes: 46 additions & 18 deletions test/rules/no-mocha-arrows.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,49 +2,77 @@

var RuleTester = require('eslint').RuleTester,
rules = require('../../').rules,
ruleTester = new RuleTester(),
expectedErrorMessage = 'Do not pass arrow functions to it()';
ruleTester = new RuleTester({
parserOptions: { ecmaVersion: 2017 }
}),
expectedErrorMessage = 'Do not pass arrow functions to it()',
errors = [ { message: expectedErrorMessage, column: 1, line: 1 } ];

ruleTester.run('no-mocha-arrows', rules['no-mocha-arrows'], {

valid: [
'it()',
'it(function() { assert(something, false); })',
'it("should be false", function() { assert(something, false); })',
{
// In this example, `it` is not a global.
code: 'function it () {}; it(() => { console.log("okay") })',
parserOptions: { ecmaVersion: 6 }
},
'it.only()'
// In this example, `it` is not a global.
'function it () {}; it(() => { console.log("okay") })',
'it.only()',
'it(function(done) { assert(something, false); done(); })',
'it(function*() { assert(something, false) })',
'it(async function () { assert(something, false) })'
],

invalid: [
{
code: 'it(() => { assert(something, false); })',
parserOptions: { ecmaVersion: 6 },
errors: [ { message: expectedErrorMessage, column: 1, line: 1 } ]
errors: errors,
output: 'it(function () { assert(something, false); })'
},
{
code: 'it(() => { assert(something, false); })',
globals: [ 'it' ],
parserOptions: { ecmaVersion: 6 },
errors: [ { message: expectedErrorMessage, column: 1, line: 1 } ]
errors: errors,
output: 'it(function () { assert(something, false); })'
},
{
code: 'it(() => assert(something, false))',
parserOptions: { ecmaVersion: 6 },
errors: [ { message: expectedErrorMessage, column: 1, line: 1 } ]
errors: errors,
output: 'it(function () { return assert(something, false); })'
},
{
code: 'it("should be false", () => { assert(something, false); })',
parserOptions: { ecmaVersion: 6 },
errors: [ { message: expectedErrorMessage, column: 1, line: 1 } ]
errors: errors,
output: 'it("should be false", function () { assert(something, false); })'
},
{
code: 'it.only(() => { assert(something, false); })',
parserOptions: { ecmaVersion: 6 },
errors: [ { message: 'Do not pass arrow functions to it.only()', column: 1, line: 1 } ]
errors: [ { message: 'Do not pass arrow functions to it.only()', column: 1, line: 1 } ],
output: 'it.only(function () { assert(something, false); })'
},
{
code: 'it((done) => { assert(something, false); })',
errors: errors,
output: 'it(function (done) { assert(something, false); })'
},
{
code: 'it("should be false", () => {\n assert(something, false);\n})',
errors: errors,
output: 'it("should be false", function () {\n assert(something, false);\n})'
},
{
code: 'it(async () => { assert(something, false) })',
errors: errors,
output: 'it(async function () { assert(something, false) })'
},
{
code: 'it(async () => assert(something, false))',
errors: errors,
output: 'it(async function () { return assert(something, false); })'
},
{
code: 'it(async() => assert(something, false))',
errors: errors,
output: 'it(async function() { return assert(something, false); })'
}
]

Expand Down