feat(cli): ensure CWD is project root when running migration commands

[juice49]

Description

This branch adds an ensureCwdIsProjectRoot function that can be used by CLI commands to improve UX when the Sanity CLI is mistakenly used outside of a Studio project root.

If no CLI configuration can be resolved, the CLI will now search parent directories for any Studio or CLI configuration file. If It finds one, it will infer that it is the project root directory and print a notice that the user should move there and try the command again.

This change doesn't affect the way the CLI configuration is resolved; it's only used to print a notice.

I've initially added this to the migration commands (create, list, and run).

What to review

• That the output printed makes sense.
• That the change doesn't introduce unnecessary overhead (it shouldn't; we only search for config files if one could not already be resolved in the CWD).

Testing

Run the migration commands (create, list, and run) from a subdirectory of a Studio project. For example, the test Studio migrations directory (dev/test-studio/migrations). The CLI can be invoked here by running ../../.bin/sanity migration list etc.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
performance-studio	✅ Ready (Inspect)	Visit Preview		Feb 12, 2024 11:51am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 12, 2024 11:51am

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Feb 12, 2024 11:51am

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Feb 12, 2024 11:53 AM (UTC)

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	33s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	6s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	12s	3	0	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	13s	4	2	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	12s	6	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	33s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	18s	9	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 1s	18	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	13s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	19s	9	0	0

[bjoerge]

a potential (although probably quite small) perf hit by awaiting these in sequence, so you could consider moving them up and do something like:

const [corePath, projectRootPath] = await Promise.all([
  getCoreModulePath(workDir, cliConfig),
  getProjectRoot()
])

[juice49]

Aha! Good catch. I'll see if this can be easily refactored.

[rexxars]

🤔 I thought this was already being done here:

sanity/packages/@sanity/cli/src/cli.ts

Lines 50 to 56 in f9c67ea

	let workDir: string | undefined
	try {
	workDir = isInit ? process.cwd() : resolveRootDir(cwd)
	} catch (err) {
	console.error(chalk.red(err.message))
	process.exit(1)
	}

(Although it doesn't warn you)

[juice49]

@rexxars I stumbled upon this code during my work, and was a little confused because it doesn't seem to do anything. From the looks of the code, the CLI should infer the project root automatically. It should also warn the user this inference has occurred.

In my testing, neither of these things happened. Only now have I realised why: the project root resolution code looks for studio.config.{ts,js} files, rather than sanity.config.{ts,js}. Therefore, it never finds the project root.

It's probably best to fix this behaviour and scrap my other changes.