@sanity/runtime-cli 15.1.1 → 15.1.2

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @sanity/runtime-cli
 $ sanity-run COMMAND
 running command...
 $ sanity-run (--version)
-@sanity/runtime-cli/15.1.1 linux-x64 node-v24.15.0
+@sanity/runtime-cli/15.1.2 linux-x64 node-v24.15.0
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -103,7 +103,7 @@ EXAMPLES
   $ sanity-run blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -140,7 +140,7 @@ EXAMPLES
   $ sanity-run blueprints config --edit --project-id <projectId> --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -191,7 +191,7 @@ EXAMPLES
   $ sanity-run blueprints deploy --new-stack-name <new-name>
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -226,7 +226,7 @@ EXAMPLES
   $ sanity-run blueprints destroy --stack <name-or-id> --project-id <projectId> --force --no-wait
 ```
 
-_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints doctor`
 
@@ -257,7 +257,7 @@ EXAMPLES
   $ sanity-run blueprints doctor --fix
 ```
 
-_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/doctor.ts)_
+_See code: [src/commands/blueprints/doctor.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/doctor.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -294,7 +294,7 @@ EXAMPLES
   $ sanity-run blueprints info --organization-id <orgId> --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -353,7 +353,7 @@ EXAMPLES
   $ sanity-run blueprints init old-stack --type <json|js|ts> --project-id <projectId> --stack-id <existingStackId>
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -399,7 +399,7 @@ EXAMPLES
   $ sanity-run blueprints logs --before 2026-05-01T00:00:00Z
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints mint-deploy-token`
 
@@ -444,7 +444,7 @@ EXAMPLES
   $ sanity-run blueprints mint-deploy-token --organization-id <orgId>
 ```
 
-_See code: [src/commands/blueprints/mint-deploy-token.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/mint-deploy-token.ts)_
+_See code: [src/commands/blueprints/mint-deploy-token.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/mint-deploy-token.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -477,7 +477,7 @@ EXAMPLES
   $ sanity-run blueprints plan --organization-id <orgId> --stack <name-or-id>
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints promote`
 
@@ -513,7 +513,7 @@ EXAMPLES
   $ sanity-run blueprints promote --new-stack-name <new-name>
 ```
 
-_See code: [src/commands/blueprints/promote.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/promote.ts)_
+_See code: [src/commands/blueprints/promote.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/promote.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -549,7 +549,7 @@ EXAMPLES
   $ sanity-run blueprints stacks --organization-id <organizationId> --include-projects
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions add`
 
@@ -601,7 +601,7 @@ EXAMPLES
   $ sanity-run functions add --name my-function --type document-create --type document-update --lang js
 ```
 
-_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/functions/add.ts)_
+_See code: [src/commands/functions/add.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/functions/add.ts)_
 
 ## `sanity-run functions dev`
 
@@ -636,7 +636,7 @@ EXAMPLES
   $ sanity-run functions dev --timeout 60
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -666,7 +666,7 @@ EXAMPLES
   $ sanity-run functions env add MyFunction API_URL https://api.example.com/
 ```
 
-_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -693,7 +693,7 @@ EXAMPLES
   $ sanity-run functions env list MyFunction
 ```
 
-_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -722,7 +722,7 @@ EXAMPLES
   $ sanity-run functions env remove MyFunction API_URL
 ```
 
-_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs [NAME]`
 
@@ -762,7 +762,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test [NAME]`
 
