Skip to content
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

feat: allow to specify options for the service worker in svelte.config.js #13578

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

paoloricciuti
Copy link
Member

Currently there's no way to pass options for the automatically registered service worker so if you wanted a type module for example you would have to set register to false and manually register it. This PR add the options in the svelte.config.js under kit.serviceWorker.options.

I still need to write tests and docs for this but i wanted to put this out there since I can't work on it right now.


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
joyeecheung Joyee Cheung
…ig.js`
Copy link

changeset-bot bot commented Mar 13, 2025

🦋 Changeset detected

Latest commit: 394d86b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Verified

This commit was signed with the committer’s verified signature.
aduh95 Antoine du Hamel

Verified

This commit was signed with the committer’s verified signature.
aduh95 Antoine du Hamel

Verified

This commit was signed with the committer’s verified signature.
aduh95 Antoine du Hamel

Verified

This commit was signed with the committer’s verified signature.
aduh95 Antoine du Hamel
Comment on lines +270 to +272
// options could be undefined but if it is defined we only validate that
// it's an object since the type comes from the browser itself
options: validate(undefined, object({}, true)),
Copy link
Member

Choose a reason for hiding this comment

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

we'd still want to error early, no?

Copy link
Member Author

Choose a reason for hiding this comment

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

If it's undefined we just don't add the options...if they pass some unknown values it's also fine, this way in case they update the signature we don't need to fix it on our end...or do you mean something else?

Copy link
Member

Choose a reason for hiding this comment

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

hmm, yeah i guess since we're not using it internally it doesn't really matter — types are sufficient. fair enough

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.

None yet

2 participants