Skip to content

breaking: remove $lib in favor of #lib - #16360

Merged
Rich-Harris merged 9 commits into
version-3from
lib-alias-change
Jul 17, 2026
Merged

breaking: remove $lib in favor of #lib#16360
Rich-Harris merged 9 commits into
version-3from
lib-alias-change

Conversation

@dummdidumm

Copy link
Copy Markdown
Member

closes #16182

The $lib alias is removed from SvelteKit. You can always get it back by configuring an alias via the kit config: alias: { '$lib': 'src/lib' }. The node-native import map takes its place instead: After configuring it in your package.json ("imports": { "#lib": "./src/lib/index.js", "#lib/*": "./src/lib/*" }) you import from #lib instead of from $lib.

Implementation-wise this had a few consequences:

  • all # paths are now transformed into tsconfig path aliases in our generated tsconfig. This preserves the extension-less imports that many probably like/expect. svelte-package will still get the appropriate TS errors of having to type the extension if moduleResolution: 'nodenext' is set.
  • when normalizing the path in our vite plugin (which is mainly done for surfacing nicer errors) we now take into account the whole import map, instead of just $lib
  • the files.lib config is removed
  • because svelte-package used/recommended it, we now also transform import map paths into relative paths (e.g. when you do import '#lib/foo.js from within src/lib/bar/baz.js it becomes import '../foo.js'). This is because we don't touch the package.json and that file contains the dev-time file resolutions (#lib -> src/lib) instead of the dist (would have to be #lib -> dist to be correct after publishing)
  • adjusted a whole bunch of tests and docs - hopefully got them all right

…lt-in subpath imports

The `#` prefix is reserved by Node for [subpath imports](https://nodejs.org/api/packages.html#subpath-imports), making it a more standard-compatible way to define project-internal aliases. SvelteKit no longer generates a Vite alias or tsconfig paths for `$lib` automatically. Instead, declare the alias in your `package.json` `imports` field:

```json
{
	"imports": {
		"#lib": "./src/lib/index.js",
		"#lib/*": "./src/lib/*"
	}
}
```

Then in your code replace `import { foo } from '$lib/foo.js'` with `import { foo } from '#lib/foo.js'`.
…ge transform the import aliases into relative files
@pkg-svelte-dev

pkg-svelte-dev Bot commented Jul 15, 2026

Copy link
Copy Markdown

Install the latest version of @sveltejs/kit from ead56b8:

pnpm add https://pkg.svelte.dev/@sveltejs/kit/c/ead56b83282659e0e9952555dd383b39b294715a

Open in pkg.svelte.dev: https://pkg.svelte.dev/repos/kit/pr/16360

@changeset-bot

changeset-bot Bot commented Jul 15, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: ead56b8

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

This PR includes changesets to release 3 packages
Name Type
@sveltejs/enhanced-img Patch
@sveltejs/package Minor
@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

@svelte-docs-bot

Copy link
Copy Markdown

@dummdidumm dummdidumm changed the title breaking: remote $lib in favor of #lib breaking: remove $lib in favor of #lib Jul 15, 2026
Comment thread documentation/docs/98-reference/26-$lib.md
Comment thread documentation/docs/98-reference/26-$lib.md Outdated
Comment thread documentation/docs/10-getting-started/30-project-structure.md Outdated
Co-authored-by: Tee Ming <chewteeming01@gmail.com>
Comment thread packages/kit/src/types/synthetic/$lib.md Outdated
Comment thread packages/kit/src/types/synthetic/$lib.md Outdated
Comment thread documentation/docs/98-reference/54-types.md Outdated
Comment thread documentation/docs/30-advanced/50-server-only-modules.md Outdated
Comment thread packages/kit/src/core/config/options.js
Rich-Harris and others added 2 commits July 16, 2026 15:18
@Rich-Harris

Copy link
Copy Markdown
Member

the preview deployment will fail until we release this and update svelte.dev to use #lib

@Rich-Harris
Rich-Harris merged commit 5ca9906 into version-3 Jul 17, 2026
20 of 21 checks passed
@Rich-Harris
Rich-Harris deleted the lib-alias-change branch July 17, 2026 01:29
Rich-Harris pushed a commit that referenced this pull request Jul 17, 2026
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to version-3, this PR
will be updated.

⚠️⚠️⚠️⚠️⚠️⚠️

`version-3` is currently in **pre mode** so this branch has prereleases
rather than normal releases. If you want to exit prereleases, run
`changeset pre exit` on `version-3`.

⚠️⚠️⚠️⚠️⚠️⚠️

# Releases
## @sveltejs/kit@3.0.0-next.9

### Major Changes

- breaking: `handle`'s `resolve` is now typed to always return a
`Promise` ([#16352](#16352))

- breaking: replace the `$lib` alias with `#lib` and remove `files.lib`
config. ([#16360](#16360))

- breaking: disallow cross-origin form submissions without a
`Content-Type` header
([#16347](#16347))

- breaking: Server-only directories (`/server/` in the path) are now
treated as server-only everywhere inside the project (except
`src/routes` and the assets directory)
([#16360](#16360))

- breaking: delegate CORS handling to Vite for static directory requests
during development
([#16357](#16357))

### Minor Changes

- feat: reinstate `$env/static/private`, `$env/dynamic/private`,
`$env/static/public`, `$env/dynamic/public` and `$app/environment` as
deprecated aliases for `$app/env/private` `$app/env/public` and
`$app/env` ([#16334](#16334))

### Patch Changes

- perf: cache the default cookie header parse and avoid allocations in
`cookies.get` ([#16341](#16341))

- fix: avoid client-side code being bundled by Cloudflare Wrangler
([#16364](#16364))

- fix: handle rejected streamed server data after delayed loads
([#16268](#16268))

- fix: enable CSRF protection in builds with a non-production `NODE_ENV`
value ([#16313](#16313))
## @sveltejs/package@3.0.0-next.3

### Minor Changes

- feat: transform import aliases into relative imports in files
([#16360](#16360))
## @sveltejs/adapter-node@6.0.0-next.4

### Patch Changes

- fix: correctly bundle entrypoints on Windows
([#16367](#16367))
- Updated dependencies
[[`c1ee782`](c1ee782),
[`1a1b3ea`](1a1b3ea),
[`6423d98`](6423d98),
[`6d1f4f0`](6d1f4f0),
[`5ca9906`](5ca9906),
[`b148d31`](b148d31),
[`5ca9906`](5ca9906),
[`9f3d9bb`](9f3d9bb),
[`7bfd922`](7bfd922),
[`ffa0e3b`](ffa0e3b)]:
  - @sveltejs/kit@3.0.0-next.9
## @sveltejs/enhanced-img@1.0.0-next.2

### Patch Changes

- chore: replace the `$lib` alias with `#lib` in docs
([#16360](#16360))

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

replace $lib with #lib In development mode, $lib always points to the currently running app, rather than the app which declared it.

3 participants