feat: add app resources to sanity.cli.ts by ryanbonial · Pull Request #878 · sanity-io/cli

ryanbonial · 2026-04-02T22:00:26Z

Description

This PR adds CLI config support for named app resources and updates app scaffolding to generate those resources by default.

It introduces app.resources to the CLI config types and schema, exports the related resource types from @sanity/cli-core, and updates createAppCliConfig() / bootstrapLocalTemplate() so newly scaffolded apps emit a resources.default entry with the selected projectId and dataset. This creates a shared config foundation for the later SDK v3 runtime work.

What to review

Review the new app.resources type surface in @sanity/cli-core
Confirm the schema accepts the supported resource shapes:
- dataset resource
- media library resource
- canvas resource
Review the app init/template changes to ensure scaffolded sanity.cli.ts files now include:
- app.resources.default.projectId
- app.resources.default.dataset
Check that the exported types from @sanity/cli-core are the right public API for follow-up work

Testing

Added schema parsing tests for all supported app.resources variants
Added init template tests covering:
- default app resource generation
- allowing empty projectId / dataset values to flow through the template processor
Ran:
- pnpm test packages/@sanity/cli-core/src/config/cli/__tests__/schemas.test.ts packages/@sanity/cli/src/actions/init/__tests__/createAppCliConfig.test.ts

Note

Medium Risk
Introduces a new public config surface (app.resources) and changes app project scaffolding output, which could affect downstream consumers and generated config expectations. Scope is limited to config typing/validation and init template generation.

Overview
Adds named app resources support via app.resources in sanity.cli.*, including a new AppResource type and Zod schema validation for {projectId, dataset} resource entries.

Updates app initialization scaffolding so createAppCliConfig() emits a resources.default block only when both projectId and dataset are available, and wires those variables through bootstrapLocalTemplate(). Adds targeted tests for schema acceptance/rejection and for template selection behavior.

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

claude · 2026-04-02T22:00:41Z

Claude finished @cngonzalez's task in 2m 1s —— View job

Review

Gather context
Read changed files
Analyze for issues
Post review

Changeset description is too vague

.changeset/pr-878.md says "add app resources to sanity.cli.ts" — this doesn't tell a developer what actually changed for them. Suggested: "Scaffolded app sanity.cli.ts now includes a resources.default entry with the selected project and dataset when both are provided during init."

Schema allows empty strings for required resource fields

schemas.ts lines 27-30 use z.string() for both dataset and projectId, which accepts ''. This is inconsistent with hasResources() in createAppCliConfig.ts (line 40), which treats empty strings as falsy and skips the resource block. A user who manually writes resources: {default: {projectId: '', dataset: ''}} in their config would pass schema validation but produce a resource entry with no useful values.

Fix: add .min(1) validation.

z.object({
  dataset: z.string().min(1),
  projectId: z.string().min(1),
})

Fix this →

Schema test name is misleading

schemas.test.ts line 24: 'rejects unknown resource shapes' — the key name bad is not what's being rejected; any string key is valid per z.record(z.string(), ...). What's rejected is the value {} missing dataset/projectId. The test should be named 'rejects resources missing required fields' to avoid implying key names are constrained.

`AppResource` type name will likely cause confusion

AppResource is exported with only {dataset: string, projectId: string}, but the name implies it could represent any resource type (media library, canvas, etc.). Since only dataset resources are supported right now, naming it DatasetResource would be more precise and avoids the need to introduce a union type later when other resource shapes are added. This is marked @beta, so a rename is still low-cost.

github-actions · 2026-04-02T22:00:59Z

📦 Bundle Stats — `@sanity/cli`

Compared against main (2fd358fc)

`@sanity/cli`

Metric	Value	vs main (`2fd358f`)
Internal (raw)	2.1 KB	-
Internal (gzip)	799 B	-
Bundled (raw)	10.95 MB	+5.9 KB, +0.1%
Bundled (gzip)	2.05 MB	+1014 B, +0.0%
Import time	822ms	+3ms, +0.4%

`bin:sanity`

Metric	Value	vs main (`2fd358f`)
Internal (raw)	975 B	-
Internal (gzip)	460 B	-
Bundled (raw)	9.84 MB	-
Bundled (gzip)	1.77 MB	-
Import time	1.93s	-0ms, -0.0%

🗺️ 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 (2fd358fc)

Metric	Value	vs main (`2fd358f`)
Internal (raw)	93.2 KB	-562 B, -0.6%
Internal (gzip)	21.9 KB	-7 B, -0.0%
Bundled (raw)	21.62 MB	-568 B, -0.0%
Bundled (gzip)	3.42 MB	-61 B, -0.0%
Import time	782ms	+4ms, +0.5%

