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

publicOnly option for require-jsdoc not working #358

Closed
jatwood opened this issue Jul 29, 2019 · 7 comments
Closed

publicOnly option for require-jsdoc not working #358

jatwood opened this issue Jul 29, 2019 · 7 comments

Comments

@jatwood
Copy link

jatwood commented Jul 29, 2019

Our project uses the publicOnly option but we've found the rule still applies to functions that are not exported from the module. We've reproduced it in the the plugin test cases, here is a link to the diff.

https://github.com/gajus/eslint-plugin-jsdoc/compare/master...TeachersPayTeachers:add-repro-of-publiconly-issue?expand=1

@gajus
Copy link
Owner

gajus commented Jul 29, 2019

#288

@gajus gajus closed this as completed Jul 29, 2019
@jatwood
Copy link
Author

jatwood commented Jul 29, 2019

The linked issue seems to say that publicOnly isn't reporting an error for certain export types but our issue is that it is reporting errors for non-exported functions.

@gajus gajus reopened this Jul 29, 2019
@gajus gajus removed the duplicate label Jul 29, 2019
@gajus
Copy link
Owner

gajus commented Aug 30, 2019

🎉 This issue has been resolved in version 15.8.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Aug 30, 2019
@Josmithr
Copy link

I just updated to 15.8.4, and I am still seeing false positives. I.e. all functions are being flagged as requiring docs, not just exported ones.
Repros with the following settings:

"jsdoc/require-jsdoc": [
	"error",
	{
		"publicOnly": true
	}
]

@brettz9 brettz9 reopened this Aug 31, 2019
@brettz9
Copy link
Collaborator

brettz9 commented Aug 31, 2019

I am not seeing an issue with normal functions and publicOnly in 15.8.4. Can you provide a test case of code to reproduce you are testing with in addition to the config you provided?

@brettz9 brettz9 closed this as completed in 4aca635 Sep 1, 2019
@gajus
Copy link
Owner

gajus commented Sep 1, 2019

🎉 This issue has been resolved in version 15.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@Josmithr
Copy link

Josmithr commented Sep 3, 2019

I am no longer seeing the false-positives as of 15.9.1. Thank you!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants