Skip to content

Report JSDoc syntax errors #16156

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

Merged
merged 2 commits into from
May 31, 2017
Merged

Report JSDoc syntax errors #16156

merged 2 commits into from
May 31, 2017

Conversation

sandersn
Copy link
Member

Note that JSDoc syntax errors are only reported for javascript files with // @ts-check turned on. Typescript files don't report these errors because Typescript only uses Jsdoc for documentation — it seems wrong to report syntax errors on parts of Jsdoc that aren't also being checked.

Fixes #13371

@sandersn sandersn merged commit 928da67 into master May 31, 2017
@sandersn sandersn deleted the report-jsdoc-syntax-errors branch May 31, 2017 23:21
@rbuckton
Copy link
Contributor

I think this has caused the last two builds on Travis to fail.

@sandersn
Copy link
Member Author

I thought the travis failures on this PR were due to node-stable upgrading to Node 8.

@sandersn
Copy link
Member Author

The build error I looked at was for node 6--stable is passing. It looks like tslint is now checking es5.d.ts and finding lots of lint, specifically badly formatted jsdoc. But I think that is unrelated to this change, which only adds errors to js files when checkjs is on.

@sandersn
Copy link
Member Author

Maybe --exclude is being ignored by something in the pipeline now? There is an explicit exclude for es5.d.ts.

@sandersn
Copy link
Member Author

sandersn commented Jun 1, 2017

Yep, this is a bug in tslint 5.4.0 that is fixed in 5.4.1:

palantir/tslint#2852
palantir/tslint#2853

@rbuckton
Copy link
Contributor

rbuckton commented Jun 1, 2017

Ah, thanks for investigating!

@microsoft microsoft locked and limited conversation to collaborators Jun 14, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants