Skip to content

Add a way to add description to virtual modules #171

@sapphi-red

Description

@sapphi-red

Clear and concise description of the problem

Image Image

I think it would be helpful for users if there's a description for each virtual modules. For example:

  • rolldown/runtime.js: rolldown's utilty functions that are used in the bundle
  • vite/modulepreload-polyfill.js: Vite's modulepreload polyfill. See https://vite.dev/config/build-options#build-modulepreload
  • ./src/App.vue?vue&type=script&setup=true&lang.ts: <script> block of ./src/App.vue

Suggested solution

Recommend plugins to add meta.devtools.description values in load hook.

const p = {
  name: 'foo',
  load(id) {
    return { code: content, meta: { devtools: { description: 'Vite's modulepreload polyfill. See https://vite.dev/config/build-options#build-modulepreload' } } }
  }
}

and make devtools will read that information.

Alternative

Add the metadata on plugin object:

const p = {
  name: 'foo',
  meta: {
    devtools: {
      virtualmodulesDescription: {
        'vite/modulepreload-polyfill.js': 'Vite's modulepreload polyfill. See https://vite.dev/config/build-options#build-modulepreload',
      }
    }
  }
}

This does not allow setting the description for dynamic virtual modules.

Additional context

No response

Validations

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions