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(deps): update doc-dependencies #2301

Merged
merged 13 commits into from
Dec 29, 2023
Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 8, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@algolia/client-search ~4.19.1 -> ~4.20.0 age adoption passing confidence
typedoc (source) ~0.24.8 -> ~0.25.3 age adoption passing confidence
vitepress (source) 1.0.0-beta.7 -> 1.0.0-rc.25 age adoption passing confidence

Release Notes

algolia/algoliasearch-client-javascript (@​algolia/client-search)

v4.20.0

Compare Source

TypeStrong/TypeDoc (typedoc)

v0.25.3

Compare Source

Features
  • Added --sourceLinkExternal option to render source code links as external, #​2415.
  • TypeDoc no longer requires the declarationMap option to be set to true to handle cross-package links in packages mode, #​2416.
  • Added external-last option for the --sort option, #​2418.
Bug Fixes
  • TypeDoc now attempts to correct local anchor links in readme files which are broken by its deconfliction logic, #​2413.
  • TypeDoc now finds comments on index signatures again, #​2414.
  • TypeDoc now does a better job of detecting properties when destructured function arguments are used.
  • Quotes will now be properly escaped in HTML attribute values.
Thanks!

v0.25.2

Compare Source

Features
  • Added navigationLeaves option to remove branches from the navigation tree, #​2382.
  • Added sortEntryPoints option (defaults to true) to allow disabling entry point sorting, #​2393.
  • Improved support for multi-word searches, #​2400.
Bug Fixes
  • Fixed conversion of @template constraints on JSDoc defined type parameters, #​2389.
  • Invalid link validation is now correctly suppressed before all projects have been converted in packages mode, #​2403.
  • Fixed tsconfig handling for projects using a solution-style tsconfig, #​2406.
  • Fixed broken settings icons caused by icon caching introduced in 0.25.1, #​2408.
  • Corrected module comment handling on declaration files containing a single declare module "foo", #​2401.
Thanks!

v0.25.1

Compare Source

Features
  • Added stripYamlFrontmatter config option to remove YAML frontmatter from README.md, #​2381.
  • Added --excludeCategories config option to remove reflections present in any excluded category, #​1407.
  • If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, #​2304.
  • Navigation is now written to a JS file and built dynamically, which significantly decreases document generation time
    with large projects and also provides large space benefits. Themes may now override DefaultTheme.buildNavigation
    to customize the displayed navigation tree, #​2287.
    Note: This change renders navigation.fullTree obsolete. If you set it, TypeDoc will warn that it is being ignored.
    It will be removed in v0.26.
  • The search index is now compressed before writing, which reduces most search index sizes by ~5-10x.
  • TypeDoc will now attempt to cache icons when DefaultThemeRenderContext.icons is overwritten by a custom theme.
    Note: To perform this optimization, TypeDoc relies on DefaultThemeRenderContext.iconCache being rendered within
    each page. TypeDoc does it in the defaultLayout template.
  • Cache URL derivation during generation, #​2386.
Bug Fixes
  • @property now works as expected if used to override a method's documentation.
  • Deprecated functions/methods are now correctly rendered with a struck-out name.
  • --watch mode works again, #​2378.
  • Improved support for optional names within JSDoc types, #​2384.
  • Fixed duplicate rendering of reflection flags on signature parameters, #​2385.
  • TypeDoc now handles the intrinsic keyword if TS intrinsic types are included in documentation.
  • --exclude is now respected when expanding globs in entry points, #​2376.
Thanks!

v0.25.0

Compare Source

Breaking Changes
  • Bump minimum Node version to 16.
  • Removed legacy-packages option for --entryPointStrategy.
  • Changed default value of --categorizeByGroup to false.
  • Specifying a link as the gitRemote is no longer supported.
  • An Application instance must now be retrieved via Application.bootstrap or Application.bootstrapWithPlugins, #​2268.
  • Removed ReflectionKind.ObjectLiteral that was never used by TypeDoc.
  • Removed deprecated members DefaultThemeRenderContext.comment and DefaultThemeRenderContext.attemptExternalResolution.
Features
  • Added support for TypeScript 5.2, #​2373.
  • TypeDoc config files now support options default-exported from an ESM config file, #​2268.
  • TypeDoc config files may now export a promise containing configuration, #​2268.
  • Added --preserveLinkText option (defaults to true) which determines whether the reflection name or full link text is included
    in the output when no override is specified, #​2355.
  • Added a no-results placeholder when no search results are available, #​2347.
  • Implemented several miscellaneous performance improvements to generate docs faster, this took the time to generate TypeDoc's
    site from ~5.6 seconds to ~5.4 seconds.
  • Added --disableGit option to prevent TypeDoc from using Git to try to determine if sources can be linked, #​2326.
  • Added support for tags @showGroups, @hideGroups, @showCategories, @hideCategories to configure the navigation pane on a
    per-reflection basis, #​2329.
  • With --jsDocCompatibility.defaultTags set, @defaultValue is now implicitly a code block if the text contains no code, #​2370.
Bug Fixes
  • Fixed link discovery if nested (Foo#bar) links were used and --useTsLinkResolution is enabled in some cases, #​2360.
  • Links with invalid declaration references will no longer silently link to the wrong page in some cases, #​2360.
  • Fixed duplicate definitions in type hierarchy when using packages mode, #​2327.
  • @inheritDoc was not properly resolved across packages in packages mode, #​2331.
  • Added warning for attempted @interface use on union types, #​2352.
  • Fixed misleading type annotation on Theme.getUrls, #​2318.
  • Fixed duplicate namespace in documentation if @namespace is used on a variable with an associated namespace, #​2364.
  • Fixed @namespace property discovery if merged with a type and the type was declared first #​2364.
  • Tables in markdown are now styled, #​2366.
  • Sidebar links no longer open in a new tab, #​2353.
  • Headers now include some padding before rendering text, #​2316.
  • Symbol locations for signatures on reflection.sources now considers the node's name like non-signature location discovery does.
Thanks!

v0.24.8 (2023-06-04)

Features
  • Added support for TypeScript 5.1, #​2296.
  • Added navigation.fullTree to control rendering the full navigation tree on each page, #​2287.
    This option will likely be replaced in 0.25 with dynamic loading of the full tree.
  • TypeDoc's --pretty option now also controls whether generated HTML contains line breaks, #​2287.
  • Optimized icon caching to reduce file size in generated HTML documentation, #​2287.
  • Render property description of "roughly top level" object types, #​2276.
  • Added MarkdownEvent.INCLUDE for plugins, #​2284.
Bug Fixes
  • When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type,
    and any other block tags in the order they are defined in the comment, #​2285.
  • Comments are no longer removed from classes/interfaces containing call signatures, #​2290.
Thanks!

v0.24.7 (2023-05-08)

Features
  • TypeDoc will now allow conversion without any entry points to support "readme only" packages, #​2264.
Bug Fixes
  • Category children are now sorted according to the sort option, #​2272.
  • Inline tags no longer require a space after the tag name to be parsed as a tag, #​2273.
  • Fixed module/namespace links in navigation when viewed in Safari, #​2275.

v0.24.6 (2023-04-24)

Features
  • Improved error messaging if a provided entry point could not be converted into a documented module reflection, #​2242.
  • API: Added support for g, circle, ellipse, polygon, and polyline svg elements, #​2259.
  • Extended jsDocCompatibility option with inheritDocTag to ignore fully lowercase inheritDoc tags and
    ignoreUnescapedBraces to disable warnings about unescaped { and } characters in comments.
Bug Fixes
  • --useTsLinkResolution is no longer ignored within block tags, #​2260.
  • The current namespace will also be expanded in the navigation on page load, #​2260.
  • Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.
  • Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.
Thanks!

v0.24.5 (2023-04-22)

Features
  • Categories and groups can now be shown in the navigation, added --navigation.includeCategories
    and --navigation.includeGroups to control this behavior. The --categorizeByGroup option also
    effects this behavior. If categorizeByGroup is set (the default) and navigation.includeGroups is
    not set, the value of navigation.includeCategories will be effectively ignored since categories
    will be created only within groups, #​1532.
  • Added support for discovering a "module" comment on global files, #​2165.
  • Added copy code to clipboard button, #​2153.
  • Function @returns blocks will now be rendered with the return type, #​2180.
  • Added --groupOrder option to specify the sort order of groups, #​2251.
Bug Fixes
  • Type parameter constraints now respect the --hideParameterTypesInTitle option, #​2226.
  • Even more contrast fixes, #​2248.
  • Fix semantic highlighting for predicate type's parameter references, #​2249.
  • Fixed broken links to heading titles.
  • Fixed inconsistent styling between type parameter lists and parameter lists.
  • TypeDoc will now warn if more than one @returns block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.
Thanks!

v0.24.4 (2023-04-16)

Bug Fixes
  • Fixed broken semantic coloring, #​2247.
  • Increased contrast for parameter titles in dark mode to meet WCAG AA contrast requirements, #​2244.
  • Underline color of index links now matches the text color, #​2245.
  • Increased contract for active menu item text in dark mode.

v0.24.3 (2023-04-16)

Bug Fixes

v0.24.2 (2023-04-15)

Features
  • Added semantic link coloring for reflection names & links, #​2227.
    Note: This resulted in function signatures becoming too busy for easy scanning with even slightly
    complicated signatures as such, TypeDoc now only renders parameter names in the signature title
    and includes the type in the parameter details as usual. This can be controlled with the new
    --hideParameterTypesInTitle option.
  • Conditional types will now render their branches on the next line for easier comprehension.
Bug Fixes
  • Fixed & showing as & and HTML text showing up in page contents navigation, #​2224.
  • Increased padding between sections when one navigation column is displayed, #​2225.
  • Correct padding for navigation elements with a displayed icon, #​2229.
  • Fixed source-order sort strategy failing to compare reflections within a file.
  • Added enum-member-source-order specialization of the source-order sort strategy which only compares enum members, #​2237.
  • Updated highlight colors for semantic links to meet WCAG AA contrast requirements, #​2228.
  • Type parameters are now highlighted consistently, #​2230.
  • Fixed semantic coloring in type and function signatures, #​2227.
  • Fixed issue where removing a reflection indirectly containing an object/function type would only partially remove the reflection, #​2231.
  • Fixed "Implementation of X.y" links if a mixture of methods and property-methods are used, #​2233.
  • "Implementation of" text to symbol-properties not contained in the documentation will now use the resolved name instead of a __@​ symbol name, #​2234.
  • Fix expansion of globs if a single entry point is provided, #​2235.
  • Validation will no longer be skipped for sub packages when running with --entryPointStrategy packages.
  • Fixed broken theme toggle if the page contained a member named "theme".
Thanks!

v0.24.1 (2023-04-09)

Bug Fixes
  • Improve detection for legacy JSDoc @example tags, #​2222.
  • The page footer will now appear at the bottom of the page even if the page is short, #​2223.
vuejs/vitepress (vitepress)

v1.0.0-rc.25

Compare Source

Bug Fixes
Features
Performance Improvements

v1.0.0-rc.24

Compare Source

Bug Fixes
  • lock plugin-vue version (aa75fd6)
  • styles: large blur radius is causing color issues with safari (a31e143)
Features

v1.0.0-rc.23

Compare Source

Bug Fixes

v1.0.0-rc.22

Compare Source

Bug Fixes
  • fixes a regression related with nanoid v5 (#​3090)

v1.0.0-rc.21

Compare Source

Bug Fixes
Features

v1.0.0-rc.20

Compare Source

Bug Fixes
  • build: consistent route.path across dev and ssr (#​2997) (0d56855)
  • build: don't show missing lang warnings with text specifiers in fences (aa40cec)
  • handle references in container titles (7fbfe71), closes #​3004
  • hmr: handle hmr in imported code snippets (#​3005) (e84f313)
  • snippet hmr not working with rewrites (a275049)
  • selectively pass env for container titles (1a9c32d), closes #​3007
  • types: add RegExp to markdown's allowed attributes (#​3008) (bc96b2b)

v1.0.0-rc.19

Compare Source

v1.0.0-rc.18

Compare Source

v1.0.0-rc.17

Compare Source

v1.0.0-rc.16

Compare Source

v1.0.0-rc.15

Compare Source

Bug Fixes
Features
  • allow passing fast glob options to createContentLoader (4f9a60b), closes #​2985

v1.0.0-rc.14

Compare Source

Bug Fixes
Features

v1.0.0-rc.13

Compare Source

Bug Fixes
Features
  • theme: add search insights boolean to algolia search (#​2940) (32aa2a7)
Reverts

v1.0.0-rc.12

Compare Source

Bug Fixes
Features
  • highlight nav by default when one of the items is matched (#​2893) (b1fbece)
  • process md includes before building local search index (#​2906) (c6ff5c7)
  • support for customizing the starting line number in a code block (#​2917) (c0ce7f7)
  • theme: allow setting target in home features (#​2897) (cb49673)
  • theme: use inert to avoid traverse menus and content with keyboard (#​2932) (070fc0a)

v1.0.0-rc.11

Compare Source

Bug Fixes
  • init: missing mts extension on windows (195ebe9), closes #​2886
  • respect attrs on custom containers (8b76167)
  • temp workaround for broken navigation from 404 to home (a18d544), closes #​2891
  • theme: dropdown menu partially hidden by the homepage footer when it is too long (#​2904) (a60f079)
  • theme: improve contrast of search highlight text (#​2887) (20f9770)
  • theme: link hover color inside a custom block (#​2876) (39784ca)
  • theme: prevent layout shift in search button key (#​2889) (0088434)
  • theme: search button key misplaced on safari (18adc07)
  • types: NavItem can only have either link or items (#​2880) (12ef12d)
Features

v1.0.0-rc.10

Compare Source

Bug Fixes
  • pseudo styles being removed with postcssIsolateStyles (21b4f8c), closes #​2868 #​2867
  • resolve snippets from original file path - align with include behavior (8aa032f)
Features
  • allow overriding mdit-vue/component options (4f01f1a)
Reverts
  • "fix: createContentLoader generates invalid url when sets base" (#​2865) (6be5a7e)

v1.0.0-rc.9

Compare Source

Bug Fixes
  • a11y/theme: disable transitions if user prefers reduced motion (fc5092f)
  • build: respect preserveSymlinks (#​2780) (1bda710)
  • cli/init: print the correct packageManager (#​2787) (b388b0a)
  • cli/init: terminal message has not enough contrast (#​2786) (4d9d977)
  • restart server on theme creation/deletion (#​2785) (e0be677)
  • scroll-to-top in iOS when opens sidebar (#​2803) (3dab9a6)
  • stackblitz not working on firefox (877f643), closes #​2817
  • theme: docsearch variables not applying properly on ios beta (436e99a)
  • theme: improve logo svg and add art dir (1f8c58a)
  • theme: prevent sidebar re-render unless there is actual change (33962e0), closes #​2796
  • theme: revert 79 to 179 in yellow-soft (#​2858) (74fcb60)
  • theme: show only one carbon ad at a time (5ced0cc)
  • theme: ssr issues on deno (e8edd0a)
Features
BREAKING CHANGES
  • pathname:// protocol is dropped. Specify target="_self" or target="_blank" instead. Refer docs to learn more.
  • Shiki's default theme is now changed to github-light and github-dark. If you want to use the old theme, you can set markdown.theme in your config to 'material-theme-palenight'.
  • Internal logic of isDark is changed to use vueuse. It might impact your custom theme. You can customize its behavior using appearance option.
  • Default theme's color system is updated to make it more easily customizable. Refer the PR for new variables.

v1.0.0-rc.8

Compare Source

v1.0.0-rc.7

Compare Source

v1.0.0-rc.6

Compare Source

v1.0.0-rc.5

Compare Source

v1.0.0-rc.4

Compare Source

Bug Fixes
Features
Reverts
BREAKING CHANGES
  • Node v18+ is now required to run VitePress.
  • VitePress now only provides ESM API. Refer #​2703 for details.

v1.0.0-rc.3

Compare Source

v1.0.0-rc.2

Compare Source

v1.0.0-rc.1

Bug Fixes
Features

Configuration

📅 Schedule: Branch creation - "before 4am on Monday" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from a team as a code owner August 8, 2023 20:53
@renovate renovate bot added the c: dependencies Pull requests that adds/updates a dependency label Aug 8, 2023
@ST-DDT
Copy link
Member

ST-DDT commented Aug 8, 2023

I created this PR to ensure the rc versions don't break anything for us.

@codecov
Copy link

codecov bot commented Aug 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (945acc1) 99.57% compared to head (dba2881) 99.57%.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2301      +/-   ##
==========================================
- Coverage   99.57%   99.57%   -0.01%     
==========================================
  Files        2807     2807              
  Lines      250379   250379              
  Branches     1139     1140       +1     
==========================================
- Hits       249308   249306       -2     
- Misses       1043     1045       +2     
  Partials       28       28              

see 1 file with indirect coverage changes

@ST-DDT
Copy link
Member

ST-DDT commented Aug 8, 2023

It does 😢 .

node_modules/.pnpm/[email protected]/node_modules/esbuild/lib/main.js:1373:27: ERROR: [plugin: externalize-deps] "vitepress" resolved to an ESM file. ESM file cannot be loaded by require. See http://vitejs.dev/guide/troubleshooting.html#this-package-is-esm-only for more details.

Any suggestions?

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation do NOT merge yet Do not merge this PR into the target branch yet labels Aug 8, 2023
@renovate renovate bot force-pushed the renovate/doc-dependencies branch 5 times, most recently from 588689e to 45bfbfc Compare August 17, 2023 17:42
@renovate renovate bot force-pushed the renovate/doc-dependencies branch 5 times, most recently from 9799281 to 30d73ea Compare August 21, 2023 07:42
@renovate renovate bot force-pushed the renovate/doc-dependencies branch 2 times, most recently from 24e1098 to 680c62f Compare August 25, 2023 21:46
@renovate renovate bot changed the title chore(deps): update dependency vitepress to v1.0.0-rc.4 chore(deps): update doc-dependencies Aug 25, 2023
@renovate renovate bot force-pushed the renovate/doc-dependencies branch 8 times, most recently from 361dd02 to 7968dcd Compare August 27, 2023 09:19
@ST-DDT
Copy link
Member

ST-DDT commented Dec 28, 2023

Should we merge this now instead of waiting for v9?

@Shinigami92
Copy link
Member

Shinigami92 commented Dec 28, 2023

Should we merge this now instead of waiting for v9?

I'm biased, so others should "vote".


👍 = Merge now; 👎 = Wait for v9

@ST-DDT ST-DDT added the p: 1-normal Nothing urgent label Dec 28, 2023
@ST-DDT ST-DDT requested review from a team December 28, 2023 23:22
@ST-DDT
Copy link
Member

ST-DDT commented Dec 28, 2023

I'm biased

Isnt that the whole point/idea behind voting aka expressing your preference for one of the options?!

@Shinigami92
Copy link
Member

Shinigami92 commented Dec 29, 2023

I'm biased

Isnt that the whole point/idea behind voting aka expressing your preference for one of the options?!

yes and no, just because I would like to force something doesn't mean that it is actually good for the community
I might oversee something or do not think about something
and so because we also have other active maintainers it is potentially a good thing to bring them to the table and ask for feedback

or maybe, now I'm reading my quoted post in your answer: I did not wrote "I'm biased" alone 🤔
it was more a "I'm biased -> so lets vote / bring others to the table"

@ST-DDT
Copy link
Member

ST-DDT commented Dec 29, 2023

Anyway, I would like to merge this in the hope that this fixes the issues blocking #2513

@Shinigami92
Copy link
Member

Anyway, I would like to merge this in the hope that this fixes the issues blocking #2513

While working together on #2513 (comment) we now definitely found out that #2301 does not affect the algolia search index in any way.

Anyway, I also would like to get this PR merged to get it from the table :D

@xDivisionByZerox xDivisionByZerox merged commit a87602b into next Dec 29, 2023
21 of 22 checks passed
@xDivisionByZerox xDivisionByZerox deleted the renovate/doc-dependencies branch December 29, 2023 15:50
@xDivisionByZerox
Copy link
Member

Is this PR in the incorrect milestone? Currently it's in v9.0 but was released in v8.4.0. There were no breaking changes, so why was this targeted for v9?

@Shinigami92
Copy link
Member

Is this PR in the incorrect milestone? Currently it's in v9.0 but was released in v8.4.0. There were no breaking changes, so why was this targeted for v9?

GitHub PRs do have a history that can be read

So on #2301 (comment) it was set for v9 or later, I assume due to priority or whatever
Later #2301 (comment) there was a decision to merge now instead of waiting
However, the milestone was not updated after the vote 🤷 things happen

@ST-DDT ST-DDT modified the milestones: v9.0, v8.x Jan 29, 2024
@xDivisionByZerox
Copy link
Member

GitHub PRs do have a history that can be read

Doesn't cost anything to think that in your head and not write it (and with that not look like an asshole) 🤷 thats all I'm gonna say to that!


I did in fact read the history, and was not able to get why things where done, SUre there was a vote, but why was there suddenly the possibility to merge this? This PR was open for 5 months. It even had the "DO NOT MERGE" label after changes were done that removed, what looked like the breaking changes.

Sorry for double checking if we accidently shiped breaking features. Will not happen again.

@Shinigami92
Copy link
Member

You took it way to drastically 🫠

This was only something affecting the docs
As far as I remember, we thought this had something todo with the algolia search index, but in the end it had nothing to do with that
There were many required changes in this PR to not get in conflict with cjs->esm and stuff like that
But it had no breaking changes or any affect to the src code at all

@ST-DDT
Copy link
Member

ST-DDT commented Jan 29, 2024

The main reason why i put this on hold were the cjs/esm issues that I couldnt fix and though were related to us being cjs-ish and vitepress switching to esm. Thus requiring us to switch to esm, thus being slated for v9.0.
See also: #2301 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: dependencies Pull requests that adds/updates a dependency c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants