Skip to content

Comments

chore: add JSDoc documentation for memfs type#7587

Merged
graphite-app[bot] merged 1 commit intomainfrom
copilot/fix-issue-7515
Dec 19, 2025
Merged

chore: add JSDoc documentation for memfs type#7587
graphite-app[bot] merged 1 commit intomainfrom
copilot/fix-issue-7515

Conversation

Copy link
Contributor

Copilot AI commented Dec 19, 2025

Adds JSDoc documentation for the memfs export from rolldown/experimental to help users understand the in-memory filesystem API for browser builds.

Changes

  • Added comprehensive JSDoc to memfs in experimental-index.ts:
    • Description of fs (Node.js-compatible filesystem API) and volume (underlying Volume instance)
    • Note that it returns undefined in Node.js builds
    • Link to upstream memfs library

Example

import { memfs } from 'rolldown/experimental';

// Write files to virtual filesystem before bundling
memfs?.volume.fromJSON({
  '/src/index.js': 'export const foo = 42;',
  '/package.json': '{"name": "my-app"}'
});

// Read files from the virtual filesystem
const content = memfs?.fs.readFileSync('/src/index.js', 'utf8');
Original prompt

Solve #7515


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

@netlify
Copy link

netlify bot commented Dec 19, 2025

Deploy Preview for rolldown-rs ready!

Name Link
🔨 Latest commit 52ed0ae
🔍 Latest deploy log https://app.netlify.com/projects/rolldown-rs/deploys/6944d78f62fb7100080a85c2
😎 Deploy Preview https://deploy-preview-7587--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] Fix issue with data processing in Rolldown docs: add JSDoc documentation for memfs type Dec 19, 2025
Copilot AI requested a review from hyf0 December 19, 2025 04:12
@hyf0 hyf0 marked this pull request as ready for review December 19, 2025 04:28
Copy link
Member

hyf0 commented Dec 19, 2025

Merge activity

@hyf0 hyf0 changed the title docs: add JSDoc documentation for memfs type chore: add JSDoc documentation for memfs type Dec 19, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive JSDoc documentation for the memfs export from rolldown/experimental, helping users understand how to use the in-memory filesystem API in browser builds.

  • Adds detailed JSDoc comments explaining the memfs object structure (fs and volume properties)
  • Documents that memfs returns undefined in Node.js builds and is only available in browser builds
  • Includes working example code showing how to write and read files from the virtual filesystem

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@hyf0 hyf0 unassigned hyf0 and Copilot Dec 19, 2025
graphite-app bot pushed a commit that referenced this pull request Dec 19, 2025
Adds JSDoc documentation for the `memfs` export from `rolldown/experimental` to help users understand the in-memory filesystem API for browser builds.

