Skip to content

deps: bump typedoc-plugin-markdown to 4.14.1 and synchronize workspace lockfile - #2343

Merged
bradygaster merged 5 commits into
devfrom
dependabot/npm_and_yarn/packages/squad-sdk/typedoc-plugin-markdown-4.14.1
Nov 9, 2026
Merged

bradygaster merged 5 commits into
devfrom
dependabot/npm_and_yarn/packages/squad-sdk/typedoc-plugin-markdown-4.14.1

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Bumps typedoc-plugin-markdown from 4.13.1 to 4.14.1.

Release notes

Sourced from typedoc-plugin-markdown's releases.

typedoc-plugin-markdown@4.14.1

Patch Changes

  • Render constructor types with their new and abstract keywords instead of as function types (#940).
  • Parenthesise function, constructor, union and conditional types inside intersections, so A & (() => void) is no longer rendered as A & () => void (#940).
  • With useCodeBlocks, mark optional members with ? instead of an optional keyword, which is not valid TypeScript.
  • With useCodeBlocks, quote property and method names that are not identifiers, so "prop.with.dot": string is no longer rendered as prop.with.dot: string.
  • With useCodeBlocks, render "Overrides", "Implementation of" and "Inherited from" references to external members as inline code instead of code blocks, on one line.

typedoc-plugin-markdown@4.14.0

Minor Changes

This release is a sweep of rendering fixes checked against TypeDoc's own output. Most of them change the generated markdown, so expect diffs when docs are regenerated. No option or public type changes.

  • Render methods inside object types with their call signatures, every overload and their comments, instead of only the first overload's return type. This applies to expanded objects (expandObjects), properties tables, parameter tables and lists, and type declaration tables, where nested methods also keep their path prefix (inner.fn()) (#908).
  • Render anchors for type parameters, including those of methods, so links to them resolve. They are slugged from the type parameter's name, prefixed with type-parameter- when parametersFormat is a table so they no longer shift member anchors, and omitted when parametersFormat is none (#909).
  • Fire the page.begin, page.end, content.begin and content.end hooks on the readme page and on document pages, which previously fired no hooks, so content injected through them (such as front matter) now appears there too. The index.page.begin and index.page.end hooks still fire on the project page as before.
  • Change the structure of several page sections: named tuple members are rendered with their names and optional markers ([first: string, second?: number]); each parent under "Extends" is its own item instead of being joined with .; the object members of an intersection sit under a single "Type Declaration" heading after the type parameters; and each document group lists only its own documents.
  • Remove #, ? and \ from generated file names, so links to pages such as a document titled FAQ: What's new? [#1](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/issues/1) resolve, and keep names made only of underscores, so export function _() is written to functions/_.md instead of an empty file name.

Patch Changes

  • Apply anchorPrefix to links that point to another page, and only once with the kind-dir and structure-dir routers, and link constructors to their localised heading (e.g. #konstruktor) when lang is not English.
  • Keep literal values verbatim in code blocks (useCodeBlocks) and escape backslashes in text outside code, so '[a](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/blob/HEAD/b)', '&lt;b&gt;' and 'C:\\temp' display as written instead of as "a", "<b>" and C:\temp.
  • List a class under every hierarchy root it extends or implements on the hierarchy summary page, instead of only the first.
  • Encode relative media links, so a linked file with spaces in its name still resolves.
  • Match entryModule against modules only, so a function or class sharing the module's name keeps its page, find the entry module when project documents are present, and write the readme page once with the core routers and mergeReadme instead of a second page at the same URL.
  • Render the return type of a signature when it is an array or intersection of documented object types or an @expand type, instead of an empty "Returns" section, and render parameters and return types that reference an @expand type as the type instead of listing union members separately.
  • Wrap function, intersection, conditional and type operator types in parentheses when they are array elements or optional tuple elements, e.g. (() => void)[] instead of () => void[].
  • Strike through deprecated nested members in properties and type declaration tables, as list format already does.
  • Mark a parameter as optional (a?) in tables when it has a default value, as the signature title and list format already do, and only by its own flag for members of an object parameter instead of every row after the first optional one. Show the default value of a union-typed parameter and the type of an object parameter with no members to list (such as an index signature alone) in list format, and show an elided property default as ... in properties tables instead of undefined.
  • Keep pages inside the output directory when a module or document name contains parent directory segments.
  • Escape | in table cells (including inside code spans, as GFM tables require) so it no longer splits a row into extra columns. The rendered text still shows a plain |.
  • Show every modifier of a property (e.g. protected static readonly), not only the first one found.
Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.14.1 (2026-10-19)

Patch Changes

  • Render constructor types with their new and abstract keywords instead of as function types (#940).
  • Parenthesise function, constructor, union and conditional types inside intersections, so A & (() => void) is no longer rendered as A & () => void (#940).
  • With useCodeBlocks, mark optional members with ? instead of an optional keyword, which is not valid TypeScript.
  • With useCodeBlocks, quote property and method names that are not identifiers, so "prop.with.dot": string is no longer rendered as prop.with.dot: string.
  • With useCodeBlocks, render "Overrides", "Implementation of" and "Inherited from" references to external members as inline code instead of code blocks, on one line.

4.14.0 (2026-10-13)

Minor Changes

This release is a sweep of rendering fixes checked against TypeDoc's own output. Most of them change the generated markdown, so expect diffs when docs are regenerated. No option or public type changes.

  • Render methods inside object types with their call signatures, every overload and their comments, instead of only the first overload's return type. This applies to expanded objects (expandObjects), properties tables, parameter tables and lists, and type declaration tables, where nested methods also keep their path prefix (inner.fn()) (#908).
  • Render anchors for type parameters, including those of methods, so links to them resolve. They are slugged from the type parameter's name, prefixed with type-parameter- when parametersFormat is a table so they no longer shift member anchors, and omitted when parametersFormat is none (#909).
  • Fire the page.begin, page.end, content.begin and content.end hooks on the readme page and on document pages, which previously fired no hooks, so content injected through them (such as front matter) now appears there too. The index.page.begin and index.page.end hooks still fire on the project page as before.
  • Change the structure of several page sections: named tuple members are rendered with their names and optional markers ([first: string, second?: number]); each parent under "Extends" is its own item instead of being joined with .; the object members of an intersection sit under a single "Type Declaration" heading after the type parameters; and each document group lists only its own documents.
  • Remove #, ? and \ from generated file names, so links to pages such as a document titled FAQ: What's new? [#1](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown/issues/1) resolve, and keep names made only of underscores, so export function _() is written to functions/_.md instead of an empty file name.

Patch Changes

  • Apply anchorPrefix to links that point to another page, and only once with the kind-dir and structure-dir routers, and link constructors to their localised heading (e.g. #konstruktor) when lang is not English.
  • Keep literal values verbatim in code blocks (useCodeBlocks) and escape backslashes in text outside code, so '[a](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/b)', '&lt;b&gt;' and 'C:\\temp' display as written instead of as "a", "<b>" and C:\temp.
  • List a class under every hierarchy root it extends or implements on the hierarchy summary page, instead of only the first.
  • Encode relative media links, so a linked file with spaces in its name still resolves.
  • Match entryModule against modules only, so a function or class sharing the module's name keeps its page, find the entry module when project documents are present, and write the readme page once with the core routers and mergeReadme instead of a second page at the same URL.
  • Render the return type of a signature when it is an array or intersection of documented object types or an @expand type, instead of an empty "Returns" section, and render parameters and return types that reference an @expand type as the type instead of listing union members separately.
  • Wrap function, intersection, conditional and type operator types in parentheses when they are array elements or optional tuple elements, e.g. (() => void)[] instead of () => void[].
  • Strike through deprecated nested members in properties and type declaration tables, as list format already does.
  • Mark a parameter as optional (a?) in tables when it has a default value, as the signature title and list format already do, and only by its own flag for members of an object parameter instead of every row after the first optional one. Show the default value of a union-typed parameter and the type of an object parameter with no members to list (such as an index signature alone) in list format, and show an elided property default as ... in properties tables instead of undefined.
  • Keep pages inside the output directory when a module or document name contains parent directory segments.
  • Escape | in table cells (including inside code spans, as GFM tables require) so it no longer splits a row into extra columns. The rendered text still shows a plain |.
  • Show every modifier of a property (e.g. protected static readonly), not only the first one found.
Commits
  • bc9bce5 Version Packages
  • 054a927 fix(core): render inheritance references to external members as inline code
  • 6b1f385 test(core): check that ts code blocks in fixture output are valid TypeScript
  • 1242c67 test(core): build HTML output for the utils fixtures
  • bd860c4 fix(core): render optional and non-identifier member names as valid TypeScrip...
  • a167dd0 fix(core): render constructor and function types in intersections as valid Ty...
  • 2fcdba6 chore(release): date and sync changelogs
  • 2fce902 Version Packages
  • 2c91a37 fix(core): keep pages inside the output directory and insert names containing...
  • 5e456ba refactor(core): share the anchor title logic between member and type paramete...
  • Additional commits viewable in compare view

@dependabot dependabot Bot added the dependencies Pull requests that update a dependency file label Oct 26, 2026
@dependabot
dependabot Bot force-pushed the dependabot/npm_and_yarn/packages/squad-sdk/typedoc-plugin-markdown-4.14.1 branch 2 times, most recently from 0660cbd to ff471d4 Compare October 30, 2026 12:48

Copy link
Copy Markdown
Collaborator

@dependabot rebase

@dependabot
dependabot Bot force-pushed the dependabot/npm_and_yarn/packages/squad-sdk/typedoc-plugin-markdown-4.14.1 branch from ff471d4 to 62a0397 Compare November 8, 2026 11:08
Copilot AI auto review requested due to automatic review settings November 8, 2026 11:08

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The committed root lockfile is out of sync with the SDK’s updated Typedoc dependency, causing the release workflow’s clean npm ci to fail before the SDK can be built.

1 open issue
What changed in this PR

This pull request updates the SDK’s typedoc-plugin-markdown development dependency from ~4.13.1 to ~4.14.1, bringing documentation rendering fixes and improvements.

Changes:

  • Bumps typedoc-plugin-markdown in the SDK package manifest.
  • The root package-lock.json still references 4.13.1 and must be regenerated for reproducible installs and successful npm ci verification.

This pull request requires changes.

File Summary
packages/​squad-sdk/​package.json Updates the typedoc-plugin-markdown version constraint to ~4.14.1.

Review effort: Lite (auto)

Comment thread packages/squad-sdk/package.json Resolved
Bumps [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown) from 4.13.1 to 4.14.1.
- [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/typedoc-plugin-markdown@4.14.1/packages/typedoc-plugin-markdown)

---
updated-dependencies:
- dependency-name: typedoc-plugin-markdown
  dependency-version: 4.14.1
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
dependabot Bot force-pushed the dependabot/npm_and_yarn/packages/squad-sdk/typedoc-plugin-markdown-4.14.1 branch from 62a0397 to 8798e11 Compare November 8, 2026 18:44
Part of #2343

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: c8c234f1-ee3b-49e1-9406-11d4a2238c23
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

🟡 Impact Analysis — PR #2343

Risk tier: 🟡 MEDIUM

📊 Summary

Metric Count
Files changed 2
Files added 0
Files modified 2
Files deleted 0
Modules touched 2
Critical files 1

🎯 Risk Factors

  • 2 files changed (≤5 → LOW)
  • 2 modules touched (2-4 → MEDIUM)
  • Critical files touched: packages/squad-sdk/package.json

📦 Modules Affected

root (1 file)
  • package-lock.json
squad-sdk (1 file)
  • packages/squad-sdk/package.json

⚠️ Critical Files

  • packages/squad-sdk/package.json

This report is generated automatically for every PR. See #733 for details.

@github-actions

github-actions Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

🔒 Security Review

Authoritative evidence: scanners from the PR base commit, posted by the default-branch workflow_run reporter.
Results for head commit 0649bb747011397d1a92cab17f491aa8e4b58f5b.

🔒 Security review: 1 info.

Severity Category Finding Location
ℹ️ info new-dependency 1 new/changed dependency version(s) in packages/squad-sdk/package.json. Verify these packages are trusted and necessary. packages/squad-sdk/package.json:273

Automated security review — informational only.

@github-actions

github-actions Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

🛫 PR Readiness Check

ℹ️ This comment updates on each push. Last checked: commit 0649bb7

PR Scope: 🔧 Infrastructure

⚠️ 3 item(s) to address before review

Status Check Details
❌ Single commit 5 commits — consider squashing before review
✅ Not in draft Ready for review
✅ Branch up to date Up to date with dev
❌ Copilot review No Copilot review yet — it may still be processing
✅ Changeset present No source files changed — changeset not required
✅ Scope clean No .squad/ or docs/proposals/ files
✅ No merge conflicts No merge conflicts
✅ Copilot threads resolved All 1 Copilot thread(s) resolved
❌ CI passing 1 check(s) still running

Files Changed (2 files, +5 −6)

File +/−
package-lock.json +4 −5
packages/squad-sdk/package.json +1 −1

Total: +5 −6


This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.

@bradygaster bradygaster changed the title deps: bump typedoc-plugin-markdown from 4.13.1 to 4.14.1 in /packages/squad-sdk deps: bump typedoc-plugin-markdown to 4.14.1 and synchronize workspace lockfile Nov 9, 2026
@bradygaster
bradygaster merged commit 6ee8f1b into dev Nov 9, 2026
31 checks passed
@dependabot
dependabot Bot deleted the dependabot/npm_and_yarn/packages/squad-sdk/typedoc-plugin-markdown-4.14.1 branch November 9, 2026 17:34
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