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.

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

Merged
merged 3 commits into from
Jun 13, 2017
Merged

Conversation

jbeezley
Copy link
Contributor

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.

@codecov-io
Copy link

codecov-io commented Jun 12, 2017

Codecov Report

Merging #706 into master will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
src/mapInteractor.js 96.12% <0%> (+0.28%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2dd1e80...c950c6f. Read the comment docs.

Copy link
Contributor

@manthey manthey left a 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.

@jbeezley
Copy link
Contributor Author

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.

@jbeezley
Copy link
Contributor Author

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.

@jbeezley
Copy link
Contributor Author

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.

Copy link
Contributor

@manthey manthey left a 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.

@jbeezley jbeezley merged commit 03d8fce into master Jun 13, 2017
@jbeezley jbeezley deleted the eslint-jsdoc branch June 13, 2017 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants