Running cli commands in the Sveltekit server context

[cedricr]

Hello,

I need to write a couple of command-line scripts in order to do various maintenance tasks on my project (for example one-shot data migrations, commands launched by cron, etc.). But many of them would benefit from code already existing on my SK project (database connexion, ORM, items creation in the DB…)
For people familiar with Django, that would be the equivalent of management commands

The first hurdle was to be able to run the script in the Vite context, but I found vite-node, which works perfectly. I’m currently stuck with environment variables though : if I use import { env } from "$env/dynamic/private", or the static equivalent, I’ll get the following error:

Error: Cannot import $env/dynamic/private into client-side code. This could leak sensitive information.

which I completely understand in the usual context, but I would very much like to be able to bypass here, as I’m not in a client context.

From the code at:
https://github.com/sveltejs/kit/blob/main/packages/kit/src/exports/vite/index.js#L427

I can see that somehow, setting options.ssr to true should do the trick.
Adding a console.log("options", options) at the start of that method and running my script, I see that it’s called many times, with varying values for ssr

$ npx vite-node test.ts 
options { ssr: false }
options { ssr: true }
options { ssr: true }
options { ssr: true }
options { ssr: true }
options { ssr: true }
options { ssr: true }
options { ssr: false }
file:###/node_modules/@sveltejs/kit/src/exports/vite/index.js:440
  throw new Error(`${error_prefix}\nImported by: ${importer}.${error_suffix}`);
                                                      ^
Error: Cannot import $env/dynamic/private into client-side code. This could leak sensitive information.

I’ve tried many ways to sets ssr to true from the command-line, but without any luck.

Any idea if that seems possible at all? Any alternative? How do you all write management commands running on the server?

Thanks in advance!

EDIT: the note at the bottom of the page https://svelte.dev/docs/kit/server-only-modules saying

Unit testing frameworks like Vitest do not distinguish between server-only and public-facing code. For this reason, illegal import detection is disabled when running tests, as determined by process.env.TEST === 'true'.

let me think that maybe there should be a second, similar escape hatch there, like process.env.CLI === 'true' ?

[david-plugge]

#9807 (comment)

[cedricr]

Thanks a lot David, that works perfectly.

Apparently, that’s not really documented ; for whoever comes next 😅, here’s the definition
https://github.com/vitest-dev/vitest/blob/main/packages/vite-node/src/types.ts#L123

Now that I know where to search, I see that it have been asked several time already – I still believe there should be a note about that in SvelteKit documentation, and probably a more accessible way to do it. Something like sv run myscript.ts ?