### Changes
- Added comprehensive JSDoc to `memfs` in `experimental-index.ts`:
  - Description of `fs` (Node.js-compatible filesystem API) and `volume` (underlying Volume instance)
  - Note that it returns `undefined` in Node.js builds
  - Link to upstream [memfs](https://github.com/streamich/memfs) library

### Example
```typescript
import { memfs } from 'rolldown/experimental';

// Write files to virtual filesystem before bundling
memfs?.volume.fromJSON({
  '/src/index.js': 'export const foo = 42;',
  '/package.json': '{"name": "my-app"}'
});

// Read files from the virtual filesystem
const content = memfs?.fs.readFileSync('/src/index.js', 'utf8');
```

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

<!-- START COPILOT ORIGINAL PROMPT -->

<details>

<summary>Original prompt</summary>

> Solve #7515

</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/fix-issue-7515 branch from f26ea17 to 7220b20 Compare December 19, 2025 04:40
Adds JSDoc documentation for the `memfs` export from `rolldown/experimental` to help users understand the in-memory filesystem API for browser builds.

### Changes
- Added comprehensive JSDoc to `memfs` in `experimental-index.ts`:
  - Description of `fs` (Node.js-compatible filesystem API) and `volume` (underlying Volume instance)
  - Note that it returns `undefined` in Node.js builds
  - Link to upstream [memfs](https://github.com/streamich/memfs) library

### Example
```typescript
import { memfs } from 'rolldown/experimental';

// Write files to virtual filesystem before bundling
memfs?.volume.fromJSON({
  '/src/index.js': 'export const foo = 42;',
  '/package.json': '{"name": "my-app"}'
});

// Read files from the virtual filesystem
const content = memfs?.fs.readFileSync('/src/index.js', 'utf8');
```

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

<!-- START COPILOT ORIGINAL PROMPT -->

<details>

<summary>Original prompt</summary>

> Solve #7515

</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/fix-issue-7515 branch from 7220b20 to 52ed0ae Compare December 19, 2025 04:41
@graphite-app graphite-app bot merged commit 52ed0ae into main Dec 19, 2025
31 checks passed
@graphite-app graphite-app bot deleted the copilot/fix-issue-7515 branch December 19, 2025 04:51
@sapphi-red sapphi-red mentioned this pull request Dec 20, 2025
shulaoda added a commit that referenced this pull request Dec 22, 2025
## [1.0.0-beta.56] - 2025-12-22

### 💥 BREAKING CHANGES

- rename `MIXED_EXPORT` error to `MIXED_EXPORTS` (#7565) by @sapphi-red

### 🚀 Features

- rename `id` property to `exporter` in CIRCULAR_REEXPORT error (#7592) by @sapphi-red
- add `ids` property to `CIRCULAR_DEPENDENCY` error (#7591) by @sapphi-red
- node/dev: expose `devMode.lazy` (#7549) by @hyf0
- set log and pos properties for `parseAst` function errors (#7568) by @sapphi-red
- set log and pos properties for logs (#7567) by @sapphi-red
- test-dev-sever: support to manually configure port, run tests in concurrent (#7576) by @hyf0
- add `exporter` property to `MISSING_EXPORT` error (#7564) by @sapphi-red
- add `id` property to `PARSE_ERROR` error (#7563) by @sapphi-red
- support ImporterId hook filter (#7540) by @IWANABETHATGUY

### 🐛 Bug Fixes

- types: better "go to definition" experience for interface `OutputPlugin` (#7610) by @KazariEX
- `postBanner` content should be placed after shebang (#7583) by @btea
- use sanitized filename for preserve modules chunk name (#7603) by @IWANABETHATGUY
- correct filter out unused cjs namespace  (#7602) by @IWANABETHATGUY
- watch: property respect `notify.pollInternal` and `notify.compareContents` (#7595) by @sapphi-red
- make `cleanDir` work with default output directory (#7579) by @shulaoda
- merge `MISSING_NAME_OPTION_FOR_UMD_EXPORT` error to `MISSING_NAME_OPTION_FOR_IIFE_EXPORT` error (#7566) by @sapphi-red
- dev/hmr: ensure cjs modules with no exports reference correct `module` identifier (#7544) by @leegeunhyeok

### 🚜 Refactor

- remove `stable_id` field from `PARSE_ERROR` error (#7593) by @sapphi-red
- make include_runtime_symbol reuseable after linking stage (#7580) by @IWANABETHATGUY
- rust/dev: construct the bundler within itself (#7553) by @hyf0
- rust/watcher: polish API of `Watcher` struct (#7551) by @hyf0
- use `LinkingMetadata::stmt_info_included` to check if a stmt_info is included (#7572) by @IWANABETHATGUY
- use `LinkingMetadata::is_included` to check if a module is included (#7571) by @IWANABETHATGUY
- store module and stmt_info is included info to module meta (#7570) by @IWANABETHATGUY
- make include_* method reunsable after linking stage (#7552) by @IWANABETHATGUY
- rust/watcher: construct the bundler within watcher itself (#7550) by @hyf0
- extract make include_runtime_symbol reusable (#7546) by @IWANABETHATGUY

### ⚙️ Miscellaneous Tasks

- renovate: add `kill-port` in `ignoreDeps` in renovate.json (#7619) by @sapphi-red
- deps: update rust crates (#7617) by @renovate[bot]
- deps: update npm packages (#7616) by @renovate[bot]
- deps: update github-actions (#7615) by @renovate[bot]
- ci: skip benchmark workflows on draft PRs (#7611) by @Copilot
- deps: update dependency rolldown-plugin-dts to ^0.19.0 (#7607) by @renovate[bot]
- deps: update dependency oxlint-tsgolint to v0.10.0 (#7601) by @renovate[bot]
- deps: update dependency rolldown-plugin-dts to v0.18.4 (#7599) by @renovate[bot]
- deps: update notify (#7594) by @sapphi-red
- test-dev-server: add retry mechanism to hmr-full-bundle-mode tests (#7588) by @Copilot
- deps: update napi to v3.7.1 (#7590) by @renovate[bot]
- add JSDoc documentation for memfs type (#7587) by @Copilot
- deps: update dependency oxlint to v1.34.0 (#7589) by @renovate[bot]
- move some tests in ignored-by-unsupported-features that are passing (#7569) by @sapphi-red
- deps: update dependency oxlint-tsgolint to v0.9.2 (#7582) by @renovate[bot]
- deps: update oxc resolver to v11.16.0 (#7574) by @renovate[bot]
- test/dev-server: don't run `pnpm install` during tests (#7560) by @hyf0
- test/dev-server: use `kill-port@1` to improve performance (#7575) by @hyf0
- normalize error object to make some Rollup tests pass (#7562) by @sapphi-red
- ci: separate dev-server(hmr) tests and normal tests (#7558) by @hyf0
- ci: make native rolldown build reusable (#7557) by @hyf0
- resolve some TODOs (#7561) by @sapphi-red

### ❤️ New Contributors

* @KazariEX made their first contribution in [#7610](#7610)
* @leegeunhyeok made their first contribution in [#7544](#7544)

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.

2 participants