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

chore: bump jsdoc from 3.6.11 to 4.0.2 #4190

Merged
merged 1 commit into from
Jan 11, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 12, 2023

Bumps jsdoc from 3.6.11 to 4.0.2.

Changelog

Sourced from jsdoc's changelog.

4.0.2 (February 2023)

Updates the Babel parser, and enables additional Babel plugins for ECMAScript proposals.

4.0.1 (February 2023)

If an inline link tag uses a pipe delimiter, and there are spaces around the pipe delimiter, then the HTML link no longer contains %20 at the end; also, the link text no longer contains extra spaces. For example, {@link https://example.com | link text} is now rendered as <a href="https://example.com/">link text</a> rather than <a href="https://example.com/%20"> link text</a>.

4.0.0 (November 2022)

Commits
  • 0b6193f 4.0.2
  • 9d88548 deps: update Babel; enable current Babel plugins in parser
  • c2dd210 4.0.1
  • 3d90c8a fix: in inline links, strip spaces around pipe character
  • 37fc8cd chore: tell Prettier not to format files
  • a5e4688 chore(deps): update deps
  • 0842185 4.0.0
  • b018408 chore!: replace taffydb package with @​jsdoc/salty
  • See full diff in compare view

Dependabot compatibility score

You can trigger a rebase of this PR 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 close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
  • @dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
  • @dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
  • @dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
  • @dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

@dependabot dependabot bot requested a review from a team as a code owner October 12, 2023 14:28
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Oct 12, 2023
@CLAassistant
Copy link

CLAassistant commented Oct 12, 2023

CLA assistant check
All committers have signed the CLA.

@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/jsdoc-4.0.2 branch from cc3279f to 550463b Compare October 25, 2023 13:40
@@ -122,6 +122,7 @@
"chai": "^4.3.7",
"chalk": "^4.x",
"chromedriver": "latest",
"clean-jsdoc-theme": "^4.2.17",
Copy link
Contributor

Choose a reason for hiding this comment

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

It was surprisingly difficult to find a jsdoc template that had upgraded to jsdoc 4. Most are still designed only for jsdoc 3 and use the taffydb dependency which jsdoc 4 has said is no longer supported.

This theme is arbitrarily chosen from a short list I could find. Dependencies looked minimal and didn't add anything to npm audit

dbjorge
dbjorge previously approved these changes Jan 11, 2024
Copy link
Contributor

@dbjorge dbjorge 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. It's not thrilling that the new template has some axe-core violations, but:

  • the old one did too (though fewer)
  • I didn't find any pre-existing better options either
  • I don't think these docs are likely to have wide enough usage to be worth spending time customizing the template for them

@straker straker merged commit b753f95 into develop Jan 11, 2024
22 checks passed
@straker straker deleted the dependabot/npm_and_yarn/jsdoc-4.0.2 branch January 11, 2024 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants