feat: community add-on `experimental` by jycouet · Pull Request #1020 · sveltejs/cli

jycouet · 2026-03-31T17:15:07Z

Closes #184

Description

Adding community add-ons in an experimental phase!
updated docs

Checklist

Update snapshots (if applicable)
Add a changeset (if applicable)
Allow maintainers to edit this PR
I care about what I'm doing, no matter the tool I use (Notepad, Sublime, VSCode, AI...)

svelte-docs-bot · 2026-03-31T17:15:53Z

Preview: https://svelte-dev-git-preview-cli-1020-svelte.vercel.app/

pkg-pr-new · 2026-03-31T17:16:30Z

Open in StackBlitz

npx https://pkg.pr.new/svelte-migrate@1020

npx https://pkg.pr.new/sv@1020

npx https://pkg.pr.new/@sveltejs/sv-utils@1020

commit: 6837ecc

changeset-bot · 2026-03-31T17:23:40Z

🦋 Changeset detected

Latest commit: 6837ecc

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

This PR includes changesets to release 2 packages

Name	Type
sv	Minor
@sveltejs/sv-utils	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

documentation/docs/20-commands/20-sv-add.md

teemingc · 2026-03-31T18:47:08Z

documentation/docs/30-add-ons/99-community.md

@@ -2,5 +2,261 @@
 title: [create your own]


cc @sacrosanctic 🧡

documentation/docs/30-add-ons/99-community.md

Co-authored-by: Tee Ming <chewteeming01@gmail.com>

documentation/docs/30-add-ons/99-community.md

Co-authored-by: Tee Ming <chewteeming01@gmail.com>

… feat/community-add-ons

sacrosanctic · 2026-03-31T23:52:02Z

Current

API
- sv-utils

Proposal 1

API
- defineAddon
- defineAddonOptions
- transforms
- parse

Proposal 2

API
- sv
- sv-utils

sacrosanctic · 2026-04-01T00:12:25Z

documentation/docs/20-commands/20-sv-add.md

+> [!NOTE]
+> Svelte maintainers have not reviewed community add-ons for malicious code!
+
+Community add-ons are npm packages published by the community. Look out for add-ons from your favourite libraries and tools. _(soon)_ many developers are building `sv` add-ons to make their integrations a one-liner. You can find them [on npm](https://www.npmx.dev/search?q=keyword:sv-add) by searching for the keyword: `sv-add`.


I have never opened a sentence with a bracket before. How does capitalization rule work? Is that even allowed? 😅

Is that even allowed

You know, in France, we take the right 😅

I was thinking it's a nice "didascalie"

documentation/docs/20-commands/20-sv-add.md

documentation/docs/30-add-ons/99-community.md

sacrosanctic · 2026-04-01T03:02:04Z

documentation/docs/30-add-ons/99-community.md

+
+### Naming convention
+
+If you name your package `@your-org/sv`, users can install it by typing just the org handle:


Suggested change

If you name your package `@your-org/sv`, users can install it by typing just the org handle:

Name your add-on as either a sub-package `@your-org/sv` or as a dedicated package `@your-org`. Your users can install it by typing the org handle:

I think that the previous sentence was better.

We can mention it can't be the root package here.

sacrosanctic · 2026-04-01T03:02:45Z

documentation/docs/30-add-ons/99-community.md

+
+```sh
+# npm package: @your-org/sv
+npx sv add @your-org


Suggested change

npx sv add @your-org

npx sv add @your-org

# npm package: @your-org

npx sv add @your-org

If you publish your sv addon as @your-org (I do'nt know if it's possible). sv will not pick it up.

you can publish:

# you can publish @my-org/sv # and you have a shorcut to do "npx sv add @my-org" # you can publish @my-org/my-super-cool-stuff # can users will be able to add "npx sv add @my-org/my-super-cool-stuff"

I misunderstood how it works.

sacrosanctic · 2026-04-01T03:04:08Z

documentation/docs/30-add-ons/99-community.md

+> [!NOTE]
+> Unscoped packages are not supported yet
+
+### Export options


This section and naming convention could be combined.

I didn't get it

There's 2 sections, "naming convention" and "export options". They feel very similar to me and couldn't refactored together.

sacrosanctic · 2026-04-01T03:05:41Z

documentation/docs/30-add-ons/99-community.md

+
+`sv` first tries to import `your-package/sv`, then falls back to the default export. This means you have two options:
+
+1. **Default export** (recommended for dedicated add-on packages):


Suggested change

1. **Default export** (recommended for dedicated add-on packages):

1. **Default export** (for dedicated add-on packages):

Who's an example that would do this?

I didn't get it

I thought you could publish to root. You meant having a dedicated repo that publishes to @your-org/sv

sacrosanctic · 2026-04-01T03:10:40Z

documentation/docs/30-add-ons/99-community.md

+npm login
+npm publish


I don't publish, but is there a command we can add here to slightly nudge people to use trusted publishing (and related security features).

I think it's a bit "out of scope" atm, we already tell a lot. No?

I mean, with pnpm we can also do a few things differently. we can setup changeset, we can setup OICD, we can setup pkg, ...

I think that we show already a lot, so showing the "raw npm" way is already good enough IMO

sacrosanctic · 2026-04-01T03:13:14Z

documentation/docs/30-add-ons/99-community.md

+
+See the [official add-on source code](https://github.com/sveltejs/cli/tree/main/packages/sv/src/addons) for some real world examples.
+
+## Architecture


combine with project structure

You think so?
I link it to be a bit separate... but maybe it's too much down atm?

But why not merging under the project structure?

incase i messed it up again, im talking about architecture+project structure

Co-authored-by: Scott Wu <sw@scottwu.ca>

… feat/community-add-ons

jycouet · 2026-04-01T08:35:19Z

Current

API

sv-utils

Proposal 1

API

defineAddon

defineAddonOptions

transforms

parse

Proposal 2

API

sv

sv-utils

I think that proposal 2 would be great 👍

jycouet added 2 commits March 31, 2026 19:09

feat: community add-ons

bb646a6

add changeset

70cacaf

note for windows users

60faa61

jycouet added 2 commits March 31, 2026 19:36

adding tests doc

ec0bc1c

fix to accommodate npm (not pnpm)

ada56fe

jycouet changed the title ~~feat: community add-ons experimental~~ feat: community add-on experimental Mar 31, 2026

teemingc reviewed Mar 31, 2026

View reviewed changes

documentation/docs/20-commands/20-sv-add.md Outdated Show resolved Hide resolved

teemingc reviewed Mar 31, 2026

View reviewed changes

documentation/docs/30-add-ons/99-community.md Outdated Show resolved Hide resolved

teemingc reviewed Mar 31, 2026

View reviewed changes

documentation/docs/30-add-ons/99-community.md Outdated Show resolved Hide resolved

teemingc reviewed Mar 31, 2026

View reviewed changes

documentation/docs/30-add-ons/99-community.md Outdated Show resolved Hide resolved

jycouet and others added 4 commits March 31, 2026 20:53

Update documentation/docs/20-commands/20-sv-add.md

74230aa

Co-authored-by: Tee Ming <chewteeming01@gmail.com>

Update documentation/docs/30-add-ons/99-community.md

296d172

Co-authored-by: Tee Ming <chewteeming01@gmail.com>

Update documentation/docs/30-add-ons/99-community.md

d48f88c

Co-authored-by: Tee Ming <chewteeming01@gmail.com>

Update documentation/docs/30-add-ons/99-community.md

5ed99a2

Co-authored-by: Tee Ming <chewteeming01@gmail.com>

teemingc reviewed Mar 31, 2026

View reviewed changes

documentation/docs/30-add-ons/99-community.md Outdated Show resolved Hide resolved

teemingc reviewed Mar 31, 2026

View reviewed changes

documentation/docs/30-add-ons/99-community.md Outdated Show resolved Hide resolved

teemingc reviewed Mar 31, 2026

View reviewed changes

documentation/docs/30-add-ons/99-community.md Outdated Show resolved Hide resolved

jycouet and others added 4 commits March 31, 2026 21:03

Update documentation/docs/30-add-ons/99-community.md

d1d5a59

Co-authored-by: Tee Ming <chewteeming01@gmail.com>

Update documentation/docs/30-add-ons/99-community.md

d21b1b7

Co-authored-by: Tee Ming <chewteeming01@gmail.com>

Update documentation/docs/30-add-ons/99-community.md

6bc994b

Co-authored-by: Tee Ming <chewteeming01@gmail.com>

Merge branch 'feat/community-add-ons' of github.com:sveltejs/cli into…

fed0fca

… feat/community-add-ons

This was referenced Mar 31, 2026

community add-on experimental - update joanofxyz/sv-add-threlte#1

Open

community add-on experimental - update Vermont-Complex-Systems/vcsi-starter#10

Open

update keyworkds

89bfbe3

sacrosanctic reviewed Apr 1, 2026

View reviewed changes

documentation/docs/20-commands/20-sv-add.md Outdated Show resolved Hide resolved

sacrosanctic reviewed Apr 1, 2026

View reviewed changes

documentation/docs/20-commands/20-sv-add.md Outdated Show resolved Hide resolved

sacrosanctic reviewed Apr 1, 2026

View reviewed changes

documentation/docs/30-add-ons/99-community.md Outdated Show resolved Hide resolved

sacrosanctic reviewed Apr 1, 2026

View reviewed changes

jycouet and others added 7 commits April 1, 2026 07:30

npmx

15dfa92

M

b903424

Update documentation/docs/20-commands/20-sv-add.md

074589a

Co-authored-by: Scott Wu <sw@scottwu.ca>

Update documentation/docs/20-commands/20-sv-add.md

304dc88

Co-authored-by: Scott Wu <sw@scottwu.ca>

Update documentation/docs/30-add-ons/99-community.md

c749319

Co-authored-by: Scott Wu <sw@scottwu.ca>

tweaks

9682efe

Merge branch 'feat/community-add-ons' of github.com:sveltejs/cli into…

6837ecc

… feat/community-add-ons


		### Naming convention

		If you name your package `@your-org/sv`, users can install it by typing just the org handle:

	If you name your package `@your-org/sv`, users can install it by typing just the org handle:
	Name your add-on as either a sub-package `@your-org/sv` or as a dedicated package `@your-org`. Your users can install it by typing the org handle:


		`sv` first tries to import `your-package/sv`, then falls back to the default export. This means you have two options:

		1. Default export (recommended for dedicated add-on packages):

	1. Default export (recommended for dedicated add-on packages):
	1. Default export (for dedicated add-on packages):


		See the [official add-on source code](https://github.com/sveltejs/cli/tree/main/packages/sv/src/addons) for some real world examples.

		## Architecture

Uh oh!

Conversation

jycouet commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

svelte-docs-bot bot commented Mar 31, 2026

Uh oh!

pkg-pr-new bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

teemingc Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sacrosanctic commented Mar 31, 2026

Current

Proposal 1

Proposal 2

Uh oh!

sacrosanctic Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sacrosanctic Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jycouet commented Apr 1, 2026

jycouet commented Mar 31, 2026 •

edited

Loading

pkg-pr-new bot commented Mar 31, 2026 •

edited

Loading

changeset-bot bot commented Mar 31, 2026 •

edited

Loading

teemingc Mar 31, 2026 •

edited

Loading

sacrosanctic Apr 1, 2026 •

edited

Loading

sacrosanctic Apr 1, 2026 •

edited

Loading