fix: note @migration comments, fix cookie migration (#11331)

fixes #11327 --------- Co-authored-by: Simon H <[email protected]>
sveltejs · Dec 15, 2023 · 88ce6b0 · 88ce6b0
1 parent f0dcc76
commit 88ce6b0
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/.changeset/honest-badgers-itch.md b/.changeset/honest-badgers-itch.md
@@ -0,0 +1,5 @@
+---
+'svelte-migrate': patch
+---
+
+fix: adjust cookie migration logic, note installation
diff --git a/packages/migrate/migrations/sveltekit-2/index.js b/packages/migrate/migrations/sveltekit-2/index.js
@@ -10,13 +10,13 @@ import {
 	update_svelte_file,
 	update_tsconfig
 } from '../../utils.js';
+import { migrate as migrate_svelte_4 } from '../svelte-4/index.js';
 import {
 	transform_code,
 	update_pkg_json,
 	update_svelte_config,
 	update_tsconfig_content
 } from './migrate.js';
-import { migrate as migrate_svelte_4 } from '../svelte-4/index.js';
 
 export async function migrate() {
 	if (!fs.existsSync('package.json')) {
@@ -148,6 +148,7 @@ export async function migrate() {
 	const cyan = colors.bold().cyan;
 
 	const tasks = [
+		'Run npm install (or the corresponding installation command of your package manager)',
 		use_git && cyan('git commit -m "migration to SvelteKit 2"'),
 		'Review the migration guide at https://kit.svelte.dev/docs/migrating-to-sveltekit-2',
 		'Read the updated docs at https://kit.svelte.dev/docs'

diff --git a/packages/migrate/migrations/sveltekit-2/migrate.js b/packages/migrate/migrations/sveltekit-2/migrate.js
@@ -197,7 +197,7 @@ function add_cookie_note(file_path, source) {
 
 	const logger = log_on_ts_modification(
 		source,
-		'Remember to add the `path` option to `cookies.set/delete/serialize` calls: https://kit.svelte.dev/docs/migrating-to-sveltekit-2#path-is-now-a-required-option-for-cookies'
+		'Search codebase for `@migration` and manually add the `path` option to `cookies.set/delete/serialize` calls: https://kit.svelte.dev/docs/migrating-to-sveltekit-2#path-is-now-a-required-option-for-cookies'
 	);
 
 	const calls = [];
@@ -240,6 +240,7 @@ function add_cookie_note(file_path, source) {
 		if (
 			expression_text !== 'cookies' &&
 			(!expression_text.includes('.') ||
+				expression_text.split('.').pop() !== 'cookies' ||
 				!parent_function.getParameter(expression_text.split('.')[0]))
 		) {
 			continue;

diff --git a/packages/migrate/migrations/sveltekit-2/tsjs-samples.md b/packages/migrate/migrations/sveltekit-2/tsjs-samples.md
@@ -101,6 +101,10 @@ export function foo(event) {
 	x.cookies.set('foo', 'bar');
 }
 
+export function bar(event) {
+	event.x.set('foo', 'bar');
+}
+
 cookies.set('foo', 'bar');
 ```
 
@@ -113,6 +117,10 @@ export function foo(event) {
 	x.cookies.set('foo', 'bar');
 }
 
+export function bar(event) {
+	event.x.set('foo', 'bar');
+}
+
 cookies.set('foo', 'bar');
 ```