feat: introduce reading resources in app template by cngonzalez · Pull Request #255 · sanity-io/cli

cngonzalez · 2026-01-06T20:24:24Z

Description

This PR adds support for configuring data sources in Sanity apps. It introduces a new sources property in the CLI config that allows apps to specify project IDs and datasets they need to access. The runtime now automatically passes these sources to the app, eliminating the need for manual configuration in the App component.

What to review

The new sources schema in the CLI config
The updated app entry module that passes sources to renderSanityApp
The removal of manual SanityApp configuration in the basic-app example
The updated CLI build process that extracts sources from the config

Testing

The changes have been tested with the basic-app example, which now uses a real organization ID and project/dataset configuration. The example app has been updated to use the latest SDK packages from PR #704.

linear · 2026-01-06T20:24:28Z

SDK-711 Use `renderSanitySDKApp` in CLI, reading config from `sanity.cli.ts`

claude · 2026-01-06T20:24:39Z

Claude finished @ryanbonial's task in 2m 35s —— View job

Code Review

Gather context
Read changed files
Provide review feedback

1. RC version pinning — blocker

packages/@sanity/cli/src/actions/init/sdkAppDependencies.ts:4-5

@sanity/sdk and @sanity/sdk-react are pinned to ^3.0.0-rc.0. The TODO comment acknowledges this. Already flagged by @ryanbonial — do not merge until SDK v3 is officially published and these are updated to latest.

2. Silent error swallowing for getCliConfig

packages/@sanity/cli/src/actions/build/writeSanityRuntime.ts:86-91

try {
  const cliConfig = await getCliConfig(cwd)
  appResources = cliConfig.app?.resources
} catch (err) {
  buildDebug('Failed to load CLI config for app resources: %s', err)
}

If getCliConfig fails (e.g., malformed sanity.cli.ts), the error is only logged at debug level. The app will silently build with an empty resources object and users will have no indication why their data sources aren't available. At minimum, use output?.warn(...) here if output is available.

3. getCliConfig called redundantly alongside findAppConfigPath

packages/@sanity/cli/src/actions/build/writeSanityRuntime.ts:81-91

Both findAppConfigPath(cwd) (to resolve the config file path for the runtime module) and getCliConfig(cwd) (to extract resources) are called independently. This means the config file is parsed twice per build/dev start. The result from getCliConfig should be reused to derive the config path rather than making two separate calls.

4. createAppCliConfig test mocks the entire processTemplate

packages/@sanity/cli/src/actions/init/__tests__/createAppCliConfig.test.ts:3-7

processTemplate is fully mocked, so neither test verifies the actual generated config output. If projectId or dataset are undefined (as in the first test case), the real processTemplate would produce a config with empty strings for those fields — valid TypeScript but incorrect runtime behavior. An integration test verifying the real template output would catch regressions here.

Fix this →

5. fixtures/basic-app/sanity.cli.ts contains a real-looking project ID

fixtures/basic-app/sanity.cli.ts:9

projectId: 'ppsg7ml5' looks like a real Sanity project ID. Even in a fixture, hardcoding real project identifiers in a public repo is worth double-checking — confirm this is intentional and the project has appropriate access controls.

github-actions · 2026-01-06T20:27:58Z

Coverage Delta

File	Statements
packages/@sanity/cli-core/src/config/cli/schemas.ts	100.0% (±0%)
packages/@sanity/cli/src/actions/build/buildApp.ts	94.9% (±0%)
packages/@sanity/cli/src/actions/build/buildStaticFiles.ts	96.5% (±0%)
packages/@sanity/cli/src/actions/build/buildStudio.ts	97.5% (±0%)
packages/@sanity/cli/src/actions/build/detectLegacySanityApp.ts	95.2% (new)
packages/@sanity/cli/src/actions/build/getEntryModule.ts	100.0% (±0%)
packages/@sanity/cli/src/actions/build/writeSanityRuntime.ts	96.9% (+ 1.6%)
packages/@sanity/cli/src/actions/dev/startAppDevServer.ts	86.4% (±0%)
packages/@sanity/cli/src/actions/dev/startStudioDevServer.ts	95.0% (±0%)
packages/@sanity/cli/src/actions/init/bootstrapLocalTemplate.ts	1.9% (±0%)
packages/@sanity/cli/src/actions/init/createAppCliConfig.ts	100.0% (+ 50.0%)
packages/@sanity/cli/src/actions/init/sdkAppDependencies.ts	100.0% (±0%)
packages/@sanity/cli/src/server/devServer.ts	94.1% (±0%)

Comparing 13 changed files against main @ 2b251ff9612410efce4c13e3cc1c3f37f3a6a498

Overall Coverage

Metric	Coverage
Statements	81.4% (+ 0.1%)
Branches	69.8% (+ 0.1%)
Functions	79.4% (+ 0.1%)
Lines	81.8% (+ 0.1%)

binoy14 · 2026-02-02T17:47:29Z

@cngonzalez what's the status of this? Could this be converted to draft if not ready?

