Skip to content

breaking: nested server-only directories#15685

Open
rChaoz wants to merge 4 commits intosveltejs:version-3from
rChaoz:feat/recursive-server-dirs
Open

breaking: nested server-only directories#15685
rChaoz wants to merge 4 commits intosveltejs:version-3from
rChaoz:feat/recursive-server-dirs

Conversation

@rChaoz
Copy link
Copy Markdown
Contributor

@rChaoz rChaoz commented Apr 9, 2026

closes #12732

Instead of only considering $lib/server/** as server-only modules, consider $lib/**/server/** instead, see issue above for reasoning.

As per the conversation in #12733, adding this as defaults for v3 (breaking change).


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.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 9, 2026

🦋 Changeset detected

Latest commit: 26bce18

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 Major

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

@rChaoz rChaoz marked this pull request as ready for review April 9, 2026 11:52
@svelte-docs-bot
Copy link
Copy Markdown

Comment thread packages/kit/src/exports/vite/index.js Outdated
@rChaoz rChaoz force-pushed the feat/recursive-server-dirs branch from 2244f2d to 2f75514 Compare April 9, 2026 12:06
@rChaoz rChaoz changed the title Feat/recursive server dirs feat: recursive $lib server dirs Apr 9, 2026
Comment thread packages/kit/src/exports/vite/index.js
@rChaoz rChaoz marked this pull request as draft April 9, 2026 12:30
@rChaoz rChaoz force-pushed the feat/recursive-server-dirs branch from 2f75514 to cd3c44f Compare April 15, 2026 18:32
@rChaoz rChaoz marked this pull request as ready for review April 15, 2026 18:32
@rChaoz rChaoz changed the title feat: recursive $lib server dirs feat!: recursive $lib server dirs Apr 15, 2026
'@sveltejs/kit': major
---

recursive $lib server dirs
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
recursive $lib server dirs
breaking: nested server-only directories


- adding `.server` to the filename, e.g. `secrets.server.js`
- placing them in `$lib/server`, e.g. `$lib/server/secrets.js`
- For single modules, add `.server` to the filename, e.g. `secrets.server.js`. This works for _any_ file in the project directory, including within `$lib` or `$routes`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think we automatically create a $routes alias, do we?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Right, I've had one in my projects for so long I forgot it's not native

const import_map = new Map();
const server_only_pattern = /.*\.server\..+/;
// Matches any ID that has .server. in its filename
const server_only_module_pattern = /\.server\.[^/]+$/;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

did we change this from what it was before on purpose?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, for consistency

normalized.startsWith('$lib/server/') ||
(is_internal && server_only_pattern.test(path.basename(id)));
(normalized.startsWith('$lib/') && server_only_directory_pattern.test(id)) ||
(is_internal && server_only_module_pattern.test(id));
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Was there any reason to change this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Same reason as above. It also prevents false positives because the hook ID filters no longer match .server in directory names

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These tests are good, but we should probably add another two apps to build-errors for nested server directories, both dynamic and static imports. You should be able to just ctrl+c, ctrl+v one of the existing test apps in build-errors and modify from there. The tests are in env.spec.js

@elliott-with-the-longest-name-on-github elliott-with-the-longest-name-on-github changed the title feat!: recursive $lib server dirs breaking: nested server-only directories Apr 21, 2026
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