Skip to content

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Mar 1, 2025

This PR contains the following updates:

Package Type Update Change OpenSSF
fumadocs-docgen (source) dependencies major 1.3.8 -> 2.0.0 OpenSSF Scorecard

Release Notes

fuma-nama/fumadocs (fumadocs-docgen)

v2.0.0

Compare Source

Major Changes
  • 4642a86: Remove typescriptGenerator from fumadocs-docgen

    why: Move dedicated parts to fumadocs-typescript, so all docs generation features for TypeScript can be put together in a single module.

    migrate: Use fumadocs-typescript We made a new remarkAutoTypeTable remark plugin generating the type table but with a different syntax:

    <auto-type-table path="./my-file.ts" name="MyInterface" />

    Instead of:

    ```json doc-gen:typescript
    {
      "file": "./my-file.ts",
      "name": "MyInterface"
    }
    ```
  • 4642a86: Move remarkTypeScriptToJavaScript plugin to fumadocs-docgen/remark-ts2js.

    why: Fix existing problems with oxc-transform.

    migrate:

    Import it like:

    import { remarkTypeScriptToJavaScript } from 'fumadocs-docgen/remark-ts2js';

    instead of importing from fumadocs-docgen.


Configuration

📅 Schedule: Branch creation - "* 0-4,22-23 * * 1-5,* * * * 0,6" (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.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


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

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the dependencies Dependency updates label Mar 1, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented Mar 1, 2025

Reviewer's Guide by Sourcery

This pull request updates the fumadocs-docgen dependency to version 2.0.0. This includes the removal of typescriptGenerator and the relocation of remarkTypeScriptToJavaScript. Users should migrate to fumadocs-typescript and update their import statements accordingly.

Sequence diagram for migrating from typescriptGenerator to remarkAutoTypeTable

sequenceDiagram
    participant User
    participant fumadocs-docgen
    participant fumadocs-typescript

    User->>fumadocs-docgen: Uses typescriptGenerator
    activate fumadocs-docgen
    fumadocs-docgen-->>User: Returns type table
    deactivate fumadocs-docgen

    User->>fumadocs-typescript: Uses remarkAutoTypeTable
    activate fumadocs-typescript
    fumadocs-typescript-->>User: Returns type table
    deactivate fumadocs-typescript
Loading

Updated class diagram for fumadocs-docgen

classDiagram
  class fumadocs-docgen {
    <<removed>>
    - typescriptGenerator
  }
  class fumadocs-docgen {
    <<moved>>
    - remarkTypeScriptToJavaScript
  }
  class fumadocs-typescript {
    + remarkAutoTypeTable
  }
  note for fumadocs-docgen "typescriptGenerator removed, use fumadocs-typescript instead"
  note for fumadocs-docgen "remarkTypeScriptToJavaScript moved to fumadocs-docgen/remark-ts2js"
  note for fumadocs-typescript "remarkAutoTypeTable added"
Loading

File-Level Changes

Change Details Files
The pull request updates the fumadocs-docgen dependency from version 1.3.8 to version 2.0.0.
  • Updated fumadocs-docgen dependency to version 2.0.0.
package.json
The typescriptGenerator has been removed from fumadocs-docgen and users should migrate to fumadocs-typescript.
  • Removed typescriptGenerator from fumadocs-docgen.
  • Users should now use fumadocs-typescript and the remarkAutoTypeTable remark plugin for generating type tables.
The remarkTypeScriptToJavaScript plugin has been moved to fumadocs-docgen/remark-ts2js.
  • Moved remarkTypeScriptToJavaScript plugin to fumadocs-docgen/remark-ts2js.
  • Updated import statements to reflect the new location of the plugin.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We have skipped reviewing this pull request. Here's why:

  • It seems to have been created by a bot (hey, renovate[bot]!). We assume it knows what it's doing!
  • We don't review packaging changes - Let us know if you'd like us to change this.

Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@renovate renovate bot force-pushed the renovate/fumadocs-docgen-2.x branch from 418ecd5 to 0e88d4e Compare March 1, 2025 16:38
@roderik roderik merged commit 3eb0303 into main Mar 2, 2025
2 checks passed
@roderik roderik deleted the renovate/fumadocs-docgen-2.x branch March 2, 2025 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Dependency updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants