refactor: rename manifest types and share cache dir by gu-stav · Pull Request #1008 · sanity-io/cli

gu-stav · 2026-04-23T12:09:46Z

Description

Pure refactoring:

share the Vite cacheDir using a new SANITY_CACHE_DIR constant, because we will need it in a 3rd place to avoid drift
rename AppManifest to CoreAppManifest to be more in-line with Brett, where SDK apps have type: coreApp

This will reduce the overall changes, introduced in #997, between feat/workbench and main

Note

Low Risk
Low risk refactor that centralizes Vite cache directory configuration and renames/validates the core app manifest type; main risk is unintended type/schema mismatch affecting app deploy manifest payloads.

Overview
Refactors cache directory configuration by introducing SANITY_CACHE_DIR and updating Vite cacheDir usage (including vendor builds and tests) to derive from this shared path.

Renames and tightens manifest typing by replacing AppManifest with CoreAppManifest, adding a zod-backed coreAppManifestSchema, and updating deploy/manifest extraction and deployment API typing to use the new validated manifest payload.

^{Reviewed by Cursor Bugbot for commit db62592. Bugbot is set up for automated code reviews on this repo. Configure here.}

claude · 2026-04-23T12:10:06Z

Claude finished @gu-stav's task in 2m 29s —— View job

Review

Gather context and read changed files
Review changes for issues
Post findings

1. Changeset should be removed

.changeset/upstream-cache-dir-and-manifest-rename.md is present but this is a pure internal refactor — no public API or runtime behavior changes for consumers. A patch bump for @sanity/cli is not warranted. (I was unable to push the deletion due to permissions — please remove manually.)

2. `version` field type widened to `z.string()`

packages/@sanity/cli/src/actions/manifest/types.ts:30

The original AppManifest interface constrained version to the literal '1'. The new zod schema uses z.string(), which accepts any string value. Change to z.literal('1') to preserve the original constraint:

// before
version: z.string(),

// after
version: z.literal('1'),

This is especially relevant now that extractAppManifest.ts calls coreAppManifestSchema.parse() — the schema should enforce the exact version value it expects.

Fix this →

3. Test assertion is tautological (minor)

packages/@sanity/cli/src/actions/build/__tests__/getViteConfig.test.ts:119

The test asserts cacheDir: \${SANITY_CACHE_DIR}/vite`using the same constant imported from production code. IfSANITY_CACHE_DIRwere accidentally set to a wrong value, both production and the test would use it and the test would still pass. The previous hardcoded'node_modules/.sanity/vite'` string provided independent verification. Not blocking, but worth considering.

github-actions · 2026-04-23T12:10:17Z

📦 Bundle Stats — `@sanity/cli`

Compared against main (37f95779)

`@sanity/cli`

Metric	Value	vs main (`37f9577`)
Internal (raw)	2.1 KB	-
Internal (gzip)	799 B	-
Bundled (raw)	10.94 MB	-
Bundled (gzip)	2.05 MB	-
Import time	750ms	+4ms, +0.5%

`bin:sanity`

Metric	Value	vs main (`37f9577`)
Internal (raw)	975 B	-
Internal (gzip)	460 B	-
Bundled (raw)	9.84 MB	-
Bundled (gzip)	1.77 MB	-
Import time	1.80s	+7ms, +0.4%

🗺️ View treemap · Artifacts

Details

Import time regressions over 10% are flagged with ⚠️
Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.

📦 Bundle Stats — `@sanity/cli-core`

Compared against main (37f95779)

Metric	Value	vs main (`37f9577`)
Internal (raw)	93.1 KB	-
Internal (gzip)	21.9 KB	-
Bundled (raw)	21.60 MB	-
Bundled (gzip)	3.42 MB	-
Import time	712ms	+4ms, +0.6%

🗺️ View treemap · Artifacts

Details

Import time regressions over 10% are flagged with ⚠️
Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.

📦 Bundle Stats — `create-sanity`

Compared against main (37f95779)

Metric	Value	vs main (`37f9577`)
Internal (raw)	976 B	-
Internal (gzip)	507 B	-
Bundled (raw)	50.7 KB	-
Bundled (gzip)	12.6 KB	-
Import time	❌ ChildProcess denied: node	-

Details

Import time regressions over 10% are flagged with ⚠️
Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.

cursor · 2026-04-23T12:12:18Z

+export const coreAppManifestSchema = z.object({
+  icon: z.optional(z.string()),
+  title: z.optional(z.string()),
+  version: z.string(),


Version field type widened from literal to string

Low Severity

The old AppManifest interface constrained version to the string literal '1', but the new coreAppManifestSchema uses z.string(), widening it to any string. This loses compile-time enforcement that version is exactly '1'. A z.literal('1') would preserve the original type safety while still using zod.

^{Reviewed by Cursor Bugbot for commit ad3ca35. Configure here.}

joshuaellis

I think it makes sense. Lets se what the rest of the team thinks.

github-actions · 2026-04-23T12:21:47Z

Coverage Delta

File	Statements
packages/@sanity/cli/src/actions/build/buildVendorDependencies.ts	67.4% (±0%)
packages/@sanity/cli/src/actions/build/getViteConfig.ts	100.0% (±0%)
packages/@sanity/cli/src/actions/deploy/deployApp.ts	80.5% (±0%)
packages/@sanity/cli/src/actions/manifest/extractAppManifest.ts	93.1% (±0%)
packages/@sanity/cli/src/actions/manifest/types.ts	100.0% (±0%)
packages/@sanity/cli/src/constants.ts	100.0% (new)
packages/@sanity/cli/src/services/userApplications.ts	92.8% (±0%)

Comparing 7 changed files against main @ 37f957796a99f7eff882d6ab0c36b25b4be39165

Overall Coverage

Metric	Coverage
Statements	84.2% (±0%)
Branches	74.1% (±0%)
Functions	84.0% (±0%)
Lines	84.6% (±0%)

binoy14

Looks good besides that

binoy14 · 2026-04-28T15:24:28Z

+'@sanity/cli': patch
+---
+
+Extract `SANITY_CACHE_DIR` constant for the shared Vite cache path and rename the internal `AppManifest` type to `CoreAppManifest` (with a zod schema) for consistency with the workbench payload.


Is the changeset necessary?

@claude remove the changeset

Claude finished @gu-stav's task in 28s —— View job

Changeset removed

Gather context

Delete .changeset/upstream-cache-dir-and-manifest-rename.md

Commit and push

Deleted the changeset file — it's not needed for this pure internal refactor (no public API or behavior changes).

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

There are 3 total unresolved issues (including 2 from previous reviews).

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit d1ea114. Configure here.}

cursor · 2026-05-05T11:30:01Z

        sourcemap: true,
      },
-      cacheDir: 'node_modules/.sanity/vite',
+      cacheDir: `${SANITY_CACHE_DIR}/vite`,


Test uses same constant as production code

Low Severity

The test assertion for cacheDir was changed from the hardcoded string 'node_modules/.sanity/vite' to use the same SANITY_CACHE_DIR constant that production code uses. This makes the assertion tautological for the constant's value — if SANITY_CACHE_DIR were accidentally set to an incorrect path, both the production code and the test would use the wrong value, and the test would still pass. The previous hardcoded string provided an independent verification of the expected path.

^{Reviewed by Cursor Bugbot for commit d1ea114. Configure here.}

gu-stav requested a review from a team as a code owner April 23, 2026 12:09

gu-stav requested review from binoy14, mttdnt and ryanbonial and removed request for a team and ryanbonial April 23, 2026 12:09

gu-stav mentioned this pull request Apr 23, 2026

feat(dev): extract manifests for local applications #997

Merged

cursor Bot reviewed Apr 23, 2026

View reviewed changes

gu-stav requested a review from joshuaellis April 23, 2026 12:12

joshuaellis previously approved these changes Apr 23, 2026

View reviewed changes

binoy14 reviewed Apr 28, 2026

View reviewed changes

squiggler-app Bot dismissed joshuaellis’s stale review via d1ea114 May 5, 2026 11:25

cursor Bot reviewed May 5, 2026

View reviewed changes

refactor: rename manifest types and share cache dir

d885116

gu-stav force-pushed the chore/upstream-cache-dir-and-manifest-rename branch from d1ea114 to d885116 Compare May 5, 2026 11:38

fix: fix

db62592

joshuaellis approved these changes May 5, 2026

View reviewed changes

gu-stav merged commit fa32892 into main May 5, 2026
55 checks passed

gu-stav deleted the chore/upstream-cache-dir-and-manifest-rename branch May 5, 2026 12:31

squiggler-app Bot mentioned this pull request May 5, 2026

chore: version packages #1048

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: rename manifest types and share cache dir#1008

refactor: rename manifest types and share cache dir#1008
gu-stav merged 2 commits intomainfrom
chore/upstream-cache-dir-and-manifest-rename

gu-stav commented Apr 23, 2026 •

edited by cursor Bot

Loading

Uh oh!

claude Bot commented Apr 23, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 23, 2026 •

edited

Loading

Uh oh!

cursor Bot Apr 23, 2026

Uh oh!

Uh oh!

joshuaellis left a comment

Uh oh!

github-actions Bot commented Apr 23, 2026 •

edited

Loading

Uh oh!

binoy14 left a comment

Uh oh!

binoy14 Apr 28, 2026

Uh oh!

gu-stav May 5, 2026

Uh oh!

squiggler-app Bot May 5, 2026 •

edited

Loading

Uh oh!

cursor Bot left a comment

Uh oh!

cursor Bot May 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

gu-stav commented Apr 23, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

claude Bot commented Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review

1. Changeset should be removed

2. version field type widened to z.string()

3. Test assertion is tautological (minor)

Uh oh!

github-actions Bot commented Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Bundle Stats — @sanity/cli

@sanity/cli

bin:sanity

📦 Bundle Stats — @sanity/cli-core

📦 Bundle Stats — create-sanity

Uh oh!

cursor Bot Apr 23, 2026

Choose a reason for hiding this comment

Version field type widened from literal to string

Uh oh!

Uh oh!

joshuaellis left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Delta

Overall Coverage

Uh oh!

binoy14 left a comment

Choose a reason for hiding this comment

Uh oh!

binoy14 Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

gu-stav May 5, 2026

Choose a reason for hiding this comment

Uh oh!

squiggler-app Bot May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Changeset removed

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor Bot May 5, 2026

Choose a reason for hiding this comment

Test uses same constant as production code

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gu-stav commented Apr 23, 2026 •

edited by cursor Bot

Loading

claude Bot commented Apr 23, 2026 •

edited

Loading

2. `version` field type widened to `z.string()`

github-actions Bot commented Apr 23, 2026 •

edited

Loading

📦 Bundle Stats — `@sanity/cli`

`@sanity/cli`

`bin:sanity`

📦 Bundle Stats — `@sanity/cli-core`

📦 Bundle Stats — `create-sanity`

github-actions Bot commented Apr 23, 2026 •

edited

Loading

squiggler-app Bot May 5, 2026 •

edited

Loading