feat: remove the postinstall script in favor of template prepare script

[benmccann]

NOTICE: users should add "prepare": "svelte-kit sync" to their projects. preprepare may also be used in favor of prepare, but is not currently supported on all systems. E.g. users of pnpm should prefer prepare until pnpm/pnpm#8989 is merged and release

This solves multiple problems. Firstly, the postinstall script doesn't run on any version of pnpm today because pnpm caches side-effects and they get executed only once ever. Secondly, with pnpm 10 the postinstall scripts of dependencies do not run by default and need to be enabled on a package-by-package basis

[changeset-bot]

🦋 Changeset detected

Latest commit: cee9a29

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

This PR includes changesets to release 1 package

Name	Type
@sveltejs/kit	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

[Rich-Harris]

preview: https://svelte-dev-git-preview-kit-13304-svelte.vercel.app/

this is an automated message

[dominikg]

is this correct? this assumes the vite command is always run with cwd being the sveltekit app.
As a user i'd also prefer if this was silencable without adding a prepare script.

[benmccann]

Can you run it any other way? I remember those PRs trying to allow you to configure the cwd and you commenting that we should reject those

Any ideas on how you'd want to silence it?

[dominikg]

for silencing it i guess going through onwarn would help.

One way to avoid false positives at least would be to check if @sveltejs/kit was in devDependencies.

[dominikg]

regarding control over cwd this was a genuine question. If we deem it appropriate to have this as a constraint (i think other parts of our code might also rely on it) then this method here is the easiest. If not, we'd have to go through vite root in configResolved.

[benmccann]

okay, I put it through onwarn

This is SvelteKit, so you kind of have to have @sveltejs/kit in your dependencies. I'm not sure what such a check would be looking for

I added an explicit reference to cwd so that if we ever do make cwd configurable we won't overlook this as something to check - though it doesn't sound like we'll be doing that so I'm not too worried about it

[dummdidumm]

All that the prepare script is supposed to be doing is run sync, which will just avoid the annoying warning. People having existing projects will not see that run anyway, and people with new projects going through the CLI will have the prepare script setup for them. So I would just remove that warning entirely. It's not like there's any harm in not running sync in advance other than this Vite warning.

[benmccann]

okay. I removed the warning and instead filed #13326 and added extra details to the changeset

[leonidaz]

interesting that prepare is still mentioned in the documentation:

kit/documentation/docs/98-reference/52-cli.md

Line 15 in c2ffdcf

`svelte-kit sync` creates the `tsconfig.json` and all generated types (which you can import as `./$types` inside routing files) for your project. When you create a new project, it is listed as the `prepare` script and will be run automatically as part of the npm lifecycle, so you should not ordinarily have to run this command.

[Conduitry]

Installing a package from Git does run its prepare script (unlike installing it from a registry or from a tarball). I don't know whether that's going to have some impact on this. I guess if someone intended their library to be consumed that way, they'd change their prepare script to run npm run package instead anyway, and we wouldn't need to worry about this?

[dominikg]

we could try to detect presence of svelte-package in devDependencies and not log then.

Alternatively if this didn't work in pnpm for a long time and we update the template for new apps, do we really need this warning? It'll sort itself after first call of vite dev or vite build so it is a nuisnance at best. As long as me make an FAQ entry discoverable by the error message text, isn't that enough?

[benmccann]

Installing a package from Git does run its prepare script (unlike installing it from a registry or from a tarball). I don't know whether that's going to have some impact on this.

Hmm. That would affect Svelte libraries published via git for consumption in non-SvelteKit projects. I guess in that case they can just remove the prepare script and live with the warning until we remove it after a migration period. Not ideal, but hopefully not very common

I guess if someone intended their library to be consumed that way, they'd change their prepare script to run npm run package instead anyway, and we wouldn't need to worry about this?

I expect they'd still want svelte-kit sync to run for local development, but could just rely on dev doing it. They wouldn't necessarily change their prepare script. The template has:

"prepublishOnly": "npm run package",

Alternatively if this didn't work in pnpm for a long time and we update the template for new apps, do we really need this warning? It'll sort itself after first call of vite dev or vite build so it is a nuisnance at best. As long as me make an FAQ entry discoverable by the error message text, isn't that enough?

It is true that missing it doesn't break anything. But it's a nicer experience with it present and I feel most people aren't going to know they should add it now or even take the time to Google why all of a sudden they're getting a new warning. It feels a lot nicer if we can help people migrate

[ryansobol]

Strange, I'm still seeing the warning, despite trying both "prepare" and "preprepare". What am I doing wrong?

$ pnpm -v
10.0.0
$ grep '@sveltejs/kit' package.json
                "@sveltejs/kit": "^2.16.0",
$ grep prepare package.json
                "preprepare": "svelte-kit sync",
                "prepare": "svelte-kit sync",
$ rm -rf .svelte-kit/
$ pnpm run dev

> admin-platform@0.0.1 dev /Users/ryansobol/Projects/ryansobol/admin-platform
> vite dev

▲ [WARNING] Cannot find base config file "./.svelte-kit/tsconfig.json" [tsconfig.json]

    tsconfig.json:2:12:
      2 │   "extends": "./.svelte-kit/tsconfig.json",
        ╵              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


  VITE v6.0.7  ready in 983 ms

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose
  ➜  press h + enter to show help

[cloudymeatball]

Is this something all existing kit projects should add, or just for ones expected to use / potentially use pnpm 10?

[benmccann]

@ryansobol it looks like a bug in pnpm. Hopefully pnpm/pnpm#8989 should fix it

@cloudymeatball all existing kit projects should add that line to their package.json

[fromaline]

I get this error after upgrading to @sveltejs/kit@2.16.0, is it somehow related to the postinstall script?

error during build:
[vite-plugin-sveltekit-compile] ENOENT: no such file or directory, open '/Users/username/Personal/project/.svelte-kit/output/server/undefined'
    at Object.readFileUtf8 (node:internal/fs/sync:25:18)
    at Object.readFileSync (node:fs:441:19)
    at file:///Users/username/Personal/project/node_modules/@sveltejs/kit/src/exports/vite/build/build_server.js:56:24
    at Array.forEach (<anonymous>)
    at build_server_nodes (file:///Users/username/Personal/project/node_modules/@sveltejs/kit/src/exports/vite/build/build_server.js:48:5)
    at Object.handler (file:///Users/username/Personal/project/node_modules/@sveltejs/kit/src/exports/vite/index.js:919:5)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async PluginDriver.hookParallel (file:///Users/username/Personal/project/node_modules/rollup/dist/es/shared/node-entry.js:19858:17)
    at async file:///Users/username/Personal/project/node_modules/rollup/dist/es/shared/node-entry.js:20860:13
    at async catchUnfinishedHookActions (file:///Users/username/Personal/project/node_modules/rollup/dist/es/shared/node-entry.js:20282:16)

[benmccann]

I get this error after upgrading to @sveltejs/kit@2.16.0, is it somehow related to the postinstall script?

No. It would be related to #13068

[fromaline]

@benmccann, thanks a lot! Removing inlineStyleThreshold resolved the issue for me!