@@ -819,7 +819,7 @@ EXAMPLES
   $ sanity-run functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
 ```
 
-_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.1/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v15.1.2/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/baseCommands.d.ts

@@ -2,6 +2,7 @@ import type { Interfaces } from '@oclif/core';
 import { Command } from '@oclif/core';
 import { type ReadBlueprintResult } from './actions/blueprints/blueprint.js';
 import type { CoreResult } from './cores/index.js';
+import type { Warning } from './utils/blueprints/warnings.js';
 import type { AuthParams, ScopeType, Stack } from './utils/types.js';
 export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof RuntimeCommand)['baseFlags'] & T['flags']>;
 export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
@@ -63,6 +64,10 @@ export declare abstract class RuntimeCommand<T extends typeof Command> extends C
     protected coreError(result: CoreResult & {
         success: false;
     }): never;
+    /**
+     * Renders any actionable items the user can take that don't warrant throwing an error.
+     */
+    protected renderWarnings(warnings: Warning[]): void;
     /**
      * If an error doesn't have suggestions, match against known patterns to
      * attach relevant suggestions before oclif renders the error.

package/dist/baseCommands.js

@@ -6,6 +6,7 @@ import { resolveIds } from './actions/blueprints/resolve.js';
 import { getStack, resolveStackIdByNameOrId } from './actions/blueprints/stacks.js';
 import { presentBlueprintParserErrors } from './utils/display/errors.js';
 import { Logger } from './utils/logger.js';
+import { styleText } from './utils/style-text.js';
 import { validTokenOrErrorMessage } from './utils/validated-token.js';
 /**
  * Fallback error-to-hint patterns for RuntimeCommand.catch().
@@ -137,6 +138,22 @@ export class RuntimeCommand extends Command {
             code: result.code,
         });
     }
+    /**
+     * Renders any actionable items the user can take that don't warrant throwing an error.
+     */
+    renderWarnings(warnings) {
+        if (!warnings.length)
+            return;
+        this.log('');
+        this.log(styleText(['bold', 'yellow'], 'Suggestions'));
+        this.log('');
+        for (const entry of warnings) {
+            entry.suggestions.forEach((sug) => {
+                this.log(` ${styleText('dim', sug)}`);
+            });
+            this.log('');
+        }
+    }
     /**
      * If an error doesn't have suggestions, match against known patterns to
      * attach relevant suggestions before oclif renders the error.

package/dist/commands/blueprints/doctor.js

@@ -36,6 +36,8 @@ Run this command when encountering errors with other Blueprint commands. Use --f
         });
         if (!result.success)
             this.coreError(result);
+        if (result.warnings)
+            this.renderWarnings(result?.warnings);
         return result.json;
     }
 }

package/dist/cores/blueprints/doctor.js

@@ -1,4 +1,5 @@
 import { readFileSync } from 'node:fs';
+import { dirname } from 'node:path';
 import { arch, cwd, env, version as nodeVersion, platform } from 'node:process';
 import * as resolve from 'empathic/resolve';
 import ora from 'ora';
@@ -7,8 +8,9 @@ import { readConfigFile } from '../../actions/blueprints/config.js';
 import { resolveIds } from '../../actions/blueprints/resolve.js';
 import { getStack } from '../../actions/blueprints/stacks.js';
 import config, { RUNTIME_CLI_VERSION } from '../../config.js';
+import { getWarnings } from '../../utils/blueprints/warnings.js';
 import { formatDateTime } from '../../utils/display/dates.js';
-import { check, filePathRelativeToCwd, niceId, renderSection, severe, unsure, } from '../../utils/display/presenters.js';
+import { advise, check, filePathRelativeToCwd, niceId, renderSection, severe, unsure, } from '../../utils/display/presenters.js';
 import { styleText } from '../../utils/style-text.js';
 import { createTracedFetch } from '../../utils/traced-fetch.js';
 import { validTokenOrErrorMessage } from '../../utils/validated-token.js';
@@ -20,6 +22,9 @@ const diagLookup = {
     stackReady: 'Stack ready',
     userHasAccess: 'User has access',
 };
+const warnLookup = {
+    projectLayout: 'Project layout',
+};
 function sourceLabel(source) {
     switch (source) {
         case 'env':
@@ -42,6 +47,7 @@ export async function blueprintDoctorCore(options) {
     for (const key in diagLookup) {
         diagnostics[key] = { status: null };
     }
+    const warningDiagnostics = {};
     const envRows = [['Directory', p ? filePathRelativeToCwd(path) : path]];
     if (bin && bin !== 'sanity')
         envRows.push(['CLI', bin]);
@@ -234,6 +240,21 @@ export async function blueprintDoctorCore(options) {
             diagnostics.userHasAccess = { status: null, detail };
         }
     }
+    for (const key in warnLookup) {
+        warningDiagnostics[key] = { status: null };
+    }
+    // LAYOUT ISSUES; IE Functions in Studio
+    let layoutWarnings = [];
+    if (localBlueprint) {
+        const blueprintDir = dirname(localBlueprint.fileInfo.blueprintFilePath || '.');
+        layoutWarnings = getWarnings({ dir: blueprintDir });
+        if (layoutWarnings.length) {
+            warningDiagnostics.projectLayout = {
+                status: true,
+                detail: 'Blueprint config in the Studio dir',
+            };
+        }
+    }
     // --- RENDER REPORT ---
     spinner.stop();
     // Environment (verbose)
@@ -270,6 +291,20 @@ export async function blueprintDoctorCore(options) {
                 break;
         }
     }
+    let hasWarnings = false;
+    if (Object.values(warningDiagnostics).some((entry) => entry.status === true)) {
+        hasWarnings = true;
+        const maxLabel = Math.max(...Object.values(warnLookup).map((l) => l.length));
+        log(styleText('bold', 'Warnings'));
+        for (const [key, entry] of Object.entries(warningDiagnostics)) {
+            if (entry.status) {
+                const label = warnLookup[key].padEnd(maxLabel);
+                const detail = entry.detail ? `  ${styleText('dim', entry.detail)}` : '';
+                log(`  ${advise(label)}${detail}`);
+            }
+        }
+        log('');
+    }
     // Result
     const flatDiagnostics = {};
     for (const [key, entry] of Object.entries(diagnostics)) {
@@ -285,6 +320,7 @@ export async function blueprintDoctorCore(options) {
             success: true,
             json: { diagnostics: flatDiagnostics },
             data: { diagnostics: flatDiagnostics },
+            warnings: hasWarnings ? layoutWarnings : undefined,
         };
     }
     if (fix) {
@@ -319,7 +355,7 @@ export async function blueprintDoctorCore(options) {
                 data: { diagnostics: flatDiagnostics },
             };
         }
-        return blueprintConfigCore({
+        const fixResult = await blueprintConfigCore({
             bin,
             log,
             token: tokenOrError.value,
@@ -327,6 +363,10 @@ export async function blueprintDoctorCore(options) {
             validateResources,
             flags: { edit: true, verbose: v },
         });
+        if (fixResult.success) {
+            return { ...fixResult, warnings: hasWarnings ? layoutWarnings : undefined };
+        }
+        return fixResult;
     }
     return {
         success: false,

package/dist/cores/index.d.ts

@@ -1,4 +1,5 @@
 import { type ReadBlueprintResult } from '../actions/blueprints/blueprint.js';
+import type { Warning } from '../utils/blueprints/warnings.js';
 import type { Logger } from '../utils/logger.js';
 import type { AuthParams, Result, ScopeType, Stack } from '../utils/types.js';
 export interface CoreConfig {
@@ -52,6 +53,10 @@ export type CoreResult = {
      * Commands should return this value from `run()` for oclif to serialize.
      */
     json?: Record<string, unknown>;
+    /**
+     * Actionable items displayed to the user that we don't error out on.
+     */
+    warnings?: Warning[];
 });
 type InitBlueprintConfigParams = CoreConfig & ({
     validateToken: true;

package/dist/utils/blueprints/warnings.d.ts

@@ -0,0 +1,19 @@
+export type Warning = {
+    label: string;
+    suggestions: string[];
+};
+export type WarningContext = {
+    dir: string;
+};
+export type WarningEntryCheck = {
+    label: string;
+    suggestions: string[];
+    check: (ctx: WarningContext) => boolean;
+};
+/**
+ * Checks if the given directory contains files Sanity Studio specific files.
+ * Directory is either the cwd where `init` is run or during the `doctor` command
+ */
+export declare const isStudioDir: (filePath: string) => boolean;
+export declare const warningCheck: WarningEntryCheck[];
+export declare const getWarnings: (ctx: WarningContext) => Warning[];

package/dist/utils/blueprints/warnings.js

@@ -0,0 +1,36 @@
+import { readdirSync } from 'node:fs';
+import { resolve } from 'node:path';
+/**
+ * Checks if the given directory contains files Sanity Studio specific files.
+ * Directory is either the cwd where `init` is run or during the `doctor` command
+ */
+export const isStudioDir = (filePath) => {
+    try {
+        const dir = resolve(filePath);
+        return readdirSync(dir, { withFileTypes: true }).some((entry) => {
+            if (entry.isFile()) {
+                return entry.name.startsWith('sanity.config') || entry.name.startsWith('sanity.cli');
+            }
+            return false;
+        });
+    }
+    catch (_err) {
+        return false;
+    }
+};
+export const warningCheck = [
+    {
+        label: 'Project layout',
+        suggestions: [
+            'A Blueprints file is co-located with a Sanity Studio. Please see the docs for better layout options',
+            // @todo: this will need to updated once the layout is published.
+            'https://www.sanity.io/docs/blueprints/blueprints-introduction#aaeea93bdd42',
+        ],
+        check: ({ dir }) => isStudioDir(dir),
+    },
+];
+export const getWarnings = (ctx) => {
+    return warningCheck
+        .filter(({ check }) => check(ctx))
+        .map(({ label, suggestions }) => ({ label, suggestions }));
+};

package/dist/utils/display/presenters.d.ts

@@ -1,6 +1,7 @@
 export declare function check(str: string): string;
 export declare function info(str: string): string;
 export declare function warn(str: string): string;
+export declare function advise(str: string): string;
 export declare function unsure(str: string): string;
 export declare function severe(str: string): string;
 export declare function niceId(id: string | undefined): string;

package/dist/utils/display/presenters.js

@@ -9,6 +9,9 @@ export function info(str) {
 export function warn(str) {
     return `${styleText(['bold', 'yellow'], '▶︎')} ${str}`;
 }
+export function advise(str) {
+    return `${styleText(['bold', 'yellow'], '!')} ${str}`;
+}
 export function unsure(str) {
     return `${styleText(['bold', 'cyan'], '?')} ${str}`;
 }

package/oclif.manifest.json

@@ -2998,5 +2998,5 @@
       ]
     }
   },
-  "version": "15.1.1"
+  "version": "15.1.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "15.1.1",
+  "version": "15.1.2",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",