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: Extend user-defined server-only modules functionality to $lib/server #6623

Merged
merged 3 commits into from
Sep 7, 2022

Conversation

elliott-with-the-longest-name-on-github
Copy link
Contributor

Extend the "throw an error if you import this on the client" functionality to $lib/server so that you don't necessarily have to name every module you want to be server-only something.server.ts.

I also refactored the recursive graph traversal to try to encapsulate concerns a bit more. I was getting frustrated with having to make the same change to the same logic in different places, so I factored the "illegal-checking" away from the "traverse the vite/rollup graph" part. It's technically more lines of code, but most of the addition is in the form of JSDoc comments. I added a bunch of them to make the return types of the functions explicit -- we previously had a few very-subtle bugs where functions were returning undefined instead of false or something like that. Nothing causing any issues yet, but better to be explicit when recursion is involved.

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. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Sep 6, 2022

🦋 Changeset detected

Latest commit: 44e6318

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 Patch

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

@Rich-Harris
Copy link
Member

note-to-self that we need to document this at some point, though it can wait till after sweden

@elliott-with-the-longest-name-on-github
Copy link
Contributor Author

note-to-self that we need to document this at some point, though it can wait till after sweden

See big documentation comment I wrote on the prior PR. I wasn't sure where to stick it. I'm going to create an issue so that we don't forget.

@accuser
Copy link

accuser commented Sep 7, 2022

@tcc-sejohnson this is an amazingly responsive PR - thank you! 👏🏼

I think this will have a positive impact on the Svelte Kit DX.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change $env Bugs related to the `$env` family of modules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants