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

Bump jsdoc from 3.5.5 to 3.6.3 #296

Closed

Conversation

dependabot-preview[bot]
Copy link
Contributor

@dependabot-preview dependabot-preview bot commented Jul 21, 2019

Bumps jsdoc from 3.5.5 to 3.6.3.

Changelog

Sourced from jsdoc's changelog.

3.6.3 (July 2019)

Updates dependencies.

3.6.2 (May 2019)

Fixes an issue that prevented ES 2015 classes from appearing in generated docs. (#1644[1644])

3.6.1 (May 2019)

Prevents a crash when using type applications in Node.js 12. (#1643[1643])

3.6.0 (May 2019)

Major changes

  • JSDoc is now compatible with Node.js 12, and it requires Node.js 8.15.0 or later.
  • JSDoc now recognizes all documented Closure Compiler tags. (#605[605])

Enhancements

  • You can now use the templates.useShortNamesInLinks configuration setting to show the short name
    of each symbol in link text (for example, baz), rather than the full longname (for example,
    foo.bar.baz). (#738[738])
  • When you enable the Markdown plugin, you can now specify a function that performs syntax
    highlighting in code blocks. (#1412[1412])
  • The default template now places namespaces near the top of the TOC. (#1410[1410])

Bug fixes

  • When you add a JSDoc comment to an ES2015 constructor, JSDoc now preserves all of the JSDoc tags,
    not only the description and parameters. (#1129[1129])
  • The @exports tag now works correctly when it is combined with the @enum tag. (#970[970])
  • When you enable the Markdown plugin, and you use a code fence with the language set to plain,
    JSDoc no longer pretty-prints the code block in the generated documentation. (#1361[1361])
Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot ignore this [patch|minor|major] version will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it). To ignore the version in this PR you can just close it
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
  • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
  • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
  • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
  • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
  • @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

  • Update frequency (including time of day and day of week)
  • Automerge options (never/patch/minor, and dev/runtime dependencies)
  • Pull request limits (per update run and/or open at any time)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

@coveralls
Copy link

coveralls commented Jul 21, 2019

Coverage Status

Coverage increased (+0.02%) to 90.178% when pulling d1db0f6 on dependabot/npm_and_yarn/jsdoc-3.6.3 into 78e2a22 on master.

@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.3 branch 2 times, most recently from efda117 to d0ede17 Compare July 26, 2019 09:14
@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.3 branch from d0ede17 to f6613cb Compare July 31, 2019 06:44
@codeworrior
Copy link
Member

If we consider this update (which makes sense to be able to use Node v12), the best compatibility test that comes to my mind is to run our JSDoc tooling for OpenUI5 (or at least sap.ui.core) and sap.ushell and compare the resulting logs and api.json files. sap.ui.core and sap.ushell together should show a good coverage for the JSDoc features used by UI5. The creation of the api.json files depends on JSDoc's plugin and visitor mechanisms and on the internal type representation, areas where compatibility issues in the past had shown up.

@matz3
Copy link
Member

matz3 commented Aug 1, 2019

I just did that and there's an exception when building the sap.ui.core library so it is not shown in the SDK

/ui5-builder/lib/processors/jsdoc/lib/ui5/template/publish.js:1643..
			mContributors[$.memberof].items.push($);
			                          ^

TypeError: Cannot read property 'items' of undefined
    at /ui5-builder/lib/processors/jsdoc/lib/ui5/template/publish.js:1643:30
    at Array.forEach (<anonymous>)
    at groupByContributors (/ui5-builder/lib/processors/jsdoc/lib/ui5/template/publish.js:1638:19)
    at childrenOfKind (/ui5-builder/lib/processors/jsdoc/lib/ui5/template/publish.js:1615:21)
    at createAPIJSON4Symbol (/ui5-builder/lib/processors/jsdoc/lib/ui5/template/publish.js:2958:20)
    at /ui5-builder/lib/processors/jsdoc/lib/ui5/template/publish.js:2178:21
    at Array.forEach (<anonymous>)
    at createAPIJSON (/ui5-builder/lib/processors/jsdoc/lib/ui5/template/publish.js:2176:37)
    at Object.processor (/ui5-builder/lib/processors/jsdoc/lib/ui5/template/publish.js:491:5)
    at Object.publish (/ui5-builder/lib/processors/jsdoc/lib/ui5/template/publish.js:618:42)
    at Object.module.exports.cli.generateDocs (/ui5-builder/node_modules/jsdoc/cli.js:441:39)
    at Object.module.exports.cli.processParseResults (/ui5-builder/node_modules/jsdoc/cli.js:392:24)
    at module.exports.cli.main (/ui5-builder/node_modules/jsdoc/cli.js:235:18)
    at Object.module.exports.cli.runCommand (/ui5-builder/node_modules/jsdoc/cli.js:186:9)
    at /ui5-builder/node_modules/jsdoc/jsdoc.js:93:9
    at Object.<anonymous> (/ui5-builder/node_modules/jsdoc/jsdoc.js:94:3)

So as you said, we need to have a look into it..

@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.3 branch 2 times, most recently from 01bd209 to 45de715 Compare August 11, 2019 04:23
@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.3 branch 2 times, most recently from 22b0dd8 to 8e8f27a Compare August 18, 2019 04:32
@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.3 branch from 8e8f27a to 56f94c2 Compare September 10, 2019 08:30
@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.3 branch from 56f94c2 to 048f5e9 Compare September 29, 2019 04:33
@codeworrior
Copy link
Member

The issue in publish.js is caused by an inconsistency between the inherits (symbol name, x-ref) and inherited (boolean) flags for borrowed symbols. In JSDoc 3.5.5, a symbol marked as inherited always had a value for inherits, now it might be undefined.

This for example happens for the DragDropInfo which inherits the setEnabled method from DragDropBase. For setEnabled, the visibility was forgotten in the source code, therefore it was treated as private and removed. In 3.5.5. this also removed it from the borrowed methods (see https://openui5nightly.hana.ondemand.com/#/api/sap.ui.core.dnd.DragDropInfo), in 3.6.3 it is still there but the link to the inherited symbol is broken. The code in publish.js is not prepared to handle this and fails.

The code in publish.js can (and should) be made more robust (and the documentation of setEnabled should be fixed). But maybe we should also understand why the issue now occurs. Otherwise we might miss other, still hidden issues. Maybe order of execution has changed. If we removed the private methods in 3.5.5. before the borrowed members have been determined and now the same steps happen in the opposite order, this could already explain the issue.

@tobiasso85
Copy link
Contributor

@dependabot rebase

Bumps [jsdoc](https://github.com/jsdoc/jsdoc) from 3.5.5 to 3.6.3.
- [Release notes](https://github.com/jsdoc/jsdoc/releases)
- [Changelog](https://github.com/jsdoc/jsdoc/blob/master/CHANGES.md)
- [Commits](jsdoc/jsdoc@3.5.5...3.6.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.3 branch from bded3bf to d1db0f6 Compare October 21, 2019 14:20
@RandomByte
Copy link
Member

Bummer. I thought this was part of #346 🙄

Anyways, we should open the range in package.json again to allow consumers more control over it (we closed it with #247). So instead of merging this PR, I'd rather merge this: #356

@dependabot-preview
Copy link
Contributor Author

Looks like jsdoc is up-to-date now, so this is no longer needed.

@dependabot-preview dependabot-preview bot deleted the dependabot/npm_and_yarn/jsdoc-3.6.3 branch October 22, 2019 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants