better onboarding

Author: jycouet

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

@@ -78,10 +78,7 @@ To start on a good track, create your add-on with the `addon` template.
 npx sv create --template addon [path]
 ```
 
-Two key things to note, your `add-on` should:
-
-- export a function that returns a `defineAddon` object.
-- have a `package.json` with an `exports` field that points to the main entry point of the add-on.
+In your new add-on directory, check out the `README.md` and `CONTRIBUTING.md` files for more information.
 
 ### How to publish a community add-on
 

packages/sv/lib/cli/tests/cli.ts

@@ -60,24 +60,20 @@ describe('cli', () => {
 				projectName
 			);
 
-			const result = await exec(
-				'node',
-				[
-					svBinPath,
-					'create',
-					testOutputPath,
-					'--template',
-					template,
-					...(template === 'addon' ? ['--no-types'] : ['--types', 'ts']),
-					'--no-install',
-					...args
-				],
-				{ nodeOptions: { stdio: 'pipe' } }
-			);
+			const allArgs = [
+				svBinPath,
+				'create',
+				testOutputPath,
+				'--template',
+				template,
+				...(template === 'addon' ? [] : ['--types', 'ts']),
+				'--no-install',
+				...args
+			];
+			const result = await exec('node', allArgs, { nodeOptions: { stdio: 'pipe' } });
 
 			// cli finished well
 			expect(result.exitCode, `Error with cli: '${result.stderr}'`).toBe(0);
-
 			// test output path exists
 			expect(fs.existsSync(testOutputPath)).toBe(true);
 
@@ -132,7 +128,7 @@ describe('cli', () => {
 					// list of cmds to test
 					['i'],
 					['run', 'demo-create'],
-					['run', 'demo-add'],
+					['run', 'demo-add:ci'],
 					['run', 'test']
 				];
 				for (const cmd of cmds) {

packages/sv/lib/cli/tests/snapshots/@my-org/sv/CONTRIBUTING.md

@@ -1,18 +1,25 @@
 # Contributing Guide
 
-Some convinient scripts are provided to help develop the add-on.
+Some convenient scripts are provided to help develop the add-on.
 
 ```sh
-## create a new demo project
+## create a new minimal project in the `demo` directory
 npm run demo-create
 
-## add your add-on to the demo project
+## add your current add-on to the demo project
 npm run demo-add
 
 ## run the tests
 npm run test
 ```
 
+## Key things to note
+
+Your `add-on` should:
+
+- export a function that returns a `defineAddon` object.
+- have a `package.json` with an `exports` field that points to the main entry point of the add-on.
+
 ## Sharing your add-on
 
 When you're ready to publish your add-on to npm, run:

packages/sv/lib/cli/tests/snapshots/@my-org/sv/package.json

@@ -6,7 +6,8 @@
 	"license": "MIT",
 	"scripts": {
 		"demo-create": "sv create demo --types ts --template minimal --no-add-ons --no-install",
-		"demo-add": "sv add file:../=who:you --cwd demo --no-git-check --no-download-check --no-install",
+		"demo-add": "sv add file:../ --cwd demo --no-git-check --no-install",
+		"demo-add:ci": "sv add file:../=who:you --cwd demo --no-git-check --no-download-check --no-install",
 		"test": "vitest run"
 	},
 	"files": [

packages/sv/lib/create/shared/+addon/CONTRIBUTING.md

@@ -1,18 +1,25 @@
 # Contributing Guide
 
-Some convinient scripts are provided to help develop the add-on.
+Some convenient scripts are provided to help develop the add-on.
 
 ```sh
-## create a new demo project
+## create a new minimal project in the `demo` directory
 npm run demo-create
 
-## add your add-on to the demo project
+## add your current add-on to the demo project
 npm run demo-add
 
 ## run the tests
 npm run test
 ```
 
+## Key things to note
+
+Your `add-on` should:
+
+- export a function that returns a `defineAddon` object.
+- have a `package.json` with an `exports` field that points to the main entry point of the add-on.
+
 ## Sharing your add-on
 
 When you're ready to publish your add-on to npm, run:

packages/sv/lib/create/templates/addon/package.template.json

@@ -6,7 +6,8 @@
 	"license": "MIT",
 	"scripts": {
 		"demo-create": "sv create demo --types ts --template minimal --no-add-ons --no-install",
-		"demo-add": "sv add file:../=who:you --cwd demo --no-git-check --no-download-check --no-install",
+		"demo-add": "sv add file:../ --cwd demo --no-git-check --no-install",
+		"demo-add:ci": "sv add file:../=who:you --cwd demo --no-git-check --no-download-check --no-install",
 		"test": "vitest run"
 	},
 	"files": ["src", "!src/**/*.test.*"],