-
Notifications
You must be signed in to change notification settings - Fork 75
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
Update eslint and enable linting of docstrings #706
Conversation
Codecov Report
@@ Coverage Diff @@
## master #706 +/- ##
==========================================
+ Coverage 95.25% 95.27% +0.02%
==========================================
Files 83 83
Lines 8980 8980
==========================================
+ Hits 8554 8556 +2
+ Misses 426 424 -2
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine with this change, though I wish the --fix
process did a nicer job.
Now that I look at it again, I think I'll change some of the new options to reduce the number of changes here. Rebase incoming. |
I found there are some big changes to how indentation is handled in 4.0. It also provides more flexibility in configuration. I reverted the eslint update for now. I'll make another pass at it once our peer dependencies are all compatible with 4.0. |
I'm getting all sorts of random errors on travis about missing node modules during the build. I had tried to upgrade npm, but that didn't seem to help, so I reverted that change. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll approve this again, since it changed substantially since the first time.
This updates to eslint v3. Technically, v4 is out as of yesterday, but our peer dependencies haven't been updated yet. There are a number of new rules (mostly whitespace) that needed to be fix. Thankfully most of the changes only required running
eslint --fix .
.The main purpose of this PR is to add linting of our docstrings. The rules I choose are designed to enforce the style of the docstrings added in
map.js
in #698. I have the rules set to warnings for now until we get around to fixing them all, which could take a while.I also made a PR against eslint to add enforcement of parameter and return value descriptions (eslint/eslint#8716). If and when this is merged, we can enforce our docstring conventions there as well.