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

Support comments in arrow functions when fixing #253

Merged
merged 2 commits into from
May 29, 2020
Merged

Support comments in arrow functions when fixing #253

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d61c4a
Support comments in arrow functions when fixing
edg2s May 27, 2020
2eefa13
Add 'extractSourceTextByRange' and move const/lets around
edg2s May 29, 2020
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
27 changes: 18 additions & 9 deletions lib/rules/no-mocha-arrows.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* @author Paul Melnikow
*/

const last = require('ramda/src/last');
const astUtils = require('../util/ast');

module.exports = {
Expand All @@ -16,21 +15,31 @@ module.exports = {
create(context) {
const sourceCode = context.getSourceCode();

// eslint-disable-next-line max-statements
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure how you feel about this rule, but I didn't see an obvious way to break up this method without passing multiple return values.

Copy link
Owner

Choose a reason for hiding this comment

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

It’s not a hard requirement. I don’t have a better approach in mind for now. As long as we have a good test coverage we can always refactor the code later 😉.

function formatFunctionHead(fn) {
const paramsLeftParen = sourceCode.getFirstToken(fn);
const paramsRightParen = sourceCode.getTokenBefore(sourceCode.getTokenBefore(fn.body));
let paramsFullText = sourceCode.text.slice(paramsLeftParen.range[0], paramsRightParen.range[1]);
const arrow = sourceCode.getTokenBefore(fn.body);
let firstToken = sourceCode.getFirstToken(fn);
const beforeArrowToken = sourceCode.getTokenBefore(arrow);
let paramsFullText;
let params = sourceCode.text.slice(firstToken.range[0], beforeArrowToken.range[1]).trim();
let functionKeyword = 'function';
const beforeArrowComment = sourceCode.text.slice(beforeArrowToken.range[1], arrow.range[0]).trim();
const afterArrowComment = sourceCode.text.slice(arrow.range[1], fn.body.range[0]).trim();
Copy link
Owner

Choose a reason for hiding this comment

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

For better readability I would suggest to extract the repeated pattern of sourceCode.text.slice(start, end).trim() to a function.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is

sliceAndTrim( sourceCode.text, beforeArrowToken.range[1], arrow.range[0] );

much more concise or legible?

Copy link
Owner

Choose a reason for hiding this comment

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

I think sourceCode.text doesn’t need to be a parameter when we define the new function in the scope of the create function. Maybe a better name would be something like extractSourceTextByRange(). WDYT?


if (fn.async) {
// When 'async' specified, take care about the keyword.
// When 'async' specified strip the token from the params text
// and prepend it to the function keyword
params = params.slice(firstToken.range[1] - firstToken.range[0]).trim();
functionKeyword = 'async function';
// Strip 'async (...)' to ' (...)'
paramsFullText = paramsFullText.slice(5);

// Advance firstToken pointer
firstToken = sourceCode.getTokenAfter(firstToken);
}

if (fn.params.length > 0) {
paramsFullText = `(${ sourceCode.text.slice(fn.params[0].range[0], last(fn.params).range[1]) })`;
if (firstToken.type !== 'Punctuator') {
paramsFullText = `(${params}${beforeArrowComment})${afterArrowComment}`;
} else {
paramsFullText = `${params}${beforeArrowComment}${afterArrowComment}`;
}

return `${functionKeyword}${paramsFullText} `;
Expand Down
9 changes: 7 additions & 2 deletions test/rules/no-mocha-arrows.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,12 @@ ruleTester.run('no-mocha-arrows', rules['no-mocha-arrows'], {
{
code: 'it(async () => { assert(something, false) })',
errors,
output: 'it(async function () { assert(something, false) })'
output: 'it(async function() { assert(something, false) })'
},
{
code: 'it(async () => assert(something, false))',
errors,
output: 'it(async function () { return assert(something, false); })'
output: 'it(async function() { return assert(something, false); })'
},
{
code: 'it(async done => assert(something, false))',
Expand All @@ -95,6 +95,11 @@ ruleTester.run('no-mocha-arrows', rules['no-mocha-arrows'], {
code: 'it(async() => assert(something, false))',
errors,
output: 'it(async function() { return assert(something, false); })'
},
{
code: 'it(/*one*/async/*two*/(done)/*three*/=>/*four*/assert(something, false))',
errors,
output: 'it(/*one*/async function/*two*/(done)/*three*//*four*/ { return assert(something, false); })'
}
]

Expand Down