🗺️ 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 (2fd358fc)

Metric	Value	vs main (`2fd358f`)
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.

github-actions · 2026-04-02T22:11:40Z

Coverage Delta

File	Statements
packages/@sanity/cli-core/src/config/cli/schemas.ts	100.0% (±0%)
packages/@sanity/cli/src/actions/init/bootstrapLocalTemplate.ts	89.7% (±0%)
packages/@sanity/cli/src/actions/init/createAppCliConfig.ts	100.0% (±0%)

Comparing 3 changed files against main @ 2fd358fc52ed3e2c3b89e45796e4a6044e03cd4c

Overall Coverage

Metric	Coverage
Statements	84.0% (±0%)
Branches	73.7% (+ 0.0%)
Functions	83.9% (+ 0.0%)
Lines	84.4% (±0%)

cngonzalez

functionally looks good -- most of my comments are just pedantic. Let me know what you think!

ryanbonial · 2026-04-08T19:12:32Z

@cngonzalez great suggestions, ready for review again

cngonzalez · 2026-04-09T18:19:43Z

feat: add app resources to sanity.cli.ts #878 : 2 dependent PRs (#912 , #961 ) 👈 (View in Graphite)
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

…validation - Introduced two app templates: one with resources and one without - Updated the createAppCliConfig function to select the appropriate template. - removing support for media library and canvas resources.

ryanbonial requested a review from a team as a code owner April 2, 2026 22:00

ryanbonial requested review from cngonzalez and removed request for a team April 2, 2026 22:00

cngonzalez changed the title ~~SDK app resources (base)~~ feat: add app resources to sanity.cli.ts Apr 7, 2026

cngonzalez requested changes Apr 8, 2026

View reviewed changes

ryanbonial requested a review from cngonzalez April 8, 2026 19:12

cngonzalez previously approved these changes Apr 8, 2026

View reviewed changes

This was referenced Apr 9, 2026

feat: use vite plugin for resources and types #912

Closed

feat: create runtime resources #961

Closed

cngonzalez force-pushed the stack/sdk-711-app-resources-base branch from 7a6ae95 to 21fbd90 Compare April 15, 2026 20:55

squiggler-app Bot added a commit that referenced this pull request Apr 15, 2026

chore: update auto-generated changeset for PR #878

74b974e

squiggler-app Bot dismissed cngonzalez’s stale review via 74b974e April 15, 2026 20:56

cngonzalez force-pushed the stack/sdk-711-app-resources-base branch 4 times, most recently from 1293c23 to 0669398 Compare April 16, 2026 20:20

ryanbonial and others added 4 commits April 22, 2026 12:24

fix(cli): scaffold app resources and support SDK v3 named resources

a0e144d

fix: scaffold app resources for SDK v3

091d7a4

chore: update auto-generated changeset for PR #878

5c73dc9

cngonzalez force-pushed the stack/sdk-711-app-resources-base branch from 0669398 to 5c73dc9 Compare April 22, 2026 16:25

ryanbonial mentioned this pull request Apr 22, 2026

feat(core): send _origin, _sdkVersion, _appId on SDK API requests sanity-io/sdk#809

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add app resources to sanity.cli.ts#878

feat: add app resources to sanity.cli.ts#878
ryanbonial wants to merge 4 commits intomainfrom
stack/sdk-711-app-resources-base

ryanbonial commented Apr 2, 2026 •

edited by cursor Bot

Loading

Uh oh!

claude Bot commented Apr 2, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 2, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 2, 2026 •

edited

Loading

Uh oh!

cngonzalez left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryanbonial commented Apr 8, 2026

Uh oh!

cngonzalez commented Apr 9, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

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

Uh oh!

Description

What to review

Testing

Uh oh!

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

Uh oh!

Review

Changeset description is too vague

Schema allows empty strings for required resource fields

Schema test name is misleading

AppResource type name will likely cause confusion

Uh oh!

github-actions Bot commented Apr 2, 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!

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

Uh oh!

Coverage Delta

Overall Coverage

Uh oh!

cngonzalez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryanbonial commented Apr 8, 2026

Uh oh!

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

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ryanbonial commented Apr 2, 2026 •

edited by cursor Bot

Loading

claude Bot commented Apr 2, 2026 •

edited

Loading

`AppResource` type name will likely cause confusion

github-actions Bot commented Apr 2, 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 2, 2026 •

edited

Loading

cngonzalez commented Apr 9, 2026 •

edited

Loading