(feat) copy package.json functionality, update migration script

closes #9114

Author: dummdidumm

.changeset/odd-dragons-complain.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/package': minor
+---
+
+feat: add copy package.json functionality

.changeset/smart-actors-play.md

@@ -0,0 +1,5 @@
+---
+'svelte-migrate': patch
+---
+
+fix: use copy-package.json-functionality to fully resemble old way of doing things

packages/migrate/migrations/package/migrate_pkg.js

@@ -71,7 +71,7 @@ export function update_pkg_json(config, pkg, files) {
 	for (const key in pkg.scripts || []) {
 		const script = pkg.scripts[key];
 		if (script.includes('svelte-package')) {
-			pkg.scripts[key] = script.replace('svelte-package', `svelte-package -o ${out_dir}`);
+			pkg.scripts[key] = script.replace('svelte-package', `svelte-package -o ${out_dir} -c`);
 		}
 	}
 
@@ -81,13 +81,8 @@ export function update_pkg_json(config, pkg, files) {
 		...pkg.exports
 	};
 
-	pkg.files = pkg.files || [];
-	if (!pkg.files.includes(out_dir)) {
-		pkg.files.push(out_dir);
-	}
-
 	if (pkg.devDependencies?.['@sveltejs/package']) {
-		pkg.devDependencies['@sveltejs/package'] = '^2.0.0';
+		pkg.devDependencies['@sveltejs/package'] = '^2.1.0';
 	}
 
 	/** @type {Record<string, string>} */
@@ -112,12 +107,12 @@ export function update_pkg_json(config, pkg, files) {
 				// JSON.stringify will remove the undefined entries
 				pkg.exports[key] = {
 					types: has_type
-						? `./${out_dir}/${
+						? `./${
 								file.is_svelte ? `${file.dest}.d.ts` : file.dest.slice(0, -'.js'.length) + '.d.ts'
 						  }`
 						: undefined,
-					svelte: needs_svelte_condition ? `./${out_dir}/${file.dest}` : undefined,
-					default: `./${out_dir}/${file.dest}`
+					svelte: needs_svelte_condition ? `./${file.dest}` : undefined,
+					default: `./${file.dest}`
 				};
 
 				if (Object.values(pkg.exports[key]).filter(Boolean).length === 1) {

packages/package/src/cli.js

@@ -23,6 +23,7 @@ prog
 	.option('-i, --input', 'Input directory')
 	.option('-o, --output', 'Output directory', 'dist')
 	.option('-t, --types', 'Emit type declarations', true)
+	.option('-c, --copy-pkg-json', 'Copy package.json as is into output folder', false)
 	.option('-w, --watch', 'Rerun when files change', false)
 	.action(async (args) => {
 		try {
@@ -43,6 +44,7 @@ prog
 				input: args.input ?? config.kit?.files?.lib ?? 'src/lib',
 				output: args.output,
 				types: args.types,
+				copy_pkg: args.copyPkgJson,
 				config
 			};
 

packages/package/src/index.js

@@ -41,6 +41,10 @@ async function do_build(options, analyse_code) {
 		await process_file(input, output, file, options.config.preprocess, alias, analyse_code);
 	}
 
+	if (options.copy_pkg) {
+		fs.copyFileSync(path.join(options.cwd, 'package.json'), path.join(output, 'package.json'));
+	}
+
 	console.log(
 		colors
 			.bold()

packages/package/src/types.d.ts

@@ -5,6 +5,7 @@ export interface Options {
 	input: string;
 	output: string;
 	types: boolean;
+	copy_pkg: boolean;
 	config: {
 		extensions?: string[];
 		kit?: {

packages/package/test/fixtures/copy-pkg-json/expected/Test.svelte

@@ -0,0 +1,12 @@
+<script>
+	import { createEventDispatcher } from 'svelte';
+	/**
+	 * @type {string}
+	 */
+	export const astring = 'potato';
+
+	const dispatch = createEventDispatcher();
+	dispatch('event', true);
+</script>
+
+<slot {astring} />

packages/package/test/fixtures/copy-pkg-json/expected/Test.svelte.d.ts

@@ -0,0 +1,40 @@
+/** @typedef {typeof __propDef.props}  TestProps */
+/** @typedef {typeof __propDef.events}  TestEvents */
+/** @typedef {typeof __propDef.slots}  TestSlots */
+export default class Test extends SvelteComponentTyped<
+	{
+		astring?: string;
+	},
+	{
+		event: CustomEvent<any>;
+	} & {
+		[evt: string]: CustomEvent<any>;
+	},
+	{
+		default: {
+			astring: string;
+		};
+	}
+> {
+	get astring(): string;
+}
+export type TestProps = typeof __propDef.props;
+export type TestEvents = typeof __propDef.events;
+export type TestSlots = typeof __propDef.slots;
+import { SvelteComponentTyped } from 'svelte';
+declare const __propDef: {
+	props: {
+		astring?: string;
+	};
+	events: {
+		event: CustomEvent<any>;
+	} & {
+		[evt: string]: CustomEvent<any>;
+	};
+	slots: {
+		default: {
+			astring: string;
+		};
+	};
+};
+export {};

packages/package/test/fixtures/copy-pkg-json/expected/index.d.ts

@@ -0,0 +1 @@
+export { default as Test } from './Test.svelte';

packages/package/test/fixtures/copy-pkg-json/expected/index.js

@@ -0,0 +1 @@
+export { default as Test } from './Test.svelte';

packages/package/test/fixtures/copy-pkg-json/expected/package.json

@@ -0,0 +1,14 @@
+{
+	"name": "copy-pkg-json",
+	"private": true,
+	"version": "1.0.0",
+	"description": "test copy-pkg-json option",
+	"peerDependencies": {
+		"svelte": "^3.55.0"
+	},
+	"exports": {
+		".": {
+			"svelte": "./index.js"
+		}
+	}
+}

packages/package/test/fixtures/copy-pkg-json/jsconfig.json

@@ -0,0 +1 @@
+{}

packages/package/test/fixtures/copy-pkg-json/package.json

@@ -0,0 +1,14 @@
+{
+	"name": "copy-pkg-json",
+	"private": true,
+	"version": "1.0.0",
+	"description": "test copy-pkg-json option",
+	"peerDependencies": {
+		"svelte": "^3.55.0"
+	},
+	"exports": {
+		".": {
+			"svelte": "./index.js"
+		}
+	}
+}

packages/package/test/fixtures/copy-pkg-json/src/lib/Test.svelte

@@ -0,0 +1,12 @@
+<script>
+	import { createEventDispatcher } from 'svelte';
+	/**
+	 * @type {string}
+	 */
+	export const astring = 'potato';
+
+	const dispatch = createEventDispatcher();
+	dispatch('event', true);
+</script>
+
+<slot {astring} />

packages/package/test/fixtures/copy-pkg-json/src/lib/index.js

@@ -0,0 +1 @@
+export { default as Test } from './Test.svelte';

packages/package/test/fixtures/copy-pkg-json/svelte.config.js

@@ -32,6 +32,7 @@ async function test_make_package(path, options) {
 		output,
 		types: true,
 		config,
+		copy_pkg: false,
 		...options
 	});
 
@@ -88,7 +89,7 @@ for (const dir of fs.readdirSync(join(__dirname, 'errors'))) {
 		const input = resolve(cwd, config.kit?.files?.lib ?? 'src/lib');
 
 		try {
-			await build({ cwd, input, output, types: true, config });
+			await build({ cwd, input, output, types: true, config, copy_pkg: false });
 			assert.unreachable('Must not pass build');
 		} catch (/** @type {any} */ error) {
 			assert.instance(error, Error);
@@ -138,6 +139,10 @@ test('create package and resolves $lib alias', async () => {
 	await test_make_package('resolve-alias');
 });
 
+test.only('create package and copy over package.json', async () => {
+	await test_make_package('copy-pkg-json', { copy_pkg: true });
+});
+
 test('SvelteKit interop', async () => {
 	await test_make_package('svelte-kit');
 });
@@ -154,7 +159,8 @@ if (!process.env.CI) {
 			input: 'src/lib',
 			output: 'package',
 			types: true,
-			config
+			config,
+			copy_pkg: false
 		});
 
 		/** @param {string} file */