@sanity/cli 5.1.1-next.6 → 6.0.0-alpha.3

package/dist/actions/documents/validate.js

@@ -0,0 +1,51 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { Worker } from 'node:worker_threads';
+import { readPackageUp } from 'read-package-up';
+import { createReceiver } from '../../util/workerChannels.js';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const defaultReporter = ({ dispose, stream })=>{
+    async function* createValidationGenerator() {
+        for await (const { documentId, documentType, level, markers, revision } of stream.validation()){
+            const result = {
+                documentId,
+                documentType,
+                level,
+                markers,
+                revision
+            };
+            yield result;
+        }
+        await dispose();
+    }
+    return createValidationGenerator();
+};
+export async function validateDocuments(options) {
+    const { clientConfig, dataset, level, maxCustomValidationConcurrency, maxFetchConcurrency, ndjsonFilePath, projectId, reporter = defaultReporter, workDir = process.cwd(), workspace } = options;
+    const rootPkgPath = (await readPackageUp({
+        cwd: __dirname
+    }))?.path;
+    if (!rootPkgPath) {
+        throw new Error('Could not find root directory for `sanity` package');
+    }
+    const workerPath = path.join(path.dirname(rootPkgPath), 'dist', 'threads', 'validateDocuments.js');
+    const worker = new Worker(workerPath, {
+        env: process.env,
+        workerData: {
+            // removes props in the config that make this object fail to serialize
+            clientConfig: structuredClone(clientConfig),
+            dataset,
+            level,
+            maxCustomValidationConcurrency,
+            maxFetchConcurrency,
+            ndjsonFilePath,
+            projectId,
+            studioHost: options.studioHost,
+            workDir,
+            workspace
+        }
+    });
+    return reporter(createReceiver(worker));
+}
+
+//# sourceMappingURL=validate.js.map

package/dist/actions/documents/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/documents/validate.ts"],"sourcesContent":["import path from 'node:path'\nimport {fileURLToPath} from 'node:url'\nimport {Worker} from 'node:worker_threads'\n\nimport {type ClientConfig} from '@sanity/client'\nimport {type ValidationMarker} from '@sanity/types'\nimport {readPackageUp} from 'read-package-up'\n\nimport {\n  type ValidateDocumentsWorkerData,\n  type ValidationWorkerChannel,\n} from '../../threads/validateDocuments.js'\nimport {createReceiver, type WorkerChannelReceiver} from '../../util/workerChannels.js'\nimport {Level} from './types.js'\n\nconst __dirname = path.dirname(fileURLToPath(import.meta.url))\n\ninterface ValidateDocumentsOptions<TReturn = unknown> {\n  clientConfig: ClientConfig\n\n  dataset?: string // override\n  level?: Level\n  maxCustomValidationConcurrency?: number\n  maxFetchConcurrency?: number\n  ndjsonFilePath?: string\n  projectId?: string // override\n  reporter?: (worker: WorkerChannelReceiver<ValidationWorkerChannel>) => TReturn\n  studioHost?: string\n  workDir?: string\n  workspace?: string\n}\n\ninterface DocumentValidationResult {\n  documentId: string\n  documentType: string\n  level: ValidationMarker['level']\n  markers: ValidationMarker[]\n  revision: string\n}\n\nconst defaultReporter = ({dispose, stream}: WorkerChannelReceiver<ValidationWorkerChannel>) => {\n  async function* createValidationGenerator() {\n    for await (const {documentId, documentType, level, markers, revision} of stream.validation()) {\n      const result: DocumentValidationResult = {\n        documentId,\n        documentType,\n        level,\n        markers,\n        revision,\n      }\n\n      yield result\n    }\n\n    await dispose()\n  }\n\n  return createValidationGenerator()\n}\n\nexport function validateDocuments<TReturn>(\n  options: Required<Pick<ValidateDocumentsOptions<TReturn>, 'reporter'>> &\n    ValidateDocumentsOptions<TReturn>,\n): Promise<TReturn>\nexport function validateDocuments(\n  options: ValidateDocumentsOptions,\n): Promise<AsyncIterable<DocumentValidationResult>>\nexport async function validateDocuments(options: ValidateDocumentsOptions): Promise<unknown> {\n  const {\n    clientConfig,\n    dataset,\n    level,\n    maxCustomValidationConcurrency,\n    maxFetchConcurrency,\n    ndjsonFilePath,\n    projectId,\n    reporter = defaultReporter,\n    workDir = process.cwd(),\n    workspace,\n  } = options\n\n  const rootPkgPath = (await readPackageUp({cwd: __dirname}))?.path\n\n  if (!rootPkgPath) {\n    throw new Error('Could not find root directory for `sanity` package')\n  }\n\n  const workerPath = path.join(path.dirname(rootPkgPath), 'dist', 'threads', 'validateDocuments.js')\n\n  const worker = new Worker(workerPath, {\n    env: process.env,\n    workerData: {\n      // removes props in the config that make this object fail to serialize\n      clientConfig: structuredClone(clientConfig),\n      dataset,\n      level,\n      maxCustomValidationConcurrency,\n      maxFetchConcurrency,\n      ndjsonFilePath,\n      projectId,\n      studioHost: options.studioHost,\n      workDir,\n      workspace,\n    } satisfies ValidateDocumentsWorkerData,\n  })\n\n  return reporter(createReceiver<ValidationWorkerChannel>(worker))\n}\n"],"names":["path","fileURLToPath","Worker","readPackageUp","createReceiver","__dirname","dirname","url","defaultReporter","dispose","stream","createValidationGenerator","documentId","documentType","level","markers","revision","validation","result","validateDocuments","options","clientConfig","dataset","maxCustomValidationConcurrency","maxFetchConcurrency","ndjsonFilePath","projectId","reporter","workDir","process","cwd","workspace","rootPkgPath","Error","workerPath","join","worker","env","workerData","structuredClone","studioHost"],"mappings":"AAAA,OAAOA,UAAU,YAAW;AAC5B,SAAQC,aAAa,QAAO,WAAU;AACtC,SAAQC,MAAM,QAAO,sBAAqB;AAI1C,SAAQC,aAAa,QAAO,kBAAiB;AAM7C,SAAQC,cAAc,QAAmC,+BAA8B;AAGvF,MAAMC,YAAYL,KAAKM,OAAO,CAACL,cAAc,YAAYM,GAAG;AAyB5D,MAAMC,kBAAkB,CAAC,EAACC,OAAO,EAAEC,MAAM,EAAiD;IACxF,gBAAgBC;QACd,WAAW,MAAM,EAACC,UAAU,EAAEC,YAAY,EAAEC,KAAK,EAAEC,OAAO,EAAEC,QAAQ,EAAC,IAAIN,OAAOO,UAAU,GAAI;YAC5F,MAAMC,SAAmC;gBACvCN;gBACAC;gBACAC;gBACAC;gBACAC;YACF;YAEA,MAAME;QACR;QAEA,MAAMT;IACR;IAEA,OAAOE;AACT;AASA,OAAO,eAAeQ,kBAAkBC,OAAiC;IACvE,MAAM,EACJC,YAAY,EACZC,OAAO,EACPR,KAAK,EACLS,8BAA8B,EAC9BC,mBAAmB,EACnBC,cAAc,EACdC,SAAS,EACTC,WAAWnB,eAAe,EAC1BoB,UAAUC,QAAQC,GAAG,EAAE,EACvBC,SAAS,EACV,GAAGX;IAEJ,MAAMY,cAAe,CAAA,MAAM7B,cAAc;QAAC2B,KAAKzB;IAAS,EAAC,GAAIL;IAE7D,IAAI,CAACgC,aAAa;QAChB,MAAM,IAAIC,MAAM;IAClB;IAEA,MAAMC,aAAalC,KAAKmC,IAAI,CAACnC,KAAKM,OAAO,CAAC0B,cAAc,QAAQ,WAAW;IAE3E,MAAMI,SAAS,IAAIlC,OAAOgC,YAAY;QACpCG,KAAKR,QAAQQ,GAAG;QAChBC,YAAY;YACV,sEAAsE;YACtEjB,cAAckB,gBAAgBlB;YAC9BC;YACAR;YACAS;YACAC;YACAC;YACAC;YACAc,YAAYpB,QAAQoB,UAAU;YAC9BZ;YACAG;QACF;IACF;IAEA,OAAOJ,SAASvB,eAAwCgC;AAC1D"}

package/dist/actions/documents/validation/reporters/index.d.ts

@@ -0,0 +1,5 @@
+export declare const reporters: {
+    json: import("../../../../commands/documents/validate.js").BuiltInValidationReporter;
+    ndjson: import("../../../../commands/documents/validate.js").BuiltInValidationReporter;
+    pretty: import("../../../../commands/documents/validate.js").BuiltInValidationReporter;
+};

package/dist/actions/documents/validation/reporters/index.js

@@ -0,0 +1,10 @@
+import { json } from './jsonReporter.js';
+import { ndjson } from './ndjsonReporter.js';
+import { pretty } from './prettyReporter/index.js';
+export const reporters = {
+    json,
+    ndjson,
+    pretty
+};
+
+//# sourceMappingURL=index.js.map

package/dist/actions/documents/validation/reporters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/actions/documents/validation/reporters/index.ts"],"sourcesContent":["import {json} from './jsonReporter.js'\nimport {ndjson} from './ndjsonReporter.js'\nimport {pretty} from './prettyReporter/index.js'\n\nexport const reporters = {json, ndjson, pretty}\n"],"names":["json","ndjson","pretty","reporters"],"mappings":"AAAA,SAAQA,IAAI,QAAO,oBAAmB;AACtC,SAAQC,MAAM,QAAO,sBAAqB;AAC1C,SAAQC,MAAM,QAAO,4BAA2B;AAEhD,OAAO,MAAMC,YAAY;IAACH;IAAMC;IAAQC;AAAM,EAAC"}

package/dist/actions/documents/validation/reporters/jsonReporter.d.ts

@@ -0,0 +1,2 @@
+import { type BuiltInValidationReporter } from '../../../../commands/documents/validate.js';
+export declare const json: BuiltInValidationReporter;

package/dist/actions/documents/validation/reporters/jsonReporter.js

@@ -0,0 +1,25 @@
+import { omit } from 'lodash-es';
+// TODO: replace with Array.fromAsync when it's out of stage3
+async function arrayFromAsync(iterable) {
+    const results = [];
+    for await (const item of iterable)results.push(item);
+    return results;
+}
+export const json = async ({ output, worker })=>{
+    const results = await arrayFromAsync(worker.stream.validation());
+    const formatted = results// report out only documents with some markers
+    .filter(({ markers })=>markers.length)// remove validatedCount from the results
+    .map((result)=>omit(result, [
+            'validatedCount'
+        ]));
+    await worker.dispose();
+    output.log(JSON.stringify(formatted));
+    let overallLevel = 'info';
+    for (const { level } of formatted){
+        if (level === 'error') overallLevel = 'error';
+        if (level === 'warning' && overallLevel !== 'error') overallLevel = 'warning';
+    }
+    return overallLevel;
+};
+
+//# sourceMappingURL=jsonReporter.js.map

package/dist/actions/documents/validation/reporters/jsonReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/actions/documents/validation/reporters/jsonReporter.ts"],"sourcesContent":["import {omit} from 'lodash-es'\n\nimport {type BuiltInValidationReporter} from '../../../../commands/documents/validate.js'\nimport {Level} from '../../types.js'\n\n// TODO: replace with Array.fromAsync when it's out of stage3\nasync function arrayFromAsync<T>(iterable: AsyncIterable<T>) {\n  const results: T[] = []\n  for await (const item of iterable) results.push(item)\n  return results\n}\n\nexport const json: BuiltInValidationReporter = async ({output, worker}) => {\n  const results = await arrayFromAsync(worker.stream.validation())\n  const formatted = results\n    // report out only documents with some markers\n    .filter(({markers}) => markers.length)\n    // remove validatedCount from the results\n    .map((result) => omit(result, ['validatedCount']))\n\n  await worker.dispose()\n\n  output.log(JSON.stringify(formatted))\n\n  let overallLevel: Level = 'info'\n\n  for (const {level} of formatted) {\n    if (level === 'error') overallLevel = 'error'\n    if (level === 'warning' && overallLevel !== 'error') overallLevel = 'warning'\n  }\n\n  return overallLevel\n}\n"],"names":["omit","arrayFromAsync","iterable","results","item","push","json","output","worker","stream","validation","formatted","filter","markers","length","map","result","dispose","log","JSON","stringify","overallLevel","level"],"mappings":"AAAA,SAAQA,IAAI,QAAO,YAAW;AAK9B,6DAA6D;AAC7D,eAAeC,eAAkBC,QAA0B;IACzD,MAAMC,UAAe,EAAE;IACvB,WAAW,MAAMC,QAAQF,SAAUC,QAAQE,IAAI,CAACD;IAChD,OAAOD;AACT;AAEA,OAAO,MAAMG,OAAkC,OAAO,EAACC,MAAM,EAAEC,MAAM,EAAC;IACpE,MAAML,UAAU,MAAMF,eAAeO,OAAOC,MAAM,CAACC,UAAU;IAC7D,MAAMC,YAAYR,OAChB,8CAA8C;KAC7CS,MAAM,CAAC,CAAC,EAACC,OAAO,EAAC,GAAKA,QAAQC,MAAM,CACrC,yCAAyC;KACxCC,GAAG,CAAC,CAACC,SAAWhB,KAAKgB,QAAQ;YAAC;SAAiB;IAElD,MAAMR,OAAOS,OAAO;IAEpBV,OAAOW,GAAG,CAACC,KAAKC,SAAS,CAACT;IAE1B,IAAIU,eAAsB;IAE1B,KAAK,MAAM,EAACC,KAAK,EAAC,IAAIX,UAAW;QAC/B,IAAIW,UAAU,SAASD,eAAe;QACtC,IAAIC,UAAU,aAAaD,iBAAiB,SAASA,eAAe;IACtE;IAEA,OAAOA;AACT,EAAC"}

package/dist/actions/documents/validation/reporters/ndjsonReporter.d.ts

@@ -0,0 +1,2 @@
+import { type BuiltInValidationReporter } from '../../../../commands/documents/validate.js';
+export declare const ndjson: BuiltInValidationReporter;

package/dist/actions/documents/validation/reporters/ndjsonReporter.js

@@ -0,0 +1,18 @@
+import { omit } from 'lodash-es';
+export const ndjson = async ({ output, worker })=>{
+    let overallLevel = 'info';
+    for await (const item of worker.stream.validation()){
+        const result = omit(item, [
+            'validatedCount'
+        ]);
+        if (result.level === 'error') overallLevel = 'error';
+        if (result.level === 'warning' && overallLevel !== 'error') overallLevel = 'warning';
+        if (result.markers.length > 0) {
+            output.log(JSON.stringify(result));
+        }
+    }
+    await worker.dispose();
+    return overallLevel;
+};
+
+//# sourceMappingURL=ndjsonReporter.js.map

package/dist/actions/documents/validation/reporters/ndjsonReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/actions/documents/validation/reporters/ndjsonReporter.ts"],"sourcesContent":["import {omit} from 'lodash-es'\n\nimport {type BuiltInValidationReporter} from '../../../../commands/documents/validate.js'\nimport {Level} from '../../types.js'\n\nexport const ndjson: BuiltInValidationReporter = async ({output, worker}) => {\n  let overallLevel: Level = 'info'\n\n  for await (const item of worker.stream.validation()) {\n    const result = omit(item, ['validatedCount'])\n\n    if (result.level === 'error') overallLevel = 'error'\n    if (result.level === 'warning' && overallLevel !== 'error') overallLevel = 'warning'\n\n    if (result.markers.length > 0) {\n      output.log(JSON.stringify(result))\n    }\n  }\n\n  await worker.dispose()\n\n  return overallLevel\n}\n"],"names":["omit","ndjson","output","worker","overallLevel","item","stream","validation","result","level","markers","length","log","JSON","stringify","dispose"],"mappings":"AAAA,SAAQA,IAAI,QAAO,YAAW;AAK9B,OAAO,MAAMC,SAAoC,OAAO,EAACC,MAAM,EAAEC,MAAM,EAAC;IACtE,IAAIC,eAAsB;IAE1B,WAAW,MAAMC,QAAQF,OAAOG,MAAM,CAACC,UAAU,GAAI;QACnD,MAAMC,SAASR,KAAKK,MAAM;YAAC;SAAiB;QAE5C,IAAIG,OAAOC,KAAK,KAAK,SAASL,eAAe;QAC7C,IAAII,OAAOC,KAAK,KAAK,aAAaL,iBAAiB,SAASA,eAAe;QAE3E,IAAII,OAAOE,OAAO,CAACC,MAAM,GAAG,GAAG;YAC7BT,OAAOU,GAAG,CAACC,KAAKC,SAAS,CAACN;QAC5B;IACF;IAEA,MAAML,OAAOY,OAAO;IAEpB,OAAOX;AACT,EAAC"}

package/dist/actions/documents/validation/reporters/prettyReporter/__tests__/formatDocumentValidation.test.js

@@ -0,0 +1,124 @@
+import { describe, expect, it, vi } from 'vitest';
+import { formatDocumentValidation } from '../formatDocumentValidation';
+// disables some terminal specific things that are typically auto detected
+vi.mock(import('node:tty'), async (importOriginal)=>{
+    const actual = await importOriginal();
+    return {
+        ...actual,
+        isatty: ()=>false
+    };
+});
+describe('formatDocumentValidation', ()=>{
+    it('formats a set of markers in to a printed tree, sorting markers, and adding spacing', ()=>{
+        const result = formatDocumentValidation({
+            documentId: 'my-document-id',
+            documentType: 'person',
+            level: 'error',
+            markers: [
+                {
+                    level: 'error',
+                    message: 'Top-level marker',
+                    path: []
+                },
+                {
+                    level: 'error',
+                    message: '2nd top-level marker',
+                    path: []
+                },
+                {
+                    level: 'error',
+                    message: 'Property marker',
+                    path: [
+                        'foo'
+                    ]
+                },
+                {
+                    level: 'error',
+                    message: 'Nested marker',
+                    path: [
+                        'bar',
+                        'title'
+                    ]
+                },
+                {
+                    level: 'error',
+                    message: '2nd nested marker',
+                    path: [
+                        'bar',
+                        'title'
+                    ]
+                },
+                {
+                    level: 'error',
+                    message: '2nd property marker',
+                    path: [
+                        'baz'
+                    ]
+                },
+                {
+                    level: 'warning',
+                    message: 'Warning',
+                    path: [
+                        'beep',
+                        'boop'
+                    ]
+                },
+                {
+                    level: 'error',
+                    message: 'Errors sorted first',
+                    path: [
+                        'beep',
+                        'boop'
+                    ]
+                }
+            ],
+            revision: 'rev'
+        });
+        expect(result).toMatchInlineSnapshot(`
+      "[ERROR] [person] my-document-id
+      │  (root) ........................ ✖ Top-level marker
+      │                                  ✖ 2nd top-level marker
+      ├─ foo ........................... ✖ Property marker
+      ├─ bar
+      │ └─ title ....................... ✖ Nested marker
+      │                                  ✖ 2nd nested marker
+      ├─ baz ........................... ✖ 2nd property marker
+      └─ beep
+        └─ boop ........................ ✖ Errors sorted first
+                                         ⚠ Warning"
+    `);
+    });
+    it('formats a set of top-level markers only (should have an elbow at first message)', ()=>{
+        const result = formatDocumentValidation({
+            documentId: 'my-document-id',
+            documentType: 'person',
+            level: 'error',
+            markers: [
+                {
+                    level: 'info',
+                    message: '2nd top-level marker (should come last)',
+                    path: []
+                },
+                {
+                    level: 'error',
+                    message: 'Lone top-level marker (should get elbow)',
+                    path: []
+                },
+                {
+                    level: 'warning',
+                    message: 'Warning, should come second',
+                    path: []
+                }
+            ],
+            revision: 'rev'
+        });
+        expect(result).toMatchInlineSnapshot(`
+      "[ERROR] [person] my-document-id
+      └─ (root) ........................ ✖ Lone top-level marker (should get elbow)
+                                         ⚠ Warning, should come second
+                                         ℹ 2nd top-level marker (should come last)"
+    `);
+    });
+});
+
+//# sourceMappingURL=formatDocumentValidation.test.js.map

package/dist/actions/documents/validation/reporters/prettyReporter/__tests__/formatDocumentValidation.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../src/actions/documents/validation/reporters/prettyReporter/__tests__/formatDocumentValidation.test.ts"],"sourcesContent":["import {describe, expect, it, vi} from 'vitest'\n\nimport {formatDocumentValidation} from '../formatDocumentValidation'\n\n// disables some terminal specific things that are typically auto detected\nvi.mock(import('node:tty'), async (importOriginal) => {\n  const actual = await importOriginal()\n  return {\n    ...actual,\n    isatty: () => false,\n  }\n})\n\ndescribe('formatDocumentValidation', () => {\n  it('formats a set of markers in to a printed tree, sorting markers, and adding spacing', () => {\n    const result = formatDocumentValidation({\n      documentId: 'my-document-id',\n      documentType: 'person',\n      level: 'error',\n      markers: [\n        {level: 'error', message: 'Top-level marker', path: []},\n        {level: 'error', message: '2nd top-level marker', path: []},\n        {level: 'error', message: 'Property marker', path: ['foo']},\n        {level: 'error', message: 'Nested marker', path: ['bar', 'title']},\n        {level: 'error', message: '2nd nested marker', path: ['bar', 'title']},\n        {level: 'error', message: '2nd property marker', path: ['baz']},\n        {level: 'warning', message: 'Warning', path: ['beep', 'boop']},\n        {level: 'error', message: 'Errors sorted first', path: ['beep', 'boop']},\n      ],\n      revision: 'rev',\n    })\n\n    expect(result).toMatchInlineSnapshot(\n      `\n      \"[ERROR] [person] my-document-id\n      │  (root) ........................ \u001b[31m✖\u001b[39m Top-level marker\n      │                                  \u001b[31m✖\u001b[39m 2nd top-level marker\n      ├─ foo ........................... \u001b[31m✖\u001b[39m Property marker\n      ├─ bar\n      │ └─ title ....................... \u001b[31m✖\u001b[39m Nested marker\n      │                                  \u001b[31m✖\u001b[39m 2nd nested marker\n      ├─ baz ........................... \u001b[31m✖\u001b[39m 2nd property marker\n      └─ beep\n        └─ boop ........................ \u001b[31m✖\u001b[39m Errors sorted first\n                                         \u001b[33m⚠\u001b[39m Warning\"\n    `,\n    )\n  })\n\n  it('formats a set of top-level markers only (should have an elbow at first message)', () => {\n    const result = formatDocumentValidation({\n      documentId: 'my-document-id',\n      documentType: 'person',\n      level: 'error',\n      markers: [\n        {level: 'info', message: '2nd top-level marker (should come last)', path: []},\n        {level: 'error', message: 'Lone top-level marker (should get elbow)', path: []},\n        {level: 'warning', message: 'Warning, should come second', path: []},\n      ],\n      revision: 'rev',\n    })\n\n    expect(result).toMatchInlineSnapshot(\n      `\n      \"[ERROR] [person] my-document-id\n      └─ (root) ........................ \u001b[31m✖\u001b[39m Lone top-level marker (should get elbow)\n                                         \u001b[33m⚠\u001b[39m Warning, should come second\n                                         \u001b[34mℹ\u001b[39m 2nd top-level marker (should come last)\"\n    `,\n    )\n  })\n})\n"],"names":["describe","expect","it","vi","formatDocumentValidation","mock","importOriginal","actual","isatty","result","documentId","documentType","level","markers","message","path","revision","toMatchInlineSnapshot"],"mappings":"AAAA,SAAQA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAO,SAAQ;AAE/C,SAAQC,wBAAwB,QAAO,8BAA6B;AAEpE,0EAA0E;AAC1ED,GAAGE,IAAI,CAAC,MAAM,CAAC,aAAa,OAAOC;IACjC,MAAMC,SAAS,MAAMD;IACrB,OAAO;QACL,GAAGC,MAAM;QACTC,QAAQ,IAAM;IAChB;AACF;AAEAR,SAAS,4BAA4B;IACnCE,GAAG,sFAAsF;QACvF,MAAMO,SAASL,yBAAyB;YACtCM,YAAY;YACZC,cAAc;YACdC,OAAO;YACPC,SAAS;gBACP;oBAACD,OAAO;oBAASE,SAAS;oBAAoBC,MAAM,EAAE;gBAAA;gBACtD;oBAACH,OAAO;oBAASE,SAAS;oBAAwBC,MAAM,EAAE;gBAAA;gBAC1D;oBAACH,OAAO;oBAASE,SAAS;oBAAmBC,MAAM;wBAAC;qBAAM;gBAAA;gBAC1D;oBAACH,OAAO;oBAASE,SAAS;oBAAiBC,MAAM;wBAAC;wBAAO;qBAAQ;gBAAA;gBACjE;oBAACH,OAAO;oBAASE,SAAS;oBAAqBC,MAAM;wBAAC;wBAAO;qBAAQ;gBAAA;gBACrE;oBAACH,OAAO;oBAASE,SAAS;oBAAuBC,MAAM;wBAAC;qBAAM;gBAAA;gBAC9D;oBAACH,OAAO;oBAAWE,SAAS;oBAAWC,MAAM;wBAAC;wBAAQ;qBAAO;gBAAA;gBAC7D;oBAACH,OAAO;oBAASE,SAAS;oBAAuBC,MAAM;wBAAC;wBAAQ;qBAAO;gBAAA;aACxE;YACDC,UAAU;QACZ;QAEAf,OAAOQ,QAAQQ,qBAAqB,CAClC,CAAC;;;;;;;;;;;;IAYH,CAAC;IAEH;IAEAf,GAAG,mFAAmF;QACpF,MAAMO,SAASL,yBAAyB;YACtCM,YAAY;YACZC,cAAc;YACdC,OAAO;YACPC,SAAS;gBACP;oBAACD,OAAO;oBAAQE,SAAS;oBAA2CC,MAAM,EAAE;gBAAA;gBAC5E;oBAACH,OAAO;oBAASE,SAAS;oBAA4CC,MAAM,EAAE;gBAAA;gBAC9E;oBAACH,OAAO;oBAAWE,SAAS;oBAA+BC,MAAM,EAAE;gBAAA;aACpE;YACDC,UAAU;QACZ;QAEAf,OAAOQ,QAAQQ,qBAAqB,CAClC,CAAC;;;;;IAKH,CAAC;IAEH;AACF"}

package/dist/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.d.ts

@@ -0,0 +1,10 @@
+import { type DocumentValidationResult } from './util.js';
+interface FormatDocumentValidationOptions extends DocumentValidationResult {
+    basePath?: string;
+    studioHost?: string;
+}
+/**
+ * Formats document validation results into a user-friendly tree structure
+ */
+export declare function formatDocumentValidation({ documentId, documentType, intentUrl, level, markers, }: FormatDocumentValidationOptions): string;
+export {};

package/dist/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.js

@@ -0,0 +1,61 @@
+import { convertToTree, formatTree, maxKeyLength } from '@sanity/cli-core/tree';
+import { chalk, logSymbols } from '@sanity/cli-core/ux';
+import { isTty, levelValues } from './util.js';
+const levelHeaders = {
+    error: isTty ? chalk.bold(chalk.bgRed(chalk.black(' ERROR '))) : chalk.red('[ERROR]'),
+    info: isTty ? chalk.bold(chalk.cyan(chalk.black(' INFO '))) : chalk.cyan('[INFO]'),
+    warning: isTty ? chalk.bold(chalk.bgYellow(chalk.black(' WARN '))) : chalk.yellow('[WARN]')
+};
+/**
+ * Creates a terminal hyperlink. Only outputs a hyperlink if the output is
+ * determined to be a TTY
+ */ const link = (text, url)=>isTty ? `\u001B]8;;${url}\u0007${text}\u001B]8;;\u0007` : chalk.underline(text);
+/**
+ * For sorting markers
+ */ const compareLevels = (a, b)=>levelValues[a.level] - levelValues[b.level];
+/**
+ * Formats the markers at the root of the validation tree
+ */ const formatRootErrors = (root, hasChildren, paddingLength)=>{
+    if (!root.nodes) return '';
+    const [first, ...rest] = [
+        ...root.nodes
+    ].toSorted(compareLevels);
+    if (!first) return '';
+    const firstElbow = hasChildren ? '│ ' : '└─';
+    const firstPadding = '.'.repeat(paddingLength - 6);
+    const firstLine = `${firstElbow} (root) ${firstPadding} ${logSymbols[first.level]} ${first.message}`;
+    const subsequentPadding = ' '.repeat(paddingLength + 2);
+    const subsequentElbow = hasChildren ? '│ ' : '  ';
+    const restOfLines = rest.map((marker)=>`${subsequentElbow}${subsequentPadding} ${logSymbols[marker.level]} ${marker.message}`).join('\n');
+    return [
+        firstLine,
+        restOfLines
+    ].filter(Boolean).join('\n');
+};
+/**
+ * Formats document validation results into a user-friendly tree structure
+ */ export function formatDocumentValidation({ documentId, documentType, intentUrl, level, markers }) {
+    const tree = convertToTree(markers);
+    const documentTypeHeader = isTty ? chalk.bgWhite(chalk.black(` ${documentType} `)) : `[${documentType}]`;
+    const header = `${levelHeaders[level]} ${documentTypeHeader} ${intentUrl ? link(documentId, intentUrl) : chalk.underline(documentId)}`;
+    const paddingLength = Math.max(maxKeyLength(tree.children) + 2, 30);
+    const childErrors = formatTree({
+        getMessage: (marker)=>[
+                logSymbols[marker.level],
+                marker.message
+            ].join(' '),
+        getNodes: ({ nodes })=>[
+                ...nodes ?? []
+            ].toSorted(compareLevels),
+        node: tree.children,
+        paddingLength
+    });
+    const rootErrors = formatRootErrors(tree, childErrors.length > 0, paddingLength);
+    return [
+        header,
+        rootErrors,
+        childErrors
+    ].filter(Boolean).join('\n');
+}
+
+//# sourceMappingURL=formatDocumentValidation.js.map

package/dist/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.ts"],"sourcesContent":["import {convertToTree, formatTree, maxKeyLength, type Tree} from '@sanity/cli-core/tree'\nimport {chalk, logSymbols} from '@sanity/cli-core/ux'\nimport {type Path, type ValidationMarker} from '@sanity/types'\n\nimport {Level} from '../../../types'\nimport {type DocumentValidationResult, isTty, levelValues} from './util.js'\n\ninterface FormatDocumentValidationOptions extends DocumentValidationResult {\n  basePath?: string\n  studioHost?: string\n}\n\ninterface Marker extends Pick<ValidationMarker, 'level' | 'message'> {\n  path: Path\n}\n\ntype ValidationTree = Tree<Marker>\n\nconst levelHeaders = {\n  error: isTty ? chalk.bold(chalk.bgRed(chalk.black(' ERROR '))) : chalk.red('[ERROR]'),\n  info: isTty ? chalk.bold(chalk.cyan(chalk.black(' INFO '))) : chalk.cyan('[INFO]'),\n  warning: isTty ? chalk.bold(chalk.bgYellow(chalk.black(' WARN '))) : chalk.yellow('[WARN]'),\n}\n/**\n * Creates a terminal hyperlink. Only outputs a hyperlink if the output is\n * determined to be a TTY\n */\nconst link = (text: string, url: string) =>\n  isTty ? `\\u001B]8;;${url}\\u0007${text}\\u001B]8;;\\u0007` : chalk.underline(text)\n\n/**\n * For sorting markers\n */\nconst compareLevels = <T extends {level: Level; message: string}>(a: T, b: T) =>\n  levelValues[a.level] - levelValues[b.level]\n\n/**\n * Formats the markers at the root of the validation tree\n */\nconst formatRootErrors = (root: ValidationTree, hasChildren: boolean, paddingLength: number) => {\n  if (!root.nodes) return ''\n\n  const [first, ...rest] = [...root.nodes].toSorted(compareLevels)\n  if (!first) return ''\n\n  const firstElbow = hasChildren ? '│ ' : '└─'\n  const firstPadding = '.'.repeat(paddingLength - 6)\n  const firstLine = `${firstElbow} (root) ${firstPadding} ${logSymbols[first.level]} ${\n    first.message\n  }`\n  const subsequentPadding = ' '.repeat(paddingLength + 2)\n  const subsequentElbow = hasChildren ? '│ ' : '  '\n\n  const restOfLines = rest\n    .map(\n      (marker) =>\n        `${subsequentElbow}${subsequentPadding} ${logSymbols[marker.level]} ${marker.message}`,\n    )\n    .join('\\n')\n  return [firstLine, restOfLines].filter(Boolean).join('\\n')\n}\n\n/**\n * Formats document validation results into a user-friendly tree structure\n */\nexport function formatDocumentValidation({\n  documentId,\n  documentType,\n  intentUrl,\n  level,\n  markers,\n}: FormatDocumentValidationOptions): string {\n  const tree = convertToTree<Marker>(markers)\n\n  const documentTypeHeader = isTty\n    ? chalk.bgWhite(chalk.black(` ${documentType} `))\n    : `[${documentType}]`\n\n  const header = `${levelHeaders[level]} ${documentTypeHeader} ${\n    intentUrl ? link(documentId, intentUrl) : chalk.underline(documentId)\n  }`\n\n  const paddingLength = Math.max(maxKeyLength(tree.children) + 2, 30)\n\n  const childErrors = formatTree<Marker>({\n    getMessage: (marker) => [logSymbols[marker.level], marker.message].join(' '),\n    getNodes: ({nodes}) => [...(nodes ?? [])].toSorted(compareLevels),\n    node: tree.children,\n    paddingLength,\n  })\n\n  const rootErrors = formatRootErrors(tree, childErrors.length > 0, paddingLength)\n\n  return [header, rootErrors, childErrors].filter(Boolean).join('\\n')\n}\n"],"names":["convertToTree","formatTree","maxKeyLength","chalk","logSymbols","isTty","levelValues","levelHeaders","error","bold","bgRed","black","red","info","cyan","warning","bgYellow","yellow","link","text","url","underline","compareLevels","a","b","level","formatRootErrors","root","hasChildren","paddingLength","nodes","first","rest","toSorted","firstElbow","firstPadding","repeat","firstLine","message","subsequentPadding","subsequentElbow","restOfLines","map","marker","join","filter","Boolean","formatDocumentValidation","documentId","documentType","intentUrl","markers","tree","documentTypeHeader","bgWhite","header","Math","max","children","childErrors","getMessage","getNodes","node","rootErrors","length"],"mappings":"AAAA,SAAQA,aAAa,EAAEC,UAAU,EAAEC,YAAY,QAAkB,wBAAuB;AACxF,SAAQC,KAAK,EAAEC,UAAU,QAAO,sBAAqB;AAIrD,SAAuCC,KAAK,EAAEC,WAAW,QAAO,YAAW;AAa3E,MAAMC,eAAe;IACnBC,OAAOH,QAAQF,MAAMM,IAAI,CAACN,MAAMO,KAAK,CAACP,MAAMQ,KAAK,CAAC,eAAeR,MAAMS,GAAG,CAAC;IAC3EC,MAAMR,QAAQF,MAAMM,IAAI,CAACN,MAAMW,IAAI,CAACX,MAAMQ,KAAK,CAAC,cAAcR,MAAMW,IAAI,CAAC;IACzEC,SAASV,QAAQF,MAAMM,IAAI,CAACN,MAAMa,QAAQ,CAACb,MAAMQ,KAAK,CAAC,cAAcR,MAAMc,MAAM,CAAC;AACpF;AACA;;;CAGC,GACD,MAAMC,OAAO,CAACC,MAAcC,MAC1Bf,QAAQ,CAAC,UAAU,EAAEe,IAAI,MAAM,EAAED,KAAK,gBAAgB,CAAC,GAAGhB,MAAMkB,SAAS,CAACF;AAE5E;;CAEC,GACD,MAAMG,gBAAgB,CAA4CC,GAAMC,IACtElB,WAAW,CAACiB,EAAEE,KAAK,CAAC,GAAGnB,WAAW,CAACkB,EAAEC,KAAK,CAAC;AAE7C;;CAEC,GACD,MAAMC,mBAAmB,CAACC,MAAsBC,aAAsBC;IACpE,IAAI,CAACF,KAAKG,KAAK,EAAE,OAAO;IAExB,MAAM,CAACC,OAAO,GAAGC,KAAK,GAAG;WAAIL,KAAKG,KAAK;KAAC,CAACG,QAAQ,CAACX;IAClD,IAAI,CAACS,OAAO,OAAO;IAEnB,MAAMG,aAAaN,cAAc,OAAO;IACxC,MAAMO,eAAe,IAAIC,MAAM,CAACP,gBAAgB;IAChD,MAAMQ,YAAY,GAAGH,WAAW,QAAQ,EAAEC,aAAa,CAAC,EAAE/B,UAAU,CAAC2B,MAAMN,KAAK,CAAC,CAAC,CAAC,EACjFM,MAAMO,OAAO,EACb;IACF,MAAMC,oBAAoB,IAAIH,MAAM,CAACP,gBAAgB;IACrD,MAAMW,kBAAkBZ,cAAc,OAAO;IAE7C,MAAMa,cAAcT,KACjBU,GAAG,CACF,CAACC,SACC,GAAGH,kBAAkBD,kBAAkB,CAAC,EAAEnC,UAAU,CAACuC,OAAOlB,KAAK,CAAC,CAAC,CAAC,EAAEkB,OAAOL,OAAO,EAAE,EAEzFM,IAAI,CAAC;IACR,OAAO;QAACP;QAAWI;KAAY,CAACI,MAAM,CAACC,SAASF,IAAI,CAAC;AACvD;AAEA;;CAEC,GACD,OAAO,SAASG,yBAAyB,EACvCC,UAAU,EACVC,YAAY,EACZC,SAAS,EACTzB,KAAK,EACL0B,OAAO,EACyB;IAChC,MAAMC,OAAOpD,cAAsBmD;IAEnC,MAAME,qBAAqBhD,QACvBF,MAAMmD,OAAO,CAACnD,MAAMQ,KAAK,CAAC,CAAC,CAAC,EAAEsC,aAAa,CAAC,CAAC,KAC7C,CAAC,CAAC,EAAEA,aAAa,CAAC,CAAC;IAEvB,MAAMM,SAAS,GAAGhD,YAAY,CAACkB,MAAM,CAAC,CAAC,EAAE4B,mBAAmB,CAAC,EAC3DH,YAAYhC,KAAK8B,YAAYE,aAAa/C,MAAMkB,SAAS,CAAC2B,aAC1D;IAEF,MAAMnB,gBAAgB2B,KAAKC,GAAG,CAACvD,aAAakD,KAAKM,QAAQ,IAAI,GAAG;IAEhE,MAAMC,cAAc1D,WAAmB;QACrC2D,YAAY,CAACjB,SAAW;gBAACvC,UAAU,CAACuC,OAAOlB,KAAK,CAAC;gBAAEkB,OAAOL,OAAO;aAAC,CAACM,IAAI,CAAC;QACxEiB,UAAU,CAAC,EAAC/B,KAAK,EAAC,GAAK;mBAAKA,SAAS,EAAE;aAAE,CAACG,QAAQ,CAACX;QACnDwC,MAAMV,KAAKM,QAAQ;QACnB7B;IACF;IAEA,MAAMkC,aAAarC,iBAAiB0B,MAAMO,YAAYK,MAAM,GAAG,GAAGnC;IAElE,OAAO;QAAC0B;QAAQQ;QAAYJ;KAAY,CAACd,MAAM,CAACC,SAASF,IAAI,CAAC;AAChE"}

package/dist/actions/documents/validation/reporters/prettyReporter/index.d.ts

@@ -0,0 +1 @@
+export { pretty } from './prettyReporter.js';

package/dist/actions/documents/validation/reporters/prettyReporter/index.js

@@ -0,0 +1,3 @@
+export { pretty } from './prettyReporter.js';
+
+//# sourceMappingURL=index.js.map

package/dist/actions/documents/validation/reporters/prettyReporter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/actions/documents/validation/reporters/prettyReporter/index.ts"],"sourcesContent":["export {pretty} from './prettyReporter.js'\n"],"names":["pretty"],"mappings":"AAAA,SAAQA,MAAM,QAAO,sBAAqB"}

package/dist/actions/documents/validation/reporters/prettyReporter/prettyReporter.d.ts

@@ -0,0 +1,5 @@
+import { type BuiltInValidationReporter } from '../../../../../commands/documents/validate.js';
+/**
+ * Represents the default stylish/pretty reporter
+ */
+export declare const pretty: BuiltInValidationReporter;

package/dist/actions/documents/validation/reporters/prettyReporter/prettyReporter.js

@@ -0,0 +1,92 @@
+import { spinner } from '@sanity/cli-core/ux';
+import { formatDocumentValidation } from './formatDocumentValidation.js';
+import { count, levelValues, percent, seconds, summary } from './util.js';
+/**
+ * Represents the default stylish/pretty reporter
+ */ export const pretty = async ({ flags, output, worker })=>{
+    const workspaceLoadStart = Date.now();
+    // Report workspace loaded
+    const spin = spinner(flags.workspace ? `Loading workspace '${flags.workspace}'…` : 'Loading workspace…').start();
+    const workspace = await worker.event.loadedWorkspace();
+    spin.succeed(`Loaded workspace '${workspace.name}' using project '${workspace.projectId}' and dataset '${flags.dataset || workspace.dataset}' ${seconds(workspaceLoadStart)}`);
+    if (!flags.file) {
+        // Report document count
+        spin.start('Calculating documents to be validated…');
+        const { documentCount } = await worker.event.loadedDocumentCount();
+        // Report export progress
+        const downloadStart = Date.now();
+        spin.text = `Downloading ${count(documentCount, 'documents')}…`;
+        for await (const { downloadedCount } of worker.stream.exportProgress()){
+            const percentage = percent(downloadedCount / documentCount);
+            spin.text = `Downloading ${count(documentCount, 'documents')}… ${percentage}`;
+        }
+        spin.succeed(`Downloaded ${count(documentCount, 'documents')} ${seconds(downloadStart)}`);
+    }
+    const { totalDocumentsToValidate } = await worker.event.exportFinished();
+    const referenceIntegrityStart = Date.now();
+    spin.start(`Checking reference existence…`);
+    await worker.event.loadedReferenceIntegrity();
+    spin.succeed(`Checked all references ${seconds(referenceIntegrityStart)}`);
+    // Report validation progress
+    const validationStart = Date.now();
+    spin.start(`Validating ${count(totalDocumentsToValidate, 'documents')}…`);
+    const results = [];
+    const totals = {
+        errors: {
+            documents: 0,
+            markers: 0
+        },
+        infos: {
+            documents: 0,
+            markers: 0
+        },
+        valid: {
+            documents: 0
+        },
+        warnings: {
+            documents: 0,
+            markers: 0
+        }
+    };
+    for await (const { validatedCount, ...result } of worker.stream.validation()){
+        const { markers } = result;
+        if (markers.length > 0) {
+            results.push(result);
+        }
+        const errors = markers.filter((marker)=>marker.level === 'error');
+        const warnings = markers.filter((marker)=>marker.level === 'warning');
+        const infos = markers.filter((marker)=>marker.level === 'info');
+        if (markers.length === 0) {
+            totals.valid.documents += 1;
+        }
+        if (errors.length > 0) {
+            totals.errors.documents += 1;
+            totals.errors.markers += errors.length;
+        }
+        if (warnings.length > 0) {
+            totals.warnings.documents += 1;
+            totals.warnings.markers += warnings.length;
+        }
+        if (infos.length > 0) {
+            totals.infos.documents += 1;
+            totals.infos.markers += infos.length;
+        }
+        spin.text = `Validating ${count(totalDocumentsToValidate, 'documents')}…\n\n` + `Processed ${count(validatedCount, 'documents')} (${percent(validatedCount / totalDocumentsToValidate)}):\n${summary(totals, flags.level)}`;
+    }
+    spin.succeed(`Validated ${count(totalDocumentsToValidate, 'documents')} ${seconds(validationStart)}`);
+    output.log(`\nValidation results:\n${summary(totals, flags.level)}`);
+    results.sort((a, b)=>{
+        if (a.level === b.level) return a.documentType.localeCompare(b.documentType);
+        return levelValues[a.level] - levelValues[b.level];
+    });
+    let overallLevel = 'info';
+    for (const result of results){
+        if (result.level === 'error') overallLevel = 'error';
+        if (result.level === 'warning' && overallLevel !== 'error') overallLevel = 'warning';
+        output.log(`${formatDocumentValidation(result)}\n`);
+    }
+    await worker.dispose();
+    return overallLevel;
+};
+
+//# sourceMappingURL=prettyReporter.js.map

package/dist/actions/documents/validation/reporters/prettyReporter/prettyReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/actions/documents/validation/reporters/prettyReporter/prettyReporter.ts"],"sourcesContent":["import {spinner} from '@sanity/cli-core/ux'\n\nimport {type BuiltInValidationReporter} from '../../../../../commands/documents/validate.js'\nimport {Level} from '../../../types'\nimport {formatDocumentValidation} from './formatDocumentValidation.js'\nimport {\n  count,\n  type DocumentValidationResult,\n  levelValues,\n  percent,\n  seconds,\n  summary,\n} from './util.js'\n\n/**\n * Represents the default stylish/pretty reporter\n */\nexport const pretty: BuiltInValidationReporter = async ({flags, output, worker}) => {\n  const workspaceLoadStart = Date.now()\n  // Report workspace loaded\n  const spin = spinner(\n    flags.workspace ? `Loading workspace '${flags.workspace}'…` : 'Loading workspace…',\n  ).start()\n\n  const workspace = await worker.event.loadedWorkspace()\n  spin.succeed(\n    `Loaded workspace '${workspace.name}' using project '${workspace.projectId}' and dataset '${\n      flags.dataset || workspace.dataset\n    }' ${seconds(workspaceLoadStart)}`,\n  )\n\n  if (!flags.file) {\n    // Report document count\n    spin.start('Calculating documents to be validated…')\n    const {documentCount} = await worker.event.loadedDocumentCount()\n\n    // Report export progress\n    const downloadStart = Date.now()\n    spin.text = `Downloading ${count(documentCount, 'documents')}…`\n    for await (const {downloadedCount} of worker.stream.exportProgress()) {\n      const percentage = percent(downloadedCount / documentCount)\n      spin.text = `Downloading ${count(documentCount, 'documents')}… ${percentage}`\n    }\n    spin.succeed(`Downloaded ${count(documentCount, 'documents')} ${seconds(downloadStart)}`)\n  }\n\n  const {totalDocumentsToValidate} = await worker.event.exportFinished()\n\n  const referenceIntegrityStart = Date.now()\n  spin.start(`Checking reference existence…`)\n  await worker.event.loadedReferenceIntegrity()\n  spin.succeed(`Checked all references ${seconds(referenceIntegrityStart)}`)\n\n  // Report validation progress\n  const validationStart = Date.now()\n  spin.start(`Validating ${count(totalDocumentsToValidate, 'documents')}…`)\n\n  const results: DocumentValidationResult[] = []\n\n  const totals = {\n    errors: {documents: 0, markers: 0},\n    infos: {documents: 0, markers: 0},\n    valid: {documents: 0},\n    warnings: {documents: 0, markers: 0},\n  }\n\n  for await (const {validatedCount, ...result} of worker.stream.validation()) {\n    const {markers} = result\n\n    if (markers.length > 0) {\n      results.push(result)\n    }\n\n    const errors = markers.filter((marker) => marker.level === 'error')\n    const warnings = markers.filter((marker) => marker.level === 'warning')\n    const infos = markers.filter((marker) => marker.level === 'info')\n\n    if (markers.length === 0) {\n      totals.valid.documents += 1\n    }\n\n    if (errors.length > 0) {\n      totals.errors.documents += 1\n      totals.errors.markers += errors.length\n    }\n\n    if (warnings.length > 0) {\n      totals.warnings.documents += 1\n      totals.warnings.markers += warnings.length\n    }\n\n    if (infos.length > 0) {\n      totals.infos.documents += 1\n      totals.infos.markers += infos.length\n    }\n\n    spin.text =\n      `Validating ${count(totalDocumentsToValidate, 'documents')}…\\n\\n` +\n      `Processed ${count(validatedCount, 'documents')} (${percent(\n        validatedCount / totalDocumentsToValidate,\n      )}):\\n${summary(totals, flags.level)}`\n  }\n\n  spin.succeed(\n    `Validated ${count(totalDocumentsToValidate, 'documents')} ${seconds(validationStart)}`,\n  )\n  output.log(`\\nValidation results:\\n${summary(totals, flags.level)}`)\n\n  results.sort((a, b) => {\n    if (a.level === b.level) return a.documentType.localeCompare(b.documentType)\n    return levelValues[a.level] - levelValues[b.level]\n  })\n\n  let overallLevel: Level = 'info'\n\n  for (const result of results) {\n    if (result.level === 'error') overallLevel = 'error'\n    if (result.level === 'warning' && overallLevel !== 'error') overallLevel = 'warning'\n\n    output.log(`${formatDocumentValidation(result)}\\n`)\n  }\n\n  await worker.dispose()\n\n  return overallLevel\n}\n"],"names":["spinner","formatDocumentValidation","count","levelValues","percent","seconds","summary","pretty","flags","output","worker","workspaceLoadStart","Date","now","spin","workspace","start","event","loadedWorkspace","succeed","name","projectId","dataset","file","documentCount","loadedDocumentCount","downloadStart","text","downloadedCount","stream","exportProgress","percentage","totalDocumentsToValidate","exportFinished","referenceIntegrityStart","loadedReferenceIntegrity","validationStart","results","totals","errors","documents","markers","infos","valid","warnings","validatedCount","result","validation","length","push","filter","marker","level","log","sort","a","b","documentType","localeCompare","overallLevel","dispose"],"mappings":"AAAA,SAAQA,OAAO,QAAO,sBAAqB;AAI3C,SAAQC,wBAAwB,QAAO,gCAA+B;AACtE,SACEC,KAAK,EAELC,WAAW,EACXC,OAAO,EACPC,OAAO,EACPC,OAAO,QACF,YAAW;AAElB;;CAEC,GACD,OAAO,MAAMC,SAAoC,OAAO,EAACC,KAAK,EAAEC,MAAM,EAAEC,MAAM,EAAC;IAC7E,MAAMC,qBAAqBC,KAAKC,GAAG;IACnC,0BAA0B;IAC1B,MAAMC,OAAOd,QACXQ,MAAMO,SAAS,GAAG,CAAC,mBAAmB,EAAEP,MAAMO,SAAS,CAAC,EAAE,CAAC,GAAG,sBAC9DC,KAAK;IAEP,MAAMD,YAAY,MAAML,OAAOO,KAAK,CAACC,eAAe;IACpDJ,KAAKK,OAAO,CACV,CAAC,kBAAkB,EAAEJ,UAAUK,IAAI,CAAC,iBAAiB,EAAEL,UAAUM,SAAS,CAAC,eAAe,EACxFb,MAAMc,OAAO,IAAIP,UAAUO,OAAO,CACnC,EAAE,EAAEjB,QAAQM,qBAAqB;IAGpC,IAAI,CAACH,MAAMe,IAAI,EAAE;QACf,wBAAwB;QACxBT,KAAKE,KAAK,CAAC;QACX,MAAM,EAACQ,aAAa,EAAC,GAAG,MAAMd,OAAOO,KAAK,CAACQ,mBAAmB;QAE9D,yBAAyB;QACzB,MAAMC,gBAAgBd,KAAKC,GAAG;QAC9BC,KAAKa,IAAI,GAAG,CAAC,YAAY,EAAEzB,MAAMsB,eAAe,aAAa,CAAC,CAAC;QAC/D,WAAW,MAAM,EAACI,eAAe,EAAC,IAAIlB,OAAOmB,MAAM,CAACC,cAAc,GAAI;YACpE,MAAMC,aAAa3B,QAAQwB,kBAAkBJ;YAC7CV,KAAKa,IAAI,GAAG,CAAC,YAAY,EAAEzB,MAAMsB,eAAe,aAAa,EAAE,EAAEO,YAAY;QAC/E;QACAjB,KAAKK,OAAO,CAAC,CAAC,WAAW,EAAEjB,MAAMsB,eAAe,aAAa,CAAC,EAAEnB,QAAQqB,gBAAgB;IAC1F;IAEA,MAAM,EAACM,wBAAwB,EAAC,GAAG,MAAMtB,OAAOO,KAAK,CAACgB,cAAc;IAEpE,MAAMC,0BAA0BtB,KAAKC,GAAG;IACxCC,KAAKE,KAAK,CAAC,CAAC,6BAA6B,CAAC;IAC1C,MAAMN,OAAOO,KAAK,CAACkB,wBAAwB;IAC3CrB,KAAKK,OAAO,CAAC,CAAC,uBAAuB,EAAEd,QAAQ6B,0BAA0B;IAEzE,6BAA6B;IAC7B,MAAME,kBAAkBxB,KAAKC,GAAG;IAChCC,KAAKE,KAAK,CAAC,CAAC,WAAW,EAAEd,MAAM8B,0BAA0B,aAAa,CAAC,CAAC;IAExE,MAAMK,UAAsC,EAAE;IAE9C,MAAMC,SAAS;QACbC,QAAQ;YAACC,WAAW;YAAGC,SAAS;QAAC;QACjCC,OAAO;YAACF,WAAW;YAAGC,SAAS;QAAC;QAChCE,OAAO;YAACH,WAAW;QAAC;QACpBI,UAAU;YAACJ,WAAW;YAAGC,SAAS;QAAC;IACrC;IAEA,WAAW,MAAM,EAACI,cAAc,EAAE,GAAGC,QAAO,IAAIpC,OAAOmB,MAAM,CAACkB,UAAU,GAAI;QAC1E,MAAM,EAACN,OAAO,EAAC,GAAGK;QAElB,IAAIL,QAAQO,MAAM,GAAG,GAAG;YACtBX,QAAQY,IAAI,CAACH;QACf;QAEA,MAAMP,SAASE,QAAQS,MAAM,CAAC,CAACC,SAAWA,OAAOC,KAAK,KAAK;QAC3D,MAAMR,WAAWH,QAAQS,MAAM,CAAC,CAACC,SAAWA,OAAOC,KAAK,KAAK;QAC7D,MAAMV,QAAQD,QAAQS,MAAM,CAAC,CAACC,SAAWA,OAAOC,KAAK,KAAK;QAE1D,IAAIX,QAAQO,MAAM,KAAK,GAAG;YACxBV,OAAOK,KAAK,CAACH,SAAS,IAAI;QAC5B;QAEA,IAAID,OAAOS,MAAM,GAAG,GAAG;YACrBV,OAAOC,MAAM,CAACC,SAAS,IAAI;YAC3BF,OAAOC,MAAM,CAACE,OAAO,IAAIF,OAAOS,MAAM;QACxC;QAEA,IAAIJ,SAASI,MAAM,GAAG,GAAG;YACvBV,OAAOM,QAAQ,CAACJ,SAAS,IAAI;YAC7BF,OAAOM,QAAQ,CAACH,OAAO,IAAIG,SAASI,MAAM;QAC5C;QAEA,IAAIN,MAAMM,MAAM,GAAG,GAAG;YACpBV,OAAOI,KAAK,CAACF,SAAS,IAAI;YAC1BF,OAAOI,KAAK,CAACD,OAAO,IAAIC,MAAMM,MAAM;QACtC;QAEAlC,KAAKa,IAAI,GACP,CAAC,WAAW,EAAEzB,MAAM8B,0BAA0B,aAAa,KAAK,CAAC,GACjE,CAAC,UAAU,EAAE9B,MAAM2C,gBAAgB,aAAa,EAAE,EAAEzC,QAClDyC,iBAAiBb,0BACjB,IAAI,EAAE1B,QAAQgC,QAAQ9B,MAAM4C,KAAK,GAAG;IAC1C;IAEAtC,KAAKK,OAAO,CACV,CAAC,UAAU,EAAEjB,MAAM8B,0BAA0B,aAAa,CAAC,EAAE3B,QAAQ+B,kBAAkB;IAEzF3B,OAAO4C,GAAG,CAAC,CAAC,uBAAuB,EAAE/C,QAAQgC,QAAQ9B,MAAM4C,KAAK,GAAG;IAEnEf,QAAQiB,IAAI,CAAC,CAACC,GAAGC;QACf,IAAID,EAAEH,KAAK,KAAKI,EAAEJ,KAAK,EAAE,OAAOG,EAAEE,YAAY,CAACC,aAAa,CAACF,EAAEC,YAAY;QAC3E,OAAOtD,WAAW,CAACoD,EAAEH,KAAK,CAAC,GAAGjD,WAAW,CAACqD,EAAEJ,KAAK,CAAC;IACpD;IAEA,IAAIO,eAAsB;IAE1B,KAAK,MAAMb,UAAUT,QAAS;QAC5B,IAAIS,OAAOM,KAAK,KAAK,SAASO,eAAe;QAC7C,IAAIb,OAAOM,KAAK,KAAK,aAAaO,iBAAiB,SAASA,eAAe;QAE3ElD,OAAO4C,GAAG,CAAC,GAAGpD,yBAAyB6C,QAAQ,EAAE,CAAC;IACpD;IAEA,MAAMpC,OAAOkD,OAAO;IAEpB,OAAOD;AACT,EAAC"}

package/dist/actions/documents/validation/reporters/prettyReporter/util.d.ts

@@ -0,0 +1,53 @@
+import { type ValidationMarker } from '@sanity/types';
+import { Level } from '../../../types';
+export interface DocumentValidationResult {
+    documentId: string;
+    documentType: string;
+    level: Level;
+    markers: ValidationMarker[];
+    revision: string;
+    intentUrl?: string;
+}
+export declare const isTty: boolean;
+export declare const levelValues: {
+    readonly error: 0;
+    readonly info: 2;
+    readonly warning: 1;
+};
+/**
+ * Generates a formatted string that includes a numerical amount and a subject
+ * in plural or singular form. Note: the subject must end in `s`
+ */
+export declare const count: (amount: number, subject: string) => string;
+/**
+ * Given a decimal, this will return that number formatted as a percentage
+ */
+export declare const percent: (value: number) => string;
+/**
+ * Given a start time in milliseconds, this will output the time elapsed
+ * formatted in seconds
+ */
+export declare const seconds: (startTime: number) => string;
+interface ValidationTotals {
+    errors: {
+        documents: number;
+        markers: number;
+    };
+    infos: {
+        documents: number;
+        markers: number;
+    };
+    valid: {
+        documents: number;
+    };
+    warnings: {
+        documents: number;
+        markers: number;
+    };
+}
+/**
+ * Outputs summary text given an object of totals. Omits totals depending on the
+ * desired validation `level`
+ */
+export declare const summary: ({ errors, infos, valid, warnings }: ValidationTotals, level?: Level) => string;
+export {};

package/dist/actions/documents/validation/reporters/prettyReporter/util.js

@@ -0,0 +1,45 @@
+import { isatty } from 'node:tty';
+import { logSymbols } from '@sanity/cli-core/ux';
+export const isTty = isatty(1);
+export const levelValues = {
+    error: 0,
+    info: 2,
+    warning: 1
+};
+/**
+ * Generates a formatted string that includes a numerical amount and a subject
+ * in plural or singular form. Note: the subject must end in `s`
+ */ export const count = (amount, subject)=>`${amount.toLocaleString('en-US')} ${amount === 1 ? subject.slice(0, Math.max(0, subject.length - 1)) : subject}`;
+const percentageFormatter = new Intl.NumberFormat('en-US', {
+    maximumFractionDigits: 1,
+    minimumFractionDigits: 1,
+    style: 'percent'
+});
+/**
+ * Given a decimal, this will return that number formatted as a percentage
+ */ export const percent = (value)=>percentageFormatter.format(Math.min(value, 1));
+const secondFormatter = new Intl.NumberFormat('en-US', {
+    maximumFractionDigits: 1,
+    minimumFractionDigits: 1
+});
+/**
+ * Given a start time in milliseconds, this will output the time elapsed
+ * formatted in seconds
+ */ export const seconds = (startTime)=>{
+    const endTime = Date.now();
+    return `(${secondFormatter.format((endTime - startTime) / 1000)}s)`;
+};
+/**
+ * Outputs summary text given an object of totals. Omits totals depending on the
+ * desired validation `level`
+ */ export const summary = ({ errors, infos, valid, warnings }, level = 'warning')=>{
+    const levelValue = levelValues[level];
+    return [
+        `${logSymbols.success} Valid:    ${count(valid.documents, 'documents')}`,
+        `${logSymbols.error} Errors:   ${count(errors.documents, 'documents')}, ${count(errors.markers, 'errors')}`,
+        levelValue >= levelValues.warning && `${logSymbols.warning} Warnings: ${count(warnings.documents, 'documents')}, ${count(warnings.markers, 'warnings')}`,
+        levelValue >= levelValues.info && `${logSymbols.info} Info:     ${count(infos.documents, 'documents')}, ${count(infos.documents, 'markers')}`
+    ].filter(Boolean).join('\n');
+};
+
+//# sourceMappingURL=util.js.map

package/dist/actions/documents/validation/reporters/prettyReporter/util.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/actions/documents/validation/reporters/prettyReporter/util.ts"],"sourcesContent":["import {isatty} from 'node:tty'\n\nimport {logSymbols} from '@sanity/cli-core/ux'\nimport {type ValidationMarker} from '@sanity/types'\n\nimport {Level} from '../../../types'\n\nexport interface DocumentValidationResult {\n  documentId: string\n  documentType: string\n  level: Level\n  markers: ValidationMarker[]\n  revision: string\n\n  intentUrl?: string\n}\n\nexport const isTty = isatty(1)\nexport const levelValues = {error: 0, info: 2, warning: 1} as const\n\n/**\n * Generates a formatted string that includes a numerical amount and a subject\n * in plural or singular form. Note: the subject must end in `s`\n */\nexport const count = (amount: number, subject: string): string =>\n  `${amount.toLocaleString('en-US')} ${\n    amount === 1 ? subject.slice(0, Math.max(0, subject.length - 1)) : subject\n  }`\n\nconst percentageFormatter = new Intl.NumberFormat('en-US', {\n  maximumFractionDigits: 1,\n  minimumFractionDigits: 1,\n  style: 'percent',\n})\n\n/**\n * Given a decimal, this will return that number formatted as a percentage\n */\nexport const percent = (value: number): string => percentageFormatter.format(Math.min(value, 1))\n\nconst secondFormatter = new Intl.NumberFormat('en-US', {\n  maximumFractionDigits: 1,\n  minimumFractionDigits: 1,\n})\n\n/**\n * Given a start time in milliseconds, this will output the time elapsed\n * formatted in seconds\n */\nexport const seconds = (startTime: number): string => {\n  const endTime = Date.now()\n  return `(${secondFormatter.format((endTime - startTime) / 1000)}s)`\n}\n\ninterface ValidationTotals {\n  errors: {documents: number; markers: number}\n  infos: {documents: number; markers: number}\n  valid: {documents: number}\n  warnings: {documents: number; markers: number}\n}\n\n/**\n * Outputs summary text given an object of totals. Omits totals depending on the\n * desired validation `level`\n */\nexport const summary = (\n  {errors, infos, valid, warnings}: ValidationTotals,\n  level: Level = 'warning',\n): string => {\n  const levelValue = levelValues[level]\n\n  return [\n    `${logSymbols.success} Valid:    ${count(valid.documents, 'documents')}`,\n    `${logSymbols.error} Errors:   ${count(errors.documents, 'documents')}, ${count(\n      errors.markers,\n      'errors',\n    )}`,\n    levelValue >= levelValues.warning &&\n      `${logSymbols.warning} Warnings: ${count(warnings.documents, 'documents')}, ${count(\n        warnings.markers,\n        'warnings',\n      )}`,\n    levelValue >= levelValues.info &&\n      `${logSymbols.info} Info:     ${count(infos.documents, 'documents')}, ${count(\n        infos.documents,\n        'markers',\n      )}`,\n  ]\n    .filter(Boolean)\n    .join('\\n')\n}\n"],"names":["isatty","logSymbols","isTty","levelValues","error","info","warning","count","amount","subject","toLocaleString","slice","Math","max","length","percentageFormatter","Intl","NumberFormat","maximumFractionDigits","minimumFractionDigits","style","percent","value","format","min","secondFormatter","seconds","startTime","endTime","Date","now","summary","errors","infos","valid","warnings","level","levelValue","success","documents","markers","filter","Boolean","join"],"mappings":"AAAA,SAAQA,MAAM,QAAO,WAAU;AAE/B,SAAQC,UAAU,QAAO,sBAAqB;AAe9C,OAAO,MAAMC,QAAQF,OAAO,GAAE;AAC9B,OAAO,MAAMG,cAAc;IAACC,OAAO;IAAGC,MAAM;IAAGC,SAAS;AAAC,EAAU;AAEnE;;;CAGC,GACD,OAAO,MAAMC,QAAQ,CAACC,QAAgBC,UACpC,GAAGD,OAAOE,cAAc,CAAC,SAAS,CAAC,EACjCF,WAAW,IAAIC,QAAQE,KAAK,CAAC,GAAGC,KAAKC,GAAG,CAAC,GAAGJ,QAAQK,MAAM,GAAG,MAAML,SACnE,CAAA;AAEJ,MAAMM,sBAAsB,IAAIC,KAAKC,YAAY,CAAC,SAAS;IACzDC,uBAAuB;IACvBC,uBAAuB;IACvBC,OAAO;AACT;AAEA;;CAEC,GACD,OAAO,MAAMC,UAAU,CAACC,QAA0BP,oBAAoBQ,MAAM,CAACX,KAAKY,GAAG,CAACF,OAAO,IAAG;AAEhG,MAAMG,kBAAkB,IAAIT,KAAKC,YAAY,CAAC,SAAS;IACrDC,uBAAuB;IACvBC,uBAAuB;AACzB;AAEA;;;CAGC,GACD,OAAO,MAAMO,UAAU,CAACC;IACtB,MAAMC,UAAUC,KAAKC,GAAG;IACxB,OAAO,CAAC,CAAC,EAAEL,gBAAgBF,MAAM,CAAC,AAACK,CAAAA,UAAUD,SAAQ,IAAK,MAAM,EAAE,CAAC;AACrE,EAAC;AASD;;;CAGC,GACD,OAAO,MAAMI,UAAU,CACrB,EAACC,MAAM,EAAEC,KAAK,EAAEC,KAAK,EAAEC,QAAQ,EAAmB,EAClDC,QAAe,SAAS;IAExB,MAAMC,aAAalC,WAAW,CAACiC,MAAM;IAErC,OAAO;QACL,GAAGnC,WAAWqC,OAAO,CAAC,WAAW,EAAE/B,MAAM2B,MAAMK,SAAS,EAAE,cAAc;QACxE,GAAGtC,WAAWG,KAAK,CAAC,WAAW,EAAEG,MAAMyB,OAAOO,SAAS,EAAE,aAAa,EAAE,EAAEhC,MACxEyB,OAAOQ,OAAO,EACd,WACC;QACHH,cAAclC,YAAYG,OAAO,IAC/B,GAAGL,WAAWK,OAAO,CAAC,WAAW,EAAEC,MAAM4B,SAASI,SAAS,EAAE,aAAa,EAAE,EAAEhC,MAC5E4B,SAASK,OAAO,EAChB,aACC;QACLH,cAAclC,YAAYE,IAAI,IAC5B,GAAGJ,WAAWI,IAAI,CAAC,WAAW,EAAEE,MAAM0B,MAAMM,SAAS,EAAE,aAAa,EAAE,EAAEhC,MACtE0B,MAAMM,SAAS,EACf,YACC;KACN,CACEE,MAAM,CAACC,SACPC,IAAI,CAAC;AACV,EAAC"}