The CLI now uses renderSanityApp from @sanity/sdk-react in the auto-generated app.js entry module, instead of relying on the user's App.tsx to contain a SanityApp context provider. Named resources (project/dataset pairs) are read from sanity.cli.ts and passed to renderSanityApp at build/dev time. Renames the CLI config property sources → resources (and AppSource → AppResource) to align with SDK v3 terminology. Also exports findAppConfigPath from @sanity/cli-core for use in the build pipeline. Made-with: Cursor

Adds static analysis to detect when a user's App.tsx still uses the legacy <SanityApp> component pattern from @sanity/sdk-react v2. If detected, the CLI emits a deprecation warning with migration instructions during build and dev. The output object is threaded through the build and dev server call chains (buildApp, buildStudio, buildStaticFiles, devServer, startAppDevServer, startStudioDevServer) so the warning uses the CLI's standard output.warn() mechanism rather than console.warn. Made-with: Cursor

App templates no longer wrap their root component with <SanityApp>. The CLI's generated entry module now handles this via renderSanityApp, so user code stays clean and framework-agnostic. Made-with: Cursor

- Upgrade @sanity/sdk-react to ^3.0.0-rc.0 - Rename sources → resources in sanity.cli.ts - Remove stale SanityApp import from App.tsx - Set organizationId to match dev.test.ts expectation - Ignore test fixture files from knip Made-with: Cursor

socket-security · 2026-03-11T20:16:27Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	npm/@sanity/sdk@2.6.0 ⏵ 3.0.0-rc.0	⁺¹			⁺³
	npm/@sanity/sdk-react@2.6.0 ⏵ 3.0.0-rc.0	⁺¹			⁺³

View full report

ryanbonial · 2026-03-11T21:23:21Z

packages/@sanity/cli/src/actions/init/sdkAppDependencies.ts

-    // change these to 'latest' as in studioDependencies.ts once SDK v3 is released
-    '@sanity/sdk': '^2',
-    '@sanity/sdk-react': '^2',
+    // TODO: change these to 'latest' once SDK v3 is published


Don't merge this PR until SDK v3 is officially out and we change all of the 3.0.0-rc.0 references in this PR

ryanbonial marked this pull request as ready for review January 12, 2026 17:36

ryanbonial requested a review from a team as a code owner January 12, 2026 17:36

ryanbonial requested review from mttdnt and removed request for a team January 12, 2026 17:36

ryanbonial changed the title ~~feat: introduce reading sources in app template~~ feat: introduce reading resources in app template Mar 9, 2026

ryanbonial added 3 commits March 11, 2026 09:36

feat(cli): remove SanityApp wrapper from app templates

789c4e0

App templates no longer wrap their root component with <SanityApp>. The CLI's generated entry module now handles this via renderSanityApp, so user code stays clean and framework-agnostic. Made-with: Cursor

ryanbonial force-pushed the feat/sdk-711/use-rendersanityapp branch 3 times, most recently from 7b4cda9 to f304343 Compare March 11, 2026 15:48

ryanbonial marked this pull request as draft March 11, 2026 15:51

ryanbonial force-pushed the feat/sdk-711/use-rendersanityapp branch from f304343 to d423392 Compare March 11, 2026 17:52

ryanbonial and others added 2 commits March 11, 2026 12:05

Merge branch 'main' into feat/sdk-711/use-rendersanityapp

6af1363

chore: upgrade @sanity/sdk and @sanity/sdk-react to ^3.0.0-rc.0

1a712c9

ryanbonial added 3 commits March 11, 2026 14:19

fix(cli): pass correct entry path to detectLegacySanityApp

d5bf2bb

fix: review feedback

5f6cd08

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

98edbeb

ryanbonial reviewed Mar 11, 2026

View reviewed changes

ryanbonial added 3 commits March 11, 2026 15:27

Merge branch 'main' into feat/sdk-711/use-rendersanityapp

a87fdc7

fix: lock file

a055dda

fix: scaffold app resources for SDK v3

edcfa22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: introduce reading resources in app template#255

feat: introduce reading resources in app template#255
cngonzalez wants to merge 12 commits intomainfrom
feat/sdk-711/use-rendersanityapp

cngonzalez commented Jan 6, 2026 •

edited by ryanbonial

Loading

Uh oh!

linear bot commented Jan 6, 2026

Uh oh!

claude bot commented Jan 6, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 6, 2026 •

edited

Loading

Uh oh!

binoy14 commented Feb 2, 2026

Uh oh!

socket-security bot commented Mar 11, 2026 •

edited

Loading

Uh oh!

ryanbonial Mar 11, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

cngonzalez commented Jan 6, 2026 • edited by ryanbonial Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

What to review

Testing

Uh oh!

linear bot commented Jan 6, 2026

Uh oh!

claude bot commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review

Uh oh!

github-actions bot commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Delta

Overall Coverage

Uh oh!

binoy14 commented Feb 2, 2026

Uh oh!

socket-security bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ryanbonial Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cngonzalez commented Jan 6, 2026 •

edited by ryanbonial

Loading

claude bot commented Jan 6, 2026 •

edited

Loading

github-actions bot commented Jan 6, 2026 •

edited

Loading

socket-security bot commented Mar 11, 2026 •

edited

Loading

ryanbonial Mar 11, 2026 •

edited

Loading