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

Fix: consistent-docs-url crashes if meta.docs isn't present #10749

Merged
merged 1 commit into from Aug 11, 2018

Conversation

s4san
Copy link
Contributor

@s4san s4san commented Aug 9, 2018

What is the purpose of this pull request? (put an "X" next to item)

[ ] Documentation update
[x] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

Issue ( #10722 )

What changes did you make? (Give an overview)

  • Added a check to report missing property if metaDocs is null

Is there anything you'd like reviewers to focus on?

  • Changed the checkMetaDocsUrl function

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Aug 9, 2018
@aladdin-add aladdin-add added bug ESLint is working incorrectly infrastructure Relates to the tools used in the ESLint development process accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Aug 9, 2018
Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

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

This change LGTM, thanks!

While we're in here, can we make sure there are tests for similar scenarios:

  • Export value isn't an object
  • Export value is an object with no meta property at all

If those are covered already, great!

@s4san
Copy link
Contributor Author

s4san commented Aug 9, 2018

@platinumazure I tried to cover those cases, but it seemed a bit out of scope for this PR. I will try to elaborate,

Case 1: meta property is not defined on the exports object.

This crashes eslint and curiously, the exportsNode is of type functionExpression. I did not get to explore this case further.

Case 2: meta property is defined with a value of undefined

This creates an exception in getPropertyFromObject method where it tries to access length of undefined.

I was hoping to create a separate issue for this but I couldn't get to it. Do you think these should be investigated separately or should they be addressed in this PR?

@platinumazure
Copy link
Member

Creating a separate issue is fine. Thanks for checking!

@s4san
Copy link
Contributor Author

s4san commented Aug 9, 2018

I have created an issue #10750 and I would like to work on it

@platinumazure
Copy link
Member

platinumazure commented Aug 9, 2018

Since I realized I never mentioned it explicitly-- I'm waiting another day or so in case other team members want to take a look, before merging.

@platinumazure platinumazure merged commit 562a03f into eslint:master Aug 11, 2018
@platinumazure
Copy link
Member

Merged-- thanks @s4san for contributing!

@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 8, 2019
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly infrastructure Relates to the tools used in the ESLint development process
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants