Skip to content

test: Configure eslint properly for Mocha tests #288

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
Merged
merged 5 commits into from
Jun 10, 2020
Merged

test: Configure eslint properly for Mocha tests #288

merged 5 commits into from
Jun 10, 2020

Conversation

@kadler
Copy link
Member

@kadler kadler commented Jun 10, 2020 •
edited
Loading

There's a few commits in here:

  • The first two are just some eslintrc cleanup.
  • The third configures the eslint environment for mocha for all tests and removes the now redundant eslint-env comments from them.
  • The fourth commit adjusts some AirBnB rules which conflict with Mocha's conventions/usage.
  • The last commit pulls in eslint-plugin-mocha and enables these rules for the tests, though it disables some rules due to many existing tests running not following these rules

This sets things up for #283 and more.

kadler added 4 commits June 10, 2020 17:42
@kadler
test: Constrain eslint rules
382c6fc 
Instead of disabling import/no-extraneous-dependencies and
import/no-unresolved globally, constrain them to the specific instances
where they are needed using eslint comments.

In addition, explain why the no-console error must be disabled.
@kadler
test: Fix eslint errors issues in eslintrc
40eb459
@kadler
test: Configure tests to use Mocha env in eslintrc
86f79df 
Currently, all of our tests add a comment at the top of the file to
configure the eslint environment. Instead, we can set this for all tests
by using an override in the eslint config file.
@kadler
test: Adjust AirBnB rules for Mocha tests
d74c7d2 
Mocha conventions use nameless functions instead of arrow functions
because arrow functions lexically bind `this`, preventing you from
accessing the Mocha context. This prevents setting timeouts and other
things which require the Mocha context.

See https://mochajs.org/#arrow-functions and
airbnb/javascript#433
@kadler kadler requested a review from abmusse June 10, 2020 23:05
@kadler kadler marked this pull request as draft June 10, 2020 23:06
@kadler
test: Use eslint-plugin-mocha for tests
63ccb9d 
This pulls in the eslint-plugin-mocha and enables its use when linting
tests. Because our existing tests do not always follow the Mocha
conventions, some mocha rules are disable for now. See #289
@kadler kadler marked this pull request as ready for review June 10, 2020 23:16
abmusse
abmusse approved these changes Jun 10, 2020
View reviewed changes
Copy link
Member

@abmusse abmusse left a comment

Choose a reason for hiding this comment

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

LGTM

@kadler kadler changed the title Configure eslint properly for Mocha tests test: Configure eslint properly for Mocha tests Jun 10, 2020
@kadler kadler merged commit 89e67e6 into master Jun 10, 2020
@kadler kadler deleted the eslint-mocha branch June 10, 2020 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@abmusse abmusse abmusse approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kadler @abmusse