Skip to content

explicitly document setting options of vite-plugin-svelte via svelte.config.js #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
inspiredlabs opened this issue Jul 1, 2022 · 2 comments · Fixed by #383
Closed
Labels
enhancement New feature or request

Comments

@inspiredlabs
Copy link

inspiredlabs commented Jul 1, 2022

Describe the problem

It wasn't obvious that svelte.config.js has experimental features:

const config = {
  //experimental: { inspector: true },
  ...
}

Describe the proposed solution

The documentation is clearly a moving target at this stage – but it might be worth adding this, explicit example to svelte.config.js, commented out as:

const config = {
  //experimental: { inspector: true },
  ...
}

A minimal hint such as this would encourage debugging without additional configuration, consulting the documentation or extraneous changes to config.md when the API drops the experimental flag.

Alternatives considered

Make the distinction clearer in config.md, as the alternative configuration seems confusing.

Importance

nice to have

@inspiredlabs inspiredlabs added enhancement New feature or request triage Awaiting triage by a project member labels Jul 1, 2022
@bluwy
Copy link
Member

bluwy commented Jul 2, 2022

Do you mean adding experimental: {} under this section's second code example too? I think that would be fine to add.

@dominikg dominikg changed the title Resolving inspector in svelte.config.js could be added to config.md explicitly document setting options of vite-plugin-svelte via svelte.config.js Jul 7, 2022
@dominikg dominikg removed the triage Awaiting triage by a project member label Jul 7, 2022
@dominikg
Copy link
Member

dominikg commented Jul 7, 2022

Updated title and importance.

Please don't file minor documentation improvements with high importance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants