docs: community addon by sacrosanctic · Pull Request #1018 · sveltejs/cli

sacrosanctic · 2026-03-31T03:34:39Z

Closes nothing

Description

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...)

changeset-bot · 2026-03-31T03:34:44Z

⚠️ No Changeset found

Latest commit: 0c3f9ee

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

svelte-docs-bot · 2026-03-31T03:35:22Z

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

pkg-pr-new · 2026-03-31T03:36:02Z

Open in StackBlitz

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

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

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

commit: 0c3f9ee

sacrosanctic

first time using the review feature, i think i figure it out now.

sacrosanctic · 2026-03-31T03:35:34Z

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


 ```sh
-npx sv add [PROTOCOL][COMMUNITY_ADDON]
+npx sv add [addon_package_name]


need clarification, the uses will see @my-org/sv, but they need to type @my-org?

This is the general statement

PROTOCOL: @ or file:

sacrosanctic · 2026-03-31T03:36:24Z

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

+# Scoped package: @org/sv
+npx sv add @supacool

 # Regular npm package (with or without scope)


what does with or without scope mean?

In npm:

The scope name is everything between the @ and the slash

sacrosanctic · 2026-03-31T03:37:57Z

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


 ```sh
-npx sv add eslint "@supacool"
+npx sv add eslint @supacool


are the quotes required?

On windows yes :/
On the rest no

I agree that it's way better wo the quote!
Maybe we could add "On windows do like this..." ? (But it's also kinda ungly)

sacrosanctic · 2026-03-31T03:38:24Z

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

 ```

-## Add-on structure
+The project has a `README.md` and `CONTRIBUTING.md` to guide you along.


wheres the source?

You think we should remove the chapter?

The diff is inaccurate, the section is just renamed. I'm asking about the readme.md and contributing.md.

sacrosanctic · 2026-03-31T03:41:16Z

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

-
-> [!NOTE]
-> Add the `sv-add` keyword so users can discover your add-on on npm.
-
 ### Export options

 Your package can export the add-on in two ways:


this section is confusing. what are the package names? will sv look for with /sv and without?

Hummm, not sure to understand your question. Maybe because it's not linked with the right part of the code?!

Yes, we are checking root export and /sv export

documentation/docs/40-community-add-ons/10-add-on.md

first pass

358b6ab

use path.join

4285eb3

sacrosanctic commented Mar 31, 2026

View reviewed changes

sacrosanctic and others added 10 commits March 31, 2026 11:48

move addon doc out of api

68a5149

fix link

77d80cf

reverse path.join

838b421

something

5963d8b

why wont it work!

929e40e

first part

cf38bc9

doc review

c910bb7

fix preview ?

a1331ed

refacto

530545a

move things around

0c3f9ee

jycouet marked this pull request as ready for review March 31, 2026 16:14

jycouet merged commit b547e8f into sveltejs:main Mar 31, 2026
13 of 14 checks passed

sacrosanctic deleted the addon-docs branch March 31, 2026 23:17

Uh oh!

Conversation

sacrosanctic commented Mar 31, 2026

Description

Checklist

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!

⚠️ No Changeset found

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!

sacrosanctic left a comment

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!

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!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot bot commented Mar 31, 2026 •

edited

Loading

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

edited

Loading