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 clean-jsdoc-theme from 3.3.4 to 4.1.9 #1359

Closed

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Dec 5, 2022

Bumps clean-jsdoc-theme from 3.3.4 to 4.1.9.

Release notes

Sourced from clean-jsdoc-theme's releases.

In version 4.1.7

Bug fixes

  1. Extra line break in code blocks: #128
  2. History back/forward buttons don't work #135

Huge thanks to @​Viiprogrammer for reporting all the bugs.

Refactor

  1. Refactor search #127 (Thanks to @​Viiprogrammer)
  2. Update a few dependencies.

In version 4.1.0

New

  1. Make the output relocatable: #112

Bug fix

  1. Solve source map load error: #111

Deprecating:

theme_opts.base_url: We found that base_url is no more required, see the discussion for more details: #112

In version 4.0.8

New

  1. Add a tooltip when hovering on the copy code icon.

Bug Fixes

  1. A null key is cached instead of font-size on initial page load: #109
  2. Typos inside the jsdoc example: #103
  3. Solve source map load errors: #111

In version 4.0.5

Bug fixes

  1. The "Change font size" button does not work. #101

In version v4.0.0

New

  1. New dark and light theme.
  2. New search feature which doesn't cost KBs. #search
  3. Minify all generated files.
  4. Added Table of content.

Removed

  1. Search options
  2. theme options. Now it is default_theme

... (truncated)

Changelog

Sourced from clean-jsdoc-theme's changelog.

Change Log

In version 4.0.0

This is the most performant version of clean-jsdoc-theme. Check the report on lighthouse .

New

  1. New dark and light theme. Now you can toggle between dark and light themes.
  2. There is an option to change the default font size.
  3. New search feature which doesn't cost KBs. #search
  4. Minify all generated files.
  5. Added Table of content.

Removed

  1. Search options
  2. theme options. Now it is default_theme
  3. overlay_scrollbar. We found that you can include overlay scrollbar using add_script_path and include_js options.
  4. resizeable. Now there is no option to resize sidebar.

In version 3.3.2

Feature

  1. Add an option to excludes inherited symbols. (#96)[https://github-redirect.dependabot.com/Add exclude_inherited option ankitskvmdam/clean-jsdoc-theme#96]

In version 3.3.0

Feature

  1. Now there is an option to order the navbar section.

Bug Fixes

  1. Fix: Line height of empty line is render as 0 on Mozilla firefox.
  2. Fix: Unnecessary errors with empty examples (#92)[https://github-redirect.dependabot.com/unnecessary errors with empty examples ankitskvmdam/clean-jsdoc-theme#92]
  3. Fix: Disabled source still produces 'details' block ( #90)[https://github-redirect.dependabot.com/Disabled source still produces 'details' block ankitskvmdam/clean-jsdoc-theme#90]
  4. Fix: Tutorials that share their name with a class will have that classes methods dropdown ( #80)[https://github-redirect.dependabot.com/Tutorials that share their name with a class will have that classes methods dropdown ankitskvmdam/clean-jsdoc-theme#89]

Options Removed

  1. menuLocation: menuLocation theme_opts is removed. Now sections can be used to order the entire navbar section

... (truncated)

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 close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @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)

Bumps [clean-jsdoc-theme](https://github.com/ankitskvmdam/clean-jsdoc-theme) from 3.3.4 to 4.1.9.
- [Release notes](https://github.com/ankitskvmdam/clean-jsdoc-theme/releases)
- [Changelog](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CHANGELOG.md)
- [Commits](https://github.com/ankitskvmdam/clean-jsdoc-theme/commits)

---
updated-dependencies:
- dependency-name: clean-jsdoc-theme
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Dec 5, 2022
@Pezmc
Copy link
Contributor

Pezmc commented Dec 5, 2022

@knolleary Is JSDoc still in use? If not I'll remove it and this dependency entirely

@knolleary
Copy link
Member

There is the npm run docs command that uses jsdoc to generate something. This was an early attempt to auto-generate API docs - but as it was more focused on the REST API, trying to bend jsdoc to do something sensible was an unrewarding task and the results are unsatisfactory IMHO.

So we either rip up all of the jsdoc dependencies and remove the docs task, or add a task to the backlog to revisit properly with a more useful tool.

@Pezmc
Copy link
Contributor

Pezmc commented Dec 5, 2022

I'd suggest we do both, when I tested it earlier today npm run docs was currently throwing errors and was in a non-working state, so let's remove it entirely given it wasn't fit for purpose and add a task to generate API docs.

@Pezmc Pezmc mentioned this pull request Dec 5, 2022
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Dec 8, 2022

Superseded by #1384.

@dependabot dependabot bot closed this Dec 8, 2022
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/clean-jsdoc-theme-4.1.9 branch December 8, 2022 16:27
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants