Skip to content

Comments

chore: remove typedoc dependency and cleanup unused documentation generation#6686

Merged
graphite-app[bot] merged 1 commit intomainfrom
copilot/remove-typedoc-dependency-again
Oct 26, 2025
Merged

chore: remove typedoc dependency and cleanup unused documentation generation#6686
graphite-app[bot] merged 1 commit intomainfrom
copilot/remove-typedoc-dependency-again

Conversation

Copy link
Contributor

Copilot AI commented Oct 24, 2025

Overview

This PR removes the typedoc dependency and all related files from the repository. The documentation is now written manually and no longer relies on automatic type extraction from TypeScript source files.

Background

Previously, Rolldown used TypeDoc to automatically extract type information from TypeScript files and generate API documentation. This involved:

  • Running typedoc to generate options-doc.json from TypeScript source files
  • A VitePress data loader (docs/data-loading/options-doc.data.ts) that processed this JSON to render documentation
  • The extract-options-doc npm script to trigger the generation

Since the documentation is now maintained manually, all of this infrastructure is no longer needed.

Changes

Removed Files

  • packages/rolldown/typedoc.json - TypeDoc configuration file
  • docs/data-loading/options-doc.data.ts - VitePress data loader that consumed typedoc output

Removed Dependencies

  • typedoc from packages/rolldown/package.json devDependencies
  • typedoc from pnpm-workspace.yaml catalog
  • zx from docs/package.json (was only used by the removed data loader)

Removed Scripts

  • extract-options-doc script from packages/rolldown/package.json

Updated Configuration

  • Removed options-doc.json entry from packages/rolldown/.gitignore
  • Updated pnpm-lock.yaml to reflect dependency changes

Impact

  • No functional changes to the bundler or its APIs
  • No changes to the existing manual documentation
  • Cleaner dependency tree with fewer unused packages
  • Reduced maintenance overhead from automated doc generation that was no longer in use

Total changes: 7 files changed, 1 insertion(+), 237 deletions(-)

Original prompt

Rolldown repo used to use typedoc to extract types and generate doc automatically. We now write documentation manually and don't rely on this behavior anymore. Clean up everything related to it. Lile remove typedoc dependency. Unused json data.

Run just lint for the final verification.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@graphite-app
Copy link
Contributor

graphite-app bot commented Oct 24, 2025

How to use the Graphite Merge Queue

Add the label graphite: merge to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

@netlify
Copy link

netlify bot commented Oct 24, 2025

Deploy Preview for rolldown-rs ready!

Name Link
🔨 Latest commit d46ee80
🔍 Latest deploy log https://app.netlify.com/projects/rolldown-rs/deploys/68fdb4ffda366800088b9cfc
😎 Deploy Preview https://deploy-preview-6686--rolldown-rs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI changed the title [WIP] Remove typedoc and clean up related documentation Remove typedoc dependency and cleanup unused documentation generation Oct 24, 2025
Copilot AI requested a review from hyf0 October 24, 2025 09:03
@hyf0 hyf0 changed the title Remove typedoc dependency and cleanup unused documentation generation chore: remove typedoc dependency and cleanup unused documentation generation Oct 24, 2025
@hyf0 hyf0 marked this pull request as ready for review October 24, 2025 10:24
@hyf0 hyf0 force-pushed the copilot/remove-typedoc-dependency-again branch from eab2189 to 40a4e21 Compare October 24, 2025 10:24
@hyf0 hyf0 force-pushed the copilot/remove-typedoc-dependency-again branch from 40a4e21 to a7ff70e Compare October 25, 2025 10:13
@socket-security
Copy link

socket-security bot commented Oct 25, 2025

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addedtinyexec@​1.0.19910010080100

View full report

@hyf0 hyf0 requested a review from IWANABETHATGUY October 25, 2025 18:51
Copy link
Member

shulaoda commented Oct 26, 2025

Merge activity

graphite-app bot pushed a commit that referenced this pull request Oct 26, 2025
…eneration (#6686)

## Overview

This PR removes the `typedoc` dependency and all related files from the repository. The documentation is now written manually and no longer relies on automatic type extraction from TypeScript source files.

## Background

Previously, Rolldown used TypeDoc to automatically extract type information from TypeScript files and generate API documentation. This involved:
- Running `typedoc` to generate `options-doc.json` from TypeScript source files
- A VitePress data loader (`docs/data-loading/options-doc.data.ts`) that processed this JSON to render documentation
- The `extract-options-doc` npm script to trigger the generation

Since the documentation is now maintained manually, all of this infrastructure is no longer needed.

## Changes

### Removed Files
- **`packages/rolldown/typedoc.json`** - TypeDoc configuration file
- **`docs/data-loading/options-doc.data.ts`** - VitePress data loader that consumed typedoc output

### Removed Dependencies
- **`typedoc`** from `packages/rolldown/package.json` devDependencies
- **`typedoc`** from `pnpm-workspace.yaml` catalog
- **`zx`** from `docs/package.json` (was only used by the removed data loader)

### Removed Scripts
- **`extract-options-doc`** script from `packages/rolldown/package.json`

### Updated Configuration
- Removed `options-doc.json` entry from `packages/rolldown/.gitignore`
- Updated `pnpm-lock.yaml` to reflect dependency changes

## Impact

- **No functional changes** to the bundler or its APIs
- **No changes** to the existing manual documentation
- Cleaner dependency tree with fewer unused packages
- Reduced maintenance overhead from automated doc generation that was no longer in use

Total changes: 7 files changed, 1 insertion(+), 237 deletions(-)

<!-- START COPILOT CODING AGENT SUFFIX -->

<details>

<summary>Original prompt</summary>

> Rolldown repo used to use typedoc to extract types and generate doc automatically. We now write documentation manually and don't rely on this behavior anymore. Clean up everything related to it. Lile remove typedoc dependency. Unused json data.
>
> Run `just lint` for the final verification.

</details>

<!-- START COPILOT CODING AGENT TIPS -->
---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey).
@graphite-app graphite-app bot force-pushed the copilot/remove-typedoc-dependency-again branch from a7ff70e to 99d3d93 Compare October 26, 2025 05:41
…eneration (#6686)

## Overview

This PR removes the `typedoc` dependency and all related files from the repository. The documentation is now written manually and no longer relies on automatic type extraction from TypeScript source files.

## Background

Previously, Rolldown used TypeDoc to automatically extract type information from TypeScript files and generate API documentation. This involved:
- Running `typedoc` to generate `options-doc.json` from TypeScript source files
- A VitePress data loader (`docs/data-loading/options-doc.data.ts`) that processed this JSON to render documentation
- The `extract-options-doc` npm script to trigger the generation

Since the documentation is now maintained manually, all of this infrastructure is no longer needed.

## Changes

### Removed Files
- **`packages/rolldown/typedoc.json`** - TypeDoc configuration file
- **`docs/data-loading/options-doc.data.ts`** - VitePress data loader that consumed typedoc output

### Removed Dependencies
- **`typedoc`** from `packages/rolldown/package.json` devDependencies
- **`typedoc`** from `pnpm-workspace.yaml` catalog
- **`zx`** from `docs/package.json` (was only used by the removed data loader)

### Removed Scripts
- **`extract-options-doc`** script from `packages/rolldown/package.json`

### Updated Configuration
- Removed `options-doc.json` entry from `packages/rolldown/.gitignore`
- Updated `pnpm-lock.yaml` to reflect dependency changes

## Impact

- **No functional changes** to the bundler or its APIs
- **No changes** to the existing manual documentation
- Cleaner dependency tree with fewer unused packages
- Reduced maintenance overhead from automated doc generation that was no longer in use

Total changes: 7 files changed, 1 insertion(+), 237 deletions(-)

<!-- START COPILOT CODING AGENT SUFFIX -->

<details>

<summary>Original prompt</summary>

> Rolldown repo used to use typedoc to extract types and generate doc automatically. We now write documentation manually and don't rely on this behavior anymore. Clean up everything related to it. Lile remove typedoc dependency. Unused json data.
>
> Run `just lint` for the final verification.

</details>

<!-- START COPILOT CODING AGENT TIPS -->
---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey).
@graphite-app graphite-app bot force-pushed the copilot/remove-typedoc-dependency-again branch from 99d3d93 to d46ee80 Compare October 26, 2025 05:43
@graphite-app graphite-app bot merged commit d46ee80 into main Oct 26, 2025
25 checks passed
@graphite-app graphite-app bot deleted the copilot/remove-typedoc-dependency-again branch October 26, 2025 06:00
IWANABETHATGUY pushed a commit that referenced this pull request Oct 27, 2025
…eneration (#6686)

## Overview

This PR removes the `typedoc` dependency and all related files from the repository. The documentation is now written manually and no longer relies on automatic type extraction from TypeScript source files.

## Background

Previously, Rolldown used TypeDoc to automatically extract type information from TypeScript files and generate API documentation. This involved:
- Running `typedoc` to generate `options-doc.json` from TypeScript source files
- A VitePress data loader (`docs/data-loading/options-doc.data.ts`) that processed this JSON to render documentation
- The `extract-options-doc` npm script to trigger the generation

Since the documentation is now maintained manually, all of this infrastructure is no longer needed.

## Changes

### Removed Files
- **`packages/rolldown/typedoc.json`** - TypeDoc configuration file
- **`docs/data-loading/options-doc.data.ts`** - VitePress data loader that consumed typedoc output

### Removed Dependencies
- **`typedoc`** from `packages/rolldown/package.json` devDependencies
- **`typedoc`** from `pnpm-workspace.yaml` catalog
- **`zx`** from `docs/package.json` (was only used by the removed data loader)

### Removed Scripts
- **`extract-options-doc`** script from `packages/rolldown/package.json`

### Updated Configuration
- Removed `options-doc.json` entry from `packages/rolldown/.gitignore`
- Updated `pnpm-lock.yaml` to reflect dependency changes

## Impact

- **No functional changes** to the bundler or its APIs
- **No changes** to the existing manual documentation
- Cleaner dependency tree with fewer unused packages
- Reduced maintenance overhead from automated doc generation that was no longer in use

Total changes: 7 files changed, 1 insertion(+), 237 deletions(-)

<!-- START COPILOT CODING AGENT SUFFIX -->

<details>

<summary>Original prompt</summary>

> Rolldown repo used to use typedoc to extract types and generate doc automatically. We now write documentation manually and don't rely on this behavior anymore. Clean up everything related to it. Lile remove typedoc dependency. Unused json data.
>
> Run `just lint` for the final verification.

</details>

<!-- START COPILOT CODING AGENT TIPS -->
---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey).
shulaoda added a commit that referenced this pull request Oct 27, 2025
## [1.0.0-beta.45] - 2025-10-27

### 🚀 Features

- plugin/vite-resolve: add `legacyInconsistentCjsInterop` option (#6687) by @sapphi-red
- rolldown_plugin_vite_css_post: initialize `CSSStyles` (#6691) by @shulaoda
- rolldown_plugin_manifest: align with `vitejs/vite#20585` (#6684) by @shulaoda
- enabling mangle private class members (#6679) by @IWANABETHATGUY
- rolldown_resolver: auto tsconfig discovery (#6602) by @Boshen
- support named imports + CJS by optimization.inlineConst (#6644) by @IWANABETHATGUY

### 🐛 Bug Fixes

- rolldown_binding: use Record instead of Map (#6715) by @shulaoda
- validate valibot schema against existing type (#6703) by @ocavue
- rolldown_plugin_vite_css_post: align some logic (#6697) by @shulaoda
- node/options: should validate `transform.jsx` correctly (#6698) by @ocavue
- inherit runtime helpers from eliminated dependencies (#6689) by @IWANABETHATGUY
- clean-dir: advance clean outdir to allow `generateBundle` outputs (#6647) by @aprosail
- rename variable to better reflect its purpose and fix CJS imports (#6663) by @IWANABETHATGUY
- bailout tree shake commonjs export when it is defined multiple time (#6659) by @IWANABETHATGUY
- rolldown_plugin_reporter: color dimmed text correctly (#6649) by @sapphi-red
- don't inline json module when used as a namespace reference (#6652) by @IWANABETHATGUY
- avoid `define` deprecation warning when loading a config file (#6641) by @sapphi-red

### 💼 Other

- pluginutils: switch to tsc to solve the issue of loading conflicting binary (#6708) by @hyf0

### 🚜 Refactor

- node: only call `transformToRollupOutput` when needed (#6695) by @hyf0
- node: split `transformToRollupOutput` into mutable and immutable versions (#6693) by @hyf0
- remove unnecessaey lazy data passing for `BindingOutputs` (#6692) by @hyf0
- rolldown_plugin_utils: tweak `CSSEntriesCache` (#6685) by @shulaoda
- rolldown_binding: use unified `BindingRenderBuiltUrl` (#6653) by @shulaoda

### 📚 Documentation

- in-depth about `experimental.nativeMagicString` (#6713) by @IWANABETHATGUY
- polish `optimization` (#6719) by @IWANABETHATGUY
- clarify `output.cleanDir` timing behavior for plugin compatibility (#6682) by @Copilot
- add Kevin Deng, 翠 (sapphi-red), and Alexander Lichter to team page with Bluesky links (#6664) by @Copilot
- polish `preserveEntrySignature` doc (#6661) by @IWANABETHATGUY
- set up redirects via netlify (#6654) by @TheAlexLichter
- polish doc about `treeshake` (#6650) by @IWANABETHATGUY
- rework options documentation first round (#6542) by @hyf0

### ⚡ Performance

- rolldown: upgrade sugar_path (#6646) by @Brooooooklyn

### 🧪 Testing

- add live bindings test for default export snapshot semantics (#6538) by @Copilot

### ⚙️ Miscellaneous Tasks

- deps: lock file maintenance npm packages (#6714) by @renovate[bot]
- deps: update github-actions (#6710) by @renovate[bot]
- deps: update dependency @vueuse/core to v14 (#6711) by @renovate[bot]
- deps: update github-actions (major) (#6712) by @renovate[bot]
- deps: update dependency tsdown to v0.15.10 (#6706) by @renovate[bot]
- remove `typedoc` dependency and cleanup unused documentation generation (#6686) by @Copilot
- deps: update dependency rolldown-plugin-dts to v0.17.1 (#6690) by @renovate[bot]
- lint: `oxlint --type-aware` (#5660) by @Boshen
- rolldown: update napi and js binding (#6676) by @Brooooooklyn
- deps: update vitest to v4 (#6673) by @sapphi-red
- test: support `DevTestMeta#dev` (#6672) by @hyf0
- deps: update dependency rolldown-plugin-dts to ^0.17.0 (#6671) by @renovate[bot]
- test: move dev related options to rolldown_dev_common (#6667) by @hyf0
- test: add `DevTestMeta` under `TestMeta#dev` to control dev related behaviors (#6666) by @hyf0
- deps: update dependency vite to v7.1.11 [security] (#6645) by @renovate[bot]
- pluginutils: use rolldown to build plugutils (#6642) by @Brooooooklyn
- deps: update dependency tsdown to v0.15.9 (#6643) by @renovate[bot]

### ❤️ New Contributors

* @ocavue made their first contribution in [#6703](#6703)

Co-authored-by: shulaoda <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants