@sanity/plugin-kit 5.0.1 → 5.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,81 +1,12 @@
1
- import chalk from "chalk";
2
- import outdent from "outdent";
3
- import { log, sharedFlags, urls } from "./index.js";
4
- import childProcess from "child_process";
5
- import npmRunPath from "npm-run-path";
6
1
  import path from "path";
7
2
  import { ESLint } from "eslint";
3
+ import outdent from "outdent";
8
4
  import { mergedPackages, fileExists } from "./package.js";
5
+ import { log, urls, sharedFlags } from "./index.js";
9
6
  import * as ts from "typescript";
10
- function parseCommand(commandString) {
11
- const commandAndArg = commandString.replace(/ +/g, " ").split(" ");
12
- return {
13
- command: commandAndArg[0],
14
- args: commandAndArg.length > 1 ? commandAndArg.slice(1) : []
15
- };
16
- }
17
- async function runCommand(commandString) {
18
- log.info(`Running command: ${commandString}`);
19
- const { command, args } = parseCommand(commandString);
20
- let options = { stdio: "inherit", env: npmRunPath.env() };
21
- return options = process.platform === "win32" ? { ...options, shell: !0 } : options, new Promise((resolve, reject) => {
22
- childProcess.spawn(command, args, options).on("error", reject).on("close", (exitCode) => {
23
- resolve({ code: exitCode ?? 0 });
24
- });
25
- });
26
- }
27
- const splitLine = `
28
- ----------------------------------------------------------`, verifyFlags = {
29
- ...sharedFlags,
30
- single: {
31
- default: !1,
32
- type: "boolean"
33
- }
34
- };
35
- function disableCheckText(checkKey) {
36
- return chalk.grey(
37
- outdent`
38
- To skip this validation add the following to your package.json:
39
- "sanityPlugin": {
40
- "verifyPackage": {
41
- "${checkKey}": false
42
- }
43
- }
44
- `.trimStart()
45
- );
46
- }
47
- function createValidator(verifyConfig, flags, errors) {
48
- return async function(checkKey, task) {
49
- if (verifyConfig[checkKey] !== !1) {
50
- const result = await task();
51
- if (result?.length) {
52
- result.push(disableCheckText(checkKey));
53
- const errorMessage = result.join(`
54
-
55
- `);
56
- errors.push(errorMessage), log.error(`
57
- ` + errorMessage + splitLine);
58
- }
59
- }
60
- if (flags.single && errors.length)
61
- throw new Error(
62
- outdent`Detected outstanding upgrade issues.
63
-
64
- Fail-fast (--single) mode enabled, stopping validation here.
65
- `
66
- );
67
- };
68
- }
69
- async function runTscMaybe(verifyConfig, ts2) {
70
- if (ts2 && verifyConfig.tsc !== !1) {
71
- log.info("All checks ok, running Typescript compiler.");
72
- const { code } = await runCommand("tsc --build");
73
- if (code !== 0)
74
- throw new Error(`Compilation failed. See output above.
75
-
76
- ` + disableCheckText("tsc"));
77
- }
78
- }
7
+ import chalk from "chalk";
8
+ import childProcess from "child_process";
9
+ import npmRunPath from "npm-run-path";
79
10
  const removedImportSuffix = `imports where removed in Sanity v3. Please refer to the migration guide: ${urls.migrationGuideStudio}, or new API-reference docs: ${urls.refDocs}`;
80
11
  async function validateImports({ basePath }) {
81
12
  log.debug("Running ESLint with Sanity Studio import hints...");
@@ -124,7 +55,7 @@ async function validateImports({ basePath }) {
124
55
  };
125
56
  }).filter((r) => r.errorCount);
126
57
  if (onlyImportErrors.length) {
127
- const resultText = await (await eslint.loadFormatter("stylish")).format(onlyImportErrors), addtionalInfo = outdent`
58
+ const resultText = await (await eslint.loadFormatter("stylish")).format(onlyImportErrors), additionalInfo = outdent`
128
59
  ESLint detected Studio V2 imports that are no longer available.
129
60
  It is recommended configure @sanity/eslint-config-no-v2-imports for ESLint.
130
61
 
@@ -139,7 +70,7 @@ async function validateImports({ basePath }) {
139
70
 
140
71
  If the plugin package does not use eslint, disable this check.
141
72
  `;
142
- return [resultText + addtionalInfo];
73
+ return [resultText + additionalInfo];
143
74
  }
144
75
  } catch (e) {
145
76
  return log.error("Failed to run eslint check", e), [
@@ -154,12 +85,79 @@ async function validateImports({ basePath }) {
154
85
  }
155
86
  async function readTSConfig(options) {
156
87
  const { basePath, filename } = options, filePath = path.resolve(basePath, filename);
157
- if (await fileExists(filePath))
158
- return ts.readConfigFile(filePath, ts.sys.readFile).config ? ts.parseJsonConfigFileContent(
159
- ts.readConfigFile(filePath, ts.sys.readFile).config,
160
- ts.sys,
161
- basePath
162
- ) : void 0;
88
+ if (!await fileExists(filePath)) return;
89
+ const { config } = ts.readConfigFile(filePath, ts.sys.readFile);
90
+ if (config)
91
+ return ts.parseJsonConfigFileContent(config, ts.sys, basePath);
92
+ }
93
+ function parseCommand(commandString) {
94
+ const commandAndArg = commandString.replace(/ +/g, " ").split(" ");
95
+ return {
96
+ command: commandAndArg[0],
97
+ args: commandAndArg.length > 1 ? commandAndArg.slice(1) : []
98
+ };
99
+ }
100
+ async function runCommand(commandString) {
101
+ log.info(`Running command: ${commandString}`);
102
+ const { command, args } = parseCommand(commandString);
103
+ let options = { stdio: "inherit", env: npmRunPath.env() };
104
+ return options = process.platform === "win32" ? { ...options, shell: !0 } : options, new Promise((resolve, reject) => {
105
+ childProcess.spawn(command, args, options).on("error", reject).on("close", (exitCode) => {
106
+ resolve({ code: exitCode ?? 0 });
107
+ });
108
+ });
109
+ }
110
+ const splitLine = `
111
+ ----------------------------------------------------------`, verifyFlags = {
112
+ ...sharedFlags,
113
+ single: {
114
+ default: !1,
115
+ type: "boolean"
116
+ }
117
+ };
118
+ function disableCheckText(checkKey) {
119
+ return chalk.grey(
120
+ outdent`
121
+ To skip this validation add the following to your package.json:
122
+ "sanityPlugin": {
123
+ "verifyPackage": {
124
+ "${checkKey}": false
125
+ }
126
+ }
127
+ `.trimStart()
128
+ );
129
+ }
130
+ function createValidator(verifyConfig, flags, errors) {
131
+ return async function(checkKey, task) {
132
+ if (verifyConfig[checkKey] !== !1) {
133
+ const result = await task();
134
+ if (result?.length) {
135
+ result.push(disableCheckText(checkKey));
136
+ const errorMessage = result.join(`
137
+
138
+ `);
139
+ errors.push(errorMessage), log.error(`
140
+ ` + errorMessage + splitLine);
141
+ }
142
+ }
143
+ if (flags.single && errors.length)
144
+ throw new Error(
145
+ outdent`Detected outstanding upgrade issues.
146
+
147
+ Fail-fast (--single) mode enabled, stopping validation here.
148
+ `
149
+ );
150
+ };
151
+ }
152
+ async function runTscMaybe(verifyConfig, ts2) {
153
+ if (ts2 && verifyConfig.tsc !== !1) {
154
+ log.info("All checks ok, running TypeScript compiler.");
155
+ const { code } = await runCommand("tsc --build");
156
+ if (code !== 0)
157
+ throw new Error(`Compilation failed. See output above.
158
+
159
+ ` + disableCheckText("tsc"));
160
+ }
163
161
  }
164
162
  export {
165
163
  createValidator,
@@ -168,4 +166,4 @@ export {
168
166
  validateImports,
169
167
  verifyFlags
170
168
  };
171
- //# sourceMappingURL=ts.js.map
169
+ //# sourceMappingURL=verify-common.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"verify-common.js","sources":["../../src/dependencies/import-linter.ts","../../src/util/ts.ts","../../src/util/command-parser.ts","../../src/actions/verify/verify-common.ts"],"sourcesContent":["import path from 'path'\n\nimport {ESLint} from 'eslint'\nimport outdent from 'outdent'\n\nimport {mergedPackages} from '../configs/banned-packages'\nimport {urls} from '../constants'\nimport log from '../util/log'\n\nconst removedImportSuffix = `imports where removed in Sanity v3. Please refer to the migration guide: ${urls.migrationGuideStudio}, or new API-reference docs: ${urls.refDocs}`\n\nexport async function validateImports({basePath}: {basePath: string}): Promise<string[]> {\n log.debug('Running ESLint with Sanity Studio import hints...')\n const eslint = new ESLint({\n cwd: basePath,\n overrideConfig: {\n ignorePatterns: ['node_modules'],\n rules: {\n 'no-restricted-imports': [\n 'error',\n {\n patterns: [\n ...mergedPackages.map((packageName) => ({\n group: [`${packageName}*`],\n message: `Use sanity instead of ${packageName}.`,\n })),\n {\n group: ['config:*'],\n message: `config: imports are no longer supported. Please see the new plugin API for alternatives: ${urls.migrationGuideStudio}`,\n },\n {\n group: ['part:*'],\n message: `part: ${removedImportSuffix}`,\n },\n {\n group: ['all:part:*'],\n message: `all:part: ${removedImportSuffix}`,\n },\n {\n group: ['sanity:*'],\n message: `sanity: ${removedImportSuffix}`,\n },\n ],\n },\n ],\n },\n },\n })\n\n try {\n const results = await eslint.lintFiles([path.join(basePath, '**/*.{js,jsx,ts,tsx}')])\n\n const onlyImportErrors = results\n .map((r) => {\n const limitErrors = r.messages.filter((m) => m.ruleId === 'no-restricted-imports')\n return {\n ...r,\n messages: limitErrors,\n errorCount: limitErrors.length,\n }\n })\n .filter((r) => r.errorCount)\n\n if (onlyImportErrors.length) {\n const formatter = await eslint.loadFormatter('stylish')\n const resultText = await formatter.format(onlyImportErrors)\n\n const additionalInfo = outdent`\n ESLint detected Studio V2 imports that are no longer available.\n It is recommended configure @sanity/eslint-config-no-v2-imports for ESLint.\n\n Run:\n npm install --save-dev @sanity/eslint-config-no-v2-imports\n\n In .eslintrc add:\n \"extends\": [\"@sanity/no-v2-imports\"]\n\n This way, V2-imports can be identified directly in the IDE, or using eslint CLI.\n For more, see ${urls.linterPackage}\n\n If the plugin package does not use eslint, disable this check.\n `\n return [resultText + additionalInfo]\n }\n } catch (e) {\n log.error('Failed to run eslint check', e)\n return [\n outdent`\n Failed to run ESLint. Is ESLint configured?\n\n If the package does not use eslint, disable this check.\n `,\n ]\n }\n\n return []\n}\n","import path from 'path'\n\nimport * as ts from 'typescript'\n\nimport {fileExists} from './files'\n\nexport async function readTSConfig(options: {basePath: string; filename: string}) {\n const {basePath, filename} = options\n const filePath = path.resolve(basePath, filename)\n const exists = await fileExists(filePath)\n\n if (!exists) return undefined\n\n const {config} = ts.readConfigFile(filePath, ts.sys.readFile)\n\n if (!config) return undefined\n\n return ts.parseJsonConfigFileContent(config, ts.sys, basePath)\n}\n","import childProcess from 'child_process'\n\nimport npmRunPath from 'npm-run-path'\n\nimport log from './log'\n\ninterface Command {\n command: string\n args: string[]\n}\n\nfunction parseCommand(commandString: string): Command {\n const normalized = commandString.replace(/ +/g, ' ')\n const commandAndArg = normalized.split(' ')\n return {\n command: commandAndArg[0],\n args: commandAndArg.length > 1 ? commandAndArg.slice(1) : [],\n }\n}\n\nexport async function runCommand(commandString: string): Promise<{code: number}> {\n log.info(`Running command: ${commandString}`)\n const {command, args} = parseCommand(commandString)\n\n let options: any = {stdio: 'inherit', env: npmRunPath.env()}\n\n // ref: https://stackoverflow.com/questions/37459717/error-spawn-enoent-on-windows/37487465\n options = process.platform === 'win32' ? {...options, shell: true} : options\n\n return new Promise((resolve, reject) => {\n childProcess\n .spawn(command, args, options)\n .on('error', reject)\n .on('close', (exitCode) => {\n resolve({code: exitCode ?? 0})\n })\n })\n}\n","import chalk from 'chalk'\nimport type {TypedFlags} from 'meow'\nimport outdent from 'outdent'\nimport type {ParsedCommandLine} from 'typescript'\n\nimport sharedFlags from '../../sharedFlags'\nimport {runCommand} from '../../util/command-parser'\nimport log from '../../util/log'\n\nconst splitLine = `\\n----------------------------------------------------------`\n\nexport const verifyPackageConfigDefaults = {\n 'packageName': true,\n 'tsconfig': true,\n 'tsc': true,\n 'dependencies': true,\n 'deprecatedDependencies': true,\n 'babelConfig': true,\n 'sanityV2Json': true,\n 'eslintImports': true,\n 'scripts': true,\n 'pkg-utils': true,\n 'nodeEngine': true,\n 'studioConfig': true,\n 'srcIndex': true,\n 'duplicateConfig': true,\n} as const\n\nexport type VerifyPackageConfig = Partial<Record<keyof typeof verifyPackageConfigDefaults, boolean>>\n\nexport const verifyFlags = {\n ...sharedFlags,\n single: {\n default: false,\n type: 'boolean',\n },\n} as const\n\nexport type VerifyFlags = TypedFlags<typeof verifyFlags>\n\nfunction disableCheckText(checkKey: string) {\n return chalk.grey(\n outdent`\n To skip this validation add the following to your package.json:\n \"sanityPlugin\": {\n \"verifyPackage\": {\n \"${checkKey}\": false\n }\n }\n `.trimStart(),\n )\n}\n\nexport function createValidator(\n verifyConfig: VerifyPackageConfig,\n flags: VerifyFlags,\n errors: string[],\n) {\n return async function validation(\n checkKey: keyof VerifyPackageConfig,\n task: () => Promise<string[] | undefined>,\n ) {\n if (verifyConfig[checkKey] !== false) {\n const result = await task()\n if (result?.length) {\n result.push(disableCheckText(checkKey))\n const errorMessage = result.join('\\n\\n')\n errors.push(errorMessage)\n log.error(`\\n` + errorMessage + splitLine)\n }\n }\n\n if (flags.single && errors.length) {\n throw new Error(\n outdent`Detected outstanding upgrade issues.\n\n Fail-fast (--single) mode enabled, stopping validation here.\n `,\n )\n }\n }\n}\n\nexport async function runTscMaybe(verifyConfig: VerifyPackageConfig, ts?: ParsedCommandLine) {\n if (ts && verifyConfig.tsc !== false) {\n log.info('All checks ok, running TypeScript compiler.')\n const {code} = await runCommand('tsc --build')\n if (code !== 0) {\n throw new Error('Compilation failed. See output above.\\n\\n' + disableCheckText('tsc'))\n }\n }\n}\n"],"names":["ts"],"mappings":";;;;;;;;;AASA,MAAM,sBAAsB,4EAA4E,KAAK,oBAAoB,gCAAgC,KAAK,OAAO;AAE7K,eAAsB,gBAAgB,EAAC,YAAkD;AACvF,MAAI,MAAM,mDAAmD;AAC7D,QAAM,SAAS,IAAI,OAAO;AAAA,IACxB,KAAK;AAAA,IACL,gBAAgB;AAAA,MACd,gBAAgB,CAAC,cAAc;AAAA,MAC/B,OAAO;AAAA,QACL,yBAAyB;AAAA,UACvB;AAAA,UACA;AAAA,YACE,UAAU;AAAA,cACR,GAAG,eAAe,IAAI,CAAC,iBAAiB;AAAA,gBACtC,OAAO,CAAC,GAAG,WAAW,GAAG;AAAA,gBACzB,SAAS,yBAAyB,WAAW;AAAA,cAAA,EAC7C;AAAA,cACF;AAAA,gBACE,OAAO,CAAC,UAAU;AAAA,gBAClB,SAAS,4FAA4F,KAAK,oBAAoB;AAAA,cAAA;AAAA,cAEhI;AAAA,gBACE,OAAO,CAAC,QAAQ;AAAA,gBAChB,SAAS,SAAS,mBAAmB;AAAA,cAAA;AAAA,cAEvC;AAAA,gBACE,OAAO,CAAC,YAAY;AAAA,gBACpB,SAAS,aAAa,mBAAmB;AAAA,cAAA;AAAA,cAE3C;AAAA,gBACE,OAAO,CAAC,UAAU;AAAA,gBAClB,SAAS,WAAW,mBAAmB;AAAA,cAAA;AAAA,YACzC;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF,CACD;AAED,MAAI;AAGF,UAAM,oBAFU,MAAM,OAAO,UAAU,CAAC,KAAK,KAAK,UAAU,sBAAsB,CAAC,CAAC,GAGjF,IAAI,CAAC,MAAM;AACV,YAAM,cAAc,EAAE,SAAS,OAAO,CAAC,MAAM,EAAE,WAAW,uBAAuB;AACjF,aAAO;AAAA,QACL,GAAG;AAAA,QACH,UAAU;AAAA,QACV,YAAY,YAAY;AAAA,MAAA;AAAA,IAE5B,CAAC,EACA,OAAO,CAAC,MAAM,EAAE,UAAU;AAE7B,QAAI,iBAAiB,QAAQ;AAE3B,YAAM,aAAa,OADD,MAAM,OAAO,cAAc,SAAS,GACnB,OAAO,gBAAgB,GAEpD,iBAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAWL,KAAK,aAAa;AAAA;AAAA;AAAA;AAIpC,aAAO,CAAC,aAAa,cAAc;AAAA,IACrC;AAAA,EACF,SAAS,GAAG;AACV,WAAA,IAAI,MAAM,8BAA8B,CAAC,GAClC;AAAA,MACL;AAAA;AAAA;AAAA;AAAA;AAAA,IAAA;AAAA,EAMJ;AAEA,SAAO,CAAA;AACT;AC1FA,eAAsB,aAAa,SAA+C;AAChF,QAAM,EAAC,UAAU,SAAA,IAAY,SACvB,WAAW,KAAK,QAAQ,UAAU,QAAQ;AAGhD,MAAI,CAFW,MAAM,WAAW,QAAQ,EAE3B;AAEb,QAAM,EAAC,WAAU,GAAG,eAAe,UAAU,GAAG,IAAI,QAAQ;AAE5D,MAAK;AAEL,WAAO,GAAG,2BAA2B,QAAQ,GAAG,KAAK,QAAQ;AAC/D;ACPA,SAAS,aAAa,eAAgC;AAEpD,QAAM,gBADa,cAAc,QAAQ,OAAO,GAAG,EAClB,MAAM,GAAG;AAC1C,SAAO;AAAA,IACL,SAAS,cAAc,CAAC;AAAA,IACxB,MAAM,cAAc,SAAS,IAAI,cAAc,MAAM,CAAC,IAAI,CAAA;AAAA,EAAC;AAE/D;AAEA,eAAsB,WAAW,eAAgD;AAC/E,MAAI,KAAK,oBAAoB,aAAa,EAAE;AAC5C,QAAM,EAAC,SAAS,SAAQ,aAAa,aAAa;AAElD,MAAI,UAAe,EAAC,OAAO,WAAW,KAAK,WAAW,MAAI;AAG1D,SAAA,UAAU,QAAQ,aAAa,UAAU,EAAC,GAAG,SAAS,OAAO,GAAA,IAAQ,SAE9D,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,iBACG,MAAM,SAAS,MAAM,OAAO,EAC5B,GAAG,SAAS,MAAM,EAClB,GAAG,SAAS,CAAC,aAAa;AACzB,cAAQ,EAAC,MAAM,YAAY,EAAA,CAAE;AAAA,IAC/B,CAAC;AAAA,EACL,CAAC;AACH;AC5BA,MAAM,YAAY;AAAA,6DAqBL,cAAc;AAAA,EACzB,GAAG;AAAA,EACH,QAAQ;AAAA,IACN,SAAS;AAAA,IACT,MAAM;AAAA,EAAA;AAEV;AAIA,SAAS,iBAAiB,UAAkB;AAC1C,SAAO,MAAM;AAAA,IACX;AAAA;AAAA;AAAA;AAAA,uBAImB,QAAQ;AAAA;AAAA;AAAA,YAGnB,UAAA;AAAA,EAAU;AAEtB;AAEO,SAAS,gBACd,cACA,OACA,QACA;AACA,SAAO,eACL,UACA,MACA;AACA,QAAI,aAAa,QAAQ,MAAM,IAAO;AACpC,YAAM,SAAS,MAAM,KAAA;AACrB,UAAI,QAAQ,QAAQ;AAClB,eAAO,KAAK,iBAAiB,QAAQ,CAAC;AACtC,cAAM,eAAe,OAAO,KAAK;AAAA;AAAA,CAAM;AACvC,eAAO,KAAK,YAAY,GACxB,IAAI,MAAM;AAAA,IAAO,eAAe,SAAS;AAAA,MAC3C;AAAA,IACF;AAEA,QAAI,MAAM,UAAU,OAAO;AACzB,YAAM,IAAI;AAAA,QACR;AAAA;AAAA;AAAA;AAAA,MAAA;AAAA,EAMN;AACF;AAEA,eAAsB,YAAY,cAAmCA,KAAwB;AAC3F,MAAIA,OAAM,aAAa,QAAQ,IAAO;AACpC,QAAI,KAAK,6CAA6C;AACtD,UAAM,EAAC,KAAA,IAAQ,MAAM,WAAW,aAAa;AAC7C,QAAI,SAAS;AACX,YAAM,IAAI,MAAM;AAAA;AAAA,IAA8C,iBAAiB,KAAK,CAAC;AAAA,EAEzF;AACF;"}
@@ -3,7 +3,7 @@ import meow from "meow";
3
3
  import chalk from "chalk";
4
4
  import outdent from "outdent";
5
5
  import { log, urls, cliName, defaultOutDir } from "./index.js";
6
- import { readTSConfig, validateImports, runTscMaybe, createValidator, verifyFlags } from "./ts.js";
6
+ import { readTSConfig, validateImports, runTscMaybe, createValidator, verifyFlags } from "./verify-common.js";
7
7
  import { getPackage, validatePackageType, validatePkgUtilsVersion, validatePackageName, validatePkgUtilsDependency, validateSrcIndexFile, validateScripts, validateNodeEngine, disallowDuplicateEslintConfig, disallowDuplicatePrettierConfig, validateTsConfig, validatePluginSanityJson, validateBabelConfig, validateSanityDependencies, validateDeprecatedDependencies } from "./package.js";
8
8
  import { loadPackageConfig } from "./load-package-config.js";
9
9
  async function verifyPackage({ basePath, flags }) {
@@ -47,7 +47,7 @@ ${hardError}`);
47
47
 
48
48
  ${chalk.grey(
49
49
  `To fail-fast on first detected issue run:
50
- npx ${cliName} verify-package' --single`
50
+ npx ${cliName} verify-package --single`
51
51
  )}
52
52
  `.trimStart()
53
53
  );
@@ -1 +1 @@
1
- {"version":3,"file":"verify-package.js","sources":["../../src/actions/verify-package.ts","../../src/cmds/verify-package.ts"],"sourcesContent":["import chalk from 'chalk'\nimport outdent from 'outdent'\n\nimport {cliName, defaultOutDir, urls} from '../constants'\nimport {validateImports} from '../dependencies/import-linter'\nimport {getPackage} from '../npm/package'\nimport {loadPackageConfig} from '../util/load-package-config'\nimport log from '../util/log'\nimport {readTSConfig} from '../util/ts'\nimport {PackageJson} from './verify/types'\nimport {\n validateBabelConfig,\n validateNodeEngine,\n validatePackageName,\n validatePackageType,\n validatePkgUtilsDependency,\n validatePkgUtilsVersion,\n validatePluginSanityJson,\n validateDeprecatedDependencies,\n validateScripts,\n validateTsConfig,\n validateSanityDependencies,\n validateSrcIndexFile,\n disallowDuplicateEslintConfig,\n disallowDuplicatePrettierConfig,\n} from './verify/validations'\nimport {\n createValidator,\n runTscMaybe,\n VerifyFlags,\n VerifyPackageConfig,\n} from './verify/verify-common'\n\nexport async function verifyPackage({basePath, flags}: {basePath: string; flags: VerifyFlags}) {\n let errors: string[] = []\n\n const packageJson: PackageJson = await getPackage({basePath, validate: false})\n const verifyConfig: VerifyPackageConfig = packageJson.sanityPlugin?.verifyPackage || {}\n\n // Hard requirements (not configurable via sanityPlugin.verifyPackage): plugins must be ESM and\n // ship a compatible @sanity/pkg-utils, since plugin-kit loads package.config.ts through it.\n for (const hardError of [\n ...validatePackageType(packageJson),\n ...validatePkgUtilsVersion({basePath}),\n ]) {\n errors.push(hardError)\n log.error(`\\n${hardError}`)\n }\n\n // Load defensively: if the config can't be loaded (e.g. incompatible/missing pkg-utils), fall\n // back to defaults so the remaining checks still surface actionable issues.\n let packageConfig\n try {\n packageConfig = await loadPackageConfig({basePath})\n } catch (err) {\n log.debug('Failed to load package.config: %s', err)\n }\n const outDir = packageConfig?.dist ?? defaultOutDir\n const tsconfig = packageConfig?.tsconfig ?? 'tsconfig.json'\n\n const validation = createValidator(verifyConfig, flags, errors)\n\n const ts = await readTSConfig({basePath, filename: tsconfig})\n\n await validation('packageName', async () => validatePackageName(packageJson))\n await validation('pkg-utils', async () => validatePkgUtilsDependency(packageJson))\n await validation('srcIndex', async () => validateSrcIndexFile(basePath))\n await validation('scripts', async () => validateScripts(packageJson))\n await validation('nodeEngine', async () => validateNodeEngine(packageJson))\n await validation('duplicateConfig', async () =>\n disallowDuplicateEslintConfig(basePath, packageJson),\n )\n await validation('duplicateConfig', async () =>\n disallowDuplicatePrettierConfig(basePath, packageJson),\n )\n\n if (ts) {\n await validation('tsconfig', async () => validateTsConfig(ts, {basePath, outDir, tsconfig}))\n }\n\n await validation('sanityV2Json', async () => validatePluginSanityJson({basePath, packageJson}))\n\n await validation('babelConfig', async () => validateBabelConfig({basePath}))\n\n await validation('dependencies', async () => validateSanityDependencies(packageJson))\n await validation('deprecatedDependencies', async () =>\n validateDeprecatedDependencies(packageJson),\n )\n await validation('eslintImports', async () => validateImports({basePath}))\n\n if (errors.length) {\n throw new Error(\n outdent`\n Detected validation issues!\n To make this package Sanity v3 compatible, fix the issues starting from the top, or disable any checks you deem unnecessary.\n\n These issues assume the package uses @sanity/plugin-kit defaults for development and building.\n Refer to ${urls.pluginReadme} for configuration options.\n\n More information is available here:\n - Studio migration guide: ${urls.migrationGuideStudio}\n - Plugin migration guide: ${urls.migrationGuidePlugin}\n - Reference documentation: ${urls.refDocs}\n\n ${chalk.grey(\n `To fail-fast on first detected issue run:\\nnpx ${cliName} verify-package' --single`,\n )}\n `.trimStart(),\n )\n }\n\n await runTscMaybe(verifyConfig, ts)\n\n log.success(\n outdent`\n No outstanding upgrade issues detected.\n\n Suggested next steps:\n - Use plugin-kit to build and develop the plugin according to ${urls.pluginReadme}.\n - Build the plugin and fix any compilation errors\n - Test the plugin using the link-watch command\n `.trim(),\n )\n}\n","import path from 'path'\n\nimport meow from 'meow'\n\nimport {verifyPackage} from '../actions/verify-package'\nimport {verifyFlags} from '../actions/verify/verify-common'\nimport {cliName} from '../constants'\n\nconst description = `Verify that a Sanity plugin package is v3 compatible, and print upgrade steps if not.`\n\nconst help = `\nUsage\n $ ${cliName} verify-package [dir] [<args>]\n\nOptions\n --single Enables fail-fast mode: Will only output the first validation that fails.\n --silent Do not print info and warning messages\n --verbose Log everything. This option conflicts with --silent\n --version Output the version number\n --help Output usage information\n\nEach check will describe how they can be individually disabled.\n\nExamples\n # Verify Sanity plugin package in current directory\n $ ${cliName} verify-package\n\n # Verify Sanity plugin package in my-plugin directory in silent mode\n $ ${cliName} verify-package my-plugin-directory --silent\n`\n\nfunction run({argv}: {argv: string[]}) {\n const cli = meow(help, {flags: verifyFlags, argv, description})\n const basePath = path.resolve(cli.input[0] || process.cwd())\n return verifyPackage({basePath, flags: cli.flags})\n}\n\nexport default run\n"],"names":[],"mappings":";;;;;;;;AAiCA,eAAsB,cAAc,EAAC,UAAU,SAAgD;AAC7F,MAAI,SAAmB,CAAA;AAEvB,QAAM,cAA2B,MAAM,WAAW,EAAC,UAAU,UAAU,GAAA,CAAM,GACvE,eAAoC,YAAY,cAAc,iBAAiB,CAAA;AAIrF,aAAW,aAAa;AAAA,IACtB,GAAG,oBAAoB,WAAW;AAAA,IAClC,GAAG,wBAAwB,EAAC,SAAA,CAAS;AAAA,EAAA;AAErC,WAAO,KAAK,SAAS,GACrB,IAAI,MAAM;AAAA,EAAK,SAAS,EAAE;AAK5B,MAAI;AACJ,MAAI;AACF,oBAAgB,MAAM,kBAAkB,EAAC,UAAS;AAAA,EACpD,SAAS,KAAK;AACZ,QAAI,MAAM,qCAAqC,GAAG;AAAA,EACpD;AACA,QAAM,SAAS,eAAe,QAAQ,eAChC,WAAW,eAAe,YAAY,iBAEtC,aAAa,gBAAgB,cAAc,OAAO,MAAM,GAExD,KAAK,MAAM,aAAa,EAAC,UAAU,UAAU,UAAS;AA4B5D,MA1BA,MAAM,WAAW,eAAe,YAAY,oBAAoB,WAAW,CAAC,GAC5E,MAAM,WAAW,aAAa,YAAY,2BAA2B,WAAW,CAAC,GACjF,MAAM,WAAW,YAAY,YAAY,qBAAqB,QAAQ,CAAC,GACvE,MAAM,WAAW,WAAW,YAAY,gBAAgB,WAAW,CAAC,GACpE,MAAM,WAAW,cAAc,YAAY,mBAAmB,WAAW,CAAC,GAC1E,MAAM;AAAA,IAAW;AAAA,IAAmB,YAClC,8BAA8B,UAAU,WAAW;AAAA,EAAA,GAErD,MAAM;AAAA,IAAW;AAAA,IAAmB,YAClC,gCAAgC,UAAU,WAAW;AAAA,EAAA,GAGnD,MACF,MAAM,WAAW,YAAY,YAAY,iBAAiB,IAAI,EAAC,UAAU,QAAQ,SAAA,CAAS,CAAC,GAG7F,MAAM,WAAW,gBAAgB,YAAY,yBAAyB,EAAC,UAAU,aAAY,CAAC,GAE9F,MAAM,WAAW,eAAe,YAAY,oBAAoB,EAAC,SAAA,CAAS,CAAC,GAE3E,MAAM,WAAW,gBAAgB,YAAY,2BAA2B,WAAW,CAAC,GACpF,MAAM;AAAA,IAAW;AAAA,IAA0B,YACzC,+BAA+B,WAAW;AAAA,EAAA,GAE5C,MAAM,WAAW,iBAAiB,YAAY,gBAAgB,EAAC,SAAA,CAAS,CAAC,GAErE,OAAO;AACT,UAAM,IAAI;AAAA,MACR;AAAA;AAAA;AAAA;AAAA;AAAA,mBAKa,KAAK,YAAY;AAAA;AAAA;AAAA,oCAGA,KAAK,oBAAoB;AAAA,oCACzB,KAAK,oBAAoB;AAAA,qCACxB,KAAK,OAAO;AAAA;AAAA,UAEvC,MAAM;AAAA,QACN;AAAA,MAAkD,OAAO;AAAA,MAAA,CAC1D;AAAA,QACD,UAAA;AAAA,IAAU;AAIhB,QAAM,YAAY,cAAc,EAAE,GAElC,IAAI;AAAA,IACF;AAAA;AAAA;AAAA;AAAA,sEAIkE,KAAK,YAAY;AAAA;AAAA;AAAA,IAGnF,KAAA;AAAA,EAAK;AAET;ACnHA,MAAM,cAAc,yFAEd,OAAO;AAAA;AAAA,MAEP,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAaP,OAAO;AAAA;AAAA;AAAA,MAGP,OAAO;AAAA;AAGb,SAAS,IAAI,EAAC,QAAyB;AACrC,QAAM,MAAM,KAAK,MAAM,EAAC,OAAO,aAAa,MAAM,YAAA,CAAY,GACxD,WAAW,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,QAAQ,KAAK;AAC3D,SAAO,cAAc,EAAC,UAAU,OAAO,IAAI,OAAM;AACnD;"}
1
+ {"version":3,"file":"verify-package.js","sources":["../../src/actions/verify-package.ts","../../src/cmds/verify-package.ts"],"sourcesContent":["import chalk from 'chalk'\nimport outdent from 'outdent'\n\nimport {cliName, defaultOutDir, urls} from '../constants'\nimport {validateImports} from '../dependencies/import-linter'\nimport {getPackage} from '../npm/package'\nimport {loadPackageConfig} from '../util/load-package-config'\nimport log from '../util/log'\nimport {readTSConfig} from '../util/ts'\nimport type {PackageJson} from './verify/types'\nimport {\n validateBabelConfig,\n validateNodeEngine,\n validatePackageName,\n validatePackageType,\n validatePkgUtilsDependency,\n validatePkgUtilsVersion,\n validatePluginSanityJson,\n validateDeprecatedDependencies,\n validateScripts,\n validateTsConfig,\n validateSanityDependencies,\n validateSrcIndexFile,\n disallowDuplicateEslintConfig,\n disallowDuplicatePrettierConfig,\n} from './verify/validations'\nimport {\n createValidator,\n runTscMaybe,\n type VerifyFlags,\n type VerifyPackageConfig,\n} from './verify/verify-common'\n\nexport async function verifyPackage({basePath, flags}: {basePath: string; flags: VerifyFlags}) {\n let errors: string[] = []\n\n const packageJson: PackageJson = await getPackage({basePath, validate: false})\n const verifyConfig: VerifyPackageConfig = packageJson.sanityPlugin?.verifyPackage || {}\n\n // Hard requirements (not configurable via sanityPlugin.verifyPackage): plugins must be ESM and\n // ship a compatible @sanity/pkg-utils, since plugin-kit loads package.config.ts through it.\n for (const hardError of [\n ...validatePackageType(packageJson),\n ...validatePkgUtilsVersion({basePath}),\n ]) {\n errors.push(hardError)\n log.error(`\\n${hardError}`)\n }\n\n // Load defensively: if the config can't be loaded (e.g. incompatible/missing pkg-utils), fall\n // back to defaults so the remaining checks still surface actionable issues.\n let packageConfig\n try {\n packageConfig = await loadPackageConfig({basePath})\n } catch (err) {\n log.debug('Failed to load package.config: %s', err)\n }\n const outDir = packageConfig?.dist ?? defaultOutDir\n const tsconfig = packageConfig?.tsconfig ?? 'tsconfig.json'\n\n const validation = createValidator(verifyConfig, flags, errors)\n\n const ts = await readTSConfig({basePath, filename: tsconfig})\n\n await validation('packageName', async () => validatePackageName(packageJson))\n await validation('pkg-utils', async () => validatePkgUtilsDependency(packageJson))\n await validation('srcIndex', async () => validateSrcIndexFile(basePath))\n await validation('scripts', async () => validateScripts(packageJson))\n await validation('nodeEngine', async () => validateNodeEngine(packageJson))\n await validation('duplicateConfig', async () =>\n disallowDuplicateEslintConfig(basePath, packageJson),\n )\n await validation('duplicateConfig', async () =>\n disallowDuplicatePrettierConfig(basePath, packageJson),\n )\n\n if (ts) {\n await validation('tsconfig', async () => validateTsConfig(ts, {basePath, outDir, tsconfig}))\n }\n\n await validation('sanityV2Json', async () => validatePluginSanityJson({basePath, packageJson}))\n\n await validation('babelConfig', async () => validateBabelConfig({basePath}))\n\n await validation('dependencies', async () => validateSanityDependencies(packageJson))\n await validation('deprecatedDependencies', async () =>\n validateDeprecatedDependencies(packageJson),\n )\n await validation('eslintImports', async () => validateImports({basePath}))\n\n if (errors.length) {\n throw new Error(\n outdent`\n Detected validation issues!\n To make this package Sanity v3 compatible, fix the issues starting from the top, or disable any checks you deem unnecessary.\n\n These issues assume the package uses @sanity/plugin-kit defaults for development and building.\n Refer to ${urls.pluginReadme} for configuration options.\n\n More information is available here:\n - Studio migration guide: ${urls.migrationGuideStudio}\n - Plugin migration guide: ${urls.migrationGuidePlugin}\n - Reference documentation: ${urls.refDocs}\n\n ${chalk.grey(\n `To fail-fast on first detected issue run:\\nnpx ${cliName} verify-package --single`,\n )}\n `.trimStart(),\n )\n }\n\n await runTscMaybe(verifyConfig, ts)\n\n log.success(\n outdent`\n No outstanding upgrade issues detected.\n\n Suggested next steps:\n - Use plugin-kit to build and develop the plugin according to ${urls.pluginReadme}.\n - Build the plugin and fix any compilation errors\n - Test the plugin using the link-watch command\n `.trim(),\n )\n}\n","import path from 'path'\n\nimport meow from 'meow'\n\nimport {verifyPackage} from '../actions/verify-package'\nimport {verifyFlags} from '../actions/verify/verify-common'\nimport {cliName} from '../constants'\n\nconst description = `Verify that a Sanity plugin package is v3 compatible, and print upgrade steps if not.`\n\nconst help = `\nUsage\n $ ${cliName} verify-package [dir] [<args>]\n\nOptions\n --single Enables fail-fast mode: Will only output the first validation that fails.\n --silent Do not print info and warning messages\n --verbose Log everything. This option conflicts with --silent\n --version Output the version number\n --help Output usage information\n\nEach check will describe how they can be individually disabled.\n\nExamples\n # Verify Sanity plugin package in current directory\n $ ${cliName} verify-package\n\n # Verify Sanity plugin package in my-plugin directory in silent mode\n $ ${cliName} verify-package my-plugin-directory --silent\n`\n\nfunction run({argv}: {argv: string[]}) {\n const cli = meow(help, {flags: verifyFlags, argv, description})\n const basePath = path.resolve(cli.input[0] || process.cwd())\n return verifyPackage({basePath, flags: cli.flags})\n}\n\nexport default run\n"],"names":[],"mappings":";;;;;;;;AAiCA,eAAsB,cAAc,EAAC,UAAU,SAAgD;AAC7F,MAAI,SAAmB,CAAA;AAEvB,QAAM,cAA2B,MAAM,WAAW,EAAC,UAAU,UAAU,GAAA,CAAM,GACvE,eAAoC,YAAY,cAAc,iBAAiB,CAAA;AAIrF,aAAW,aAAa;AAAA,IACtB,GAAG,oBAAoB,WAAW;AAAA,IAClC,GAAG,wBAAwB,EAAC,SAAA,CAAS;AAAA,EAAA;AAErC,WAAO,KAAK,SAAS,GACrB,IAAI,MAAM;AAAA,EAAK,SAAS,EAAE;AAK5B,MAAI;AACJ,MAAI;AACF,oBAAgB,MAAM,kBAAkB,EAAC,UAAS;AAAA,EACpD,SAAS,KAAK;AACZ,QAAI,MAAM,qCAAqC,GAAG;AAAA,EACpD;AACA,QAAM,SAAS,eAAe,QAAQ,eAChC,WAAW,eAAe,YAAY,iBAEtC,aAAa,gBAAgB,cAAc,OAAO,MAAM,GAExD,KAAK,MAAM,aAAa,EAAC,UAAU,UAAU,UAAS;AA4B5D,MA1BA,MAAM,WAAW,eAAe,YAAY,oBAAoB,WAAW,CAAC,GAC5E,MAAM,WAAW,aAAa,YAAY,2BAA2B,WAAW,CAAC,GACjF,MAAM,WAAW,YAAY,YAAY,qBAAqB,QAAQ,CAAC,GACvE,MAAM,WAAW,WAAW,YAAY,gBAAgB,WAAW,CAAC,GACpE,MAAM,WAAW,cAAc,YAAY,mBAAmB,WAAW,CAAC,GAC1E,MAAM;AAAA,IAAW;AAAA,IAAmB,YAClC,8BAA8B,UAAU,WAAW;AAAA,EAAA,GAErD,MAAM;AAAA,IAAW;AAAA,IAAmB,YAClC,gCAAgC,UAAU,WAAW;AAAA,EAAA,GAGnD,MACF,MAAM,WAAW,YAAY,YAAY,iBAAiB,IAAI,EAAC,UAAU,QAAQ,SAAA,CAAS,CAAC,GAG7F,MAAM,WAAW,gBAAgB,YAAY,yBAAyB,EAAC,UAAU,aAAY,CAAC,GAE9F,MAAM,WAAW,eAAe,YAAY,oBAAoB,EAAC,SAAA,CAAS,CAAC,GAE3E,MAAM,WAAW,gBAAgB,YAAY,2BAA2B,WAAW,CAAC,GACpF,MAAM;AAAA,IAAW;AAAA,IAA0B,YACzC,+BAA+B,WAAW;AAAA,EAAA,GAE5C,MAAM,WAAW,iBAAiB,YAAY,gBAAgB,EAAC,SAAA,CAAS,CAAC,GAErE,OAAO;AACT,UAAM,IAAI;AAAA,MACR;AAAA;AAAA;AAAA;AAAA;AAAA,mBAKa,KAAK,YAAY;AAAA;AAAA;AAAA,oCAGA,KAAK,oBAAoB;AAAA,oCACzB,KAAK,oBAAoB;AAAA,qCACxB,KAAK,OAAO;AAAA;AAAA,UAEvC,MAAM;AAAA,QACN;AAAA,MAAkD,OAAO;AAAA,MAAA,CAC1D;AAAA,QACD,UAAA;AAAA,IAAU;AAIhB,QAAM,YAAY,cAAc,EAAE,GAElC,IAAI;AAAA,IACF;AAAA;AAAA;AAAA;AAAA,sEAIkE,KAAK,YAAY;AAAA;AAAA;AAAA,IAGnF,KAAA;AAAA,EAAK;AAET;ACnHA,MAAM,cAAc,yFAEd,OAAO;AAAA;AAAA,MAEP,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAaP,OAAO;AAAA;AAAA;AAAA,MAGP,OAAO;AAAA;AAGb,SAAS,IAAI,EAAC,QAAyB;AACrC,QAAM,MAAM,KAAK,MAAM,EAAC,OAAO,aAAa,MAAM,YAAA,CAAY,GACxD,WAAW,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,QAAQ,KAAK;AAC3D,SAAO,cAAc,EAAC,UAAU,OAAO,IAAI,OAAM;AACnD;"}
@@ -3,7 +3,7 @@ import meow from "meow";
3
3
  import chalk from "chalk";
4
4
  import outdent from "outdent";
5
5
  import { urls, cliName, log } from "./index.js";
6
- import { readTSConfig, validateImports, runTscMaybe, createValidator, verifyFlags } from "./ts.js";
6
+ import { readTSConfig, validateImports, runTscMaybe, createValidator, verifyFlags } from "./verify-common.js";
7
7
  import { getPackage, validateStudioConfig, validateSanityDependencies } from "./package.js";
8
8
  import { loadPackageConfig } from "./load-package-config.js";
9
9
  async function verifyStudio({ basePath, flags }) {
@@ -1 +1 @@
1
- {"version":3,"file":"verify-studio.js","sources":["../../src/actions/verify-studio.ts","../../src/cmds/verify-studio.ts"],"sourcesContent":["import chalk from 'chalk'\nimport outdent from 'outdent'\n\nimport {cliName, urls} from '../constants'\nimport {validateImports} from '../dependencies/import-linter'\nimport {getPackage} from '../npm/package'\nimport {loadPackageConfig} from '../util/load-package-config'\nimport log from '../util/log'\nimport {readTSConfig} from '../util/ts'\nimport {PackageJson} from './verify/types'\nimport {validateSanityDependencies, validateStudioConfig} from './verify/validations'\nimport {\n createValidator,\n runTscMaybe,\n VerifyFlags,\n VerifyPackageConfig,\n} from './verify/verify-common'\n\nexport async function verifyStudio({basePath, flags}: {basePath: string; flags: VerifyFlags}) {\n let errors: string[] = []\n\n const packageJson: PackageJson = await getPackage({basePath, validate: false})\n const verifyConfig: VerifyPackageConfig = packageJson.sanityPlugin?.verifyPackage || {}\n const packageConfig = await loadPackageConfig({basePath})\n const tsconfig = packageConfig?.tsconfig ?? 'tsconfig.json'\n\n const validation = createValidator(verifyConfig, flags, errors)\n\n const ts = await readTSConfig({basePath, filename: tsconfig})\n\n await validation('studioConfig', async () => validateStudioConfig({basePath}))\n await validation('dependencies', async () => validateSanityDependencies(packageJson))\n await validation('eslintImports', async () => validateImports({basePath}))\n\n if (errors.length) {\n throw new Error(\n outdent`\n Detected validation issues!\n This Sanity Studio is not completely V3 ready. Fix the issues starting from the top, or disable any checks you deem unnecessary.\n\n More information is available here:\n - Migration guide: ${urls.migrationGuideStudio}\n - Reference documentation: ${urls.refDocs}\n\n ${chalk.grey(\n `To fail-fast on first detected issue run:\\nnpx ${cliName} verify-studio --single`,\n )}\n `.trimStart(),\n )\n }\n\n await runTscMaybe(verifyConfig, ts)\n\n log.success(\n outdent`\n No outstanding upgrade issues detected. Studio is V3 ready!\n `.trim(),\n )\n}\n","import path from 'path'\n\nimport meow from 'meow'\n\nimport {verifyStudio} from '../actions/verify-studio'\nimport {verifyFlags} from '../actions/verify/verify-common'\nimport {cliName} from '../constants'\n\nconst description = `Verify that a Sanity Studio is configured correctly for v3, and print upgrade steps if not.`\n\nconst help = `\nUsage\n $ ${cliName} verify-studio [dir] [<args>]\n\nOptions\n --single Enables fail-fast mode: Will only output the first validation that fails.\n --silent Do not print info and warning messages\n --verbose Log everything. This option conflicts with --silent\n --version Output the version number\n --help Output usage information\n\nEach check will describe how they can be individually disabled.\n\nExamples\n # Verify Sanity Studio in current directory\n $ ${cliName} verify-studio\n\n # Verify Sanity Studio in my-sanity-studio directory in silent mode\n $ ${cliName} verify-studio my-sanity-studio --silent\n`\n\nfunction run({argv}: {argv: string[]}) {\n const cli = meow(help, {flags: verifyFlags, argv, description})\n const basePath = path.resolve(cli.input[0] || process.cwd())\n return verifyStudio({basePath, flags: cli.flags})\n}\n\nexport default run\n"],"names":[],"mappings":";;;;;;;;AAkBA,eAAsB,aAAa,EAAC,UAAU,SAAgD;AAC5F,MAAI,SAAmB,CAAA;AAEvB,QAAM,cAA2B,MAAM,WAAW,EAAC,UAAU,UAAU,GAAA,CAAM,GACvE,eAAoC,YAAY,cAAc,iBAAiB,CAAA,GAE/E,YADgB,MAAM,kBAAkB,EAAC,SAAA,CAAS,IACxB,YAAY,iBAEtC,aAAa,gBAAgB,cAAc,OAAO,MAAM,GAExD,KAAK,MAAM,aAAa,EAAC,UAAU,UAAU,UAAS;AAM5D,MAJA,MAAM,WAAW,gBAAgB,YAAY,qBAAqB,EAAC,SAAA,CAAS,CAAC,GAC7E,MAAM,WAAW,gBAAgB,YAAY,2BAA2B,WAAW,CAAC,GACpF,MAAM,WAAW,iBAAiB,YAAY,gBAAgB,EAAC,SAAA,CAAS,CAAC,GAErE,OAAO;AACT,UAAM,IAAI;AAAA,MACR;AAAA;AAAA;AAAA;AAAA;AAAA,6BAKuB,KAAK,oBAAoB;AAAA,qCACjB,KAAK,OAAO;AAAA;AAAA,UAEvC,MAAM;AAAA,QACN;AAAA,MAAkD,OAAO;AAAA,MAAA,CAC1D;AAAA,QACD,UAAA;AAAA,IAAU;AAIhB,QAAM,YAAY,cAAc,EAAE,GAElC,IAAI;AAAA,IACF;AAAA;AAAA,IAEA,KAAA;AAAA,EAAK;AAET;AClDA,MAAM,cAAc,+FAEd,OAAO;AAAA;AAAA,MAEP,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAaP,OAAO;AAAA;AAAA;AAAA,MAGP,OAAO;AAAA;AAGb,SAAS,IAAI,EAAC,QAAyB;AACrC,QAAM,MAAM,KAAK,MAAM,EAAC,OAAO,aAAa,MAAM,YAAA,CAAY,GACxD,WAAW,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,QAAQ,KAAK;AAC3D,SAAO,aAAa,EAAC,UAAU,OAAO,IAAI,OAAM;AAClD;"}
1
+ {"version":3,"file":"verify-studio.js","sources":["../../src/actions/verify-studio.ts","../../src/cmds/verify-studio.ts"],"sourcesContent":["import chalk from 'chalk'\nimport outdent from 'outdent'\n\nimport {cliName, urls} from '../constants'\nimport {validateImports} from '../dependencies/import-linter'\nimport {getPackage} from '../npm/package'\nimport {loadPackageConfig} from '../util/load-package-config'\nimport log from '../util/log'\nimport {readTSConfig} from '../util/ts'\nimport type {PackageJson} from './verify/types'\nimport {validateSanityDependencies, validateStudioConfig} from './verify/validations'\nimport {\n createValidator,\n runTscMaybe,\n type VerifyFlags,\n type VerifyPackageConfig,\n} from './verify/verify-common'\n\nexport async function verifyStudio({basePath, flags}: {basePath: string; flags: VerifyFlags}) {\n let errors: string[] = []\n\n const packageJson: PackageJson = await getPackage({basePath, validate: false})\n const verifyConfig: VerifyPackageConfig = packageJson.sanityPlugin?.verifyPackage || {}\n const packageConfig = await loadPackageConfig({basePath})\n const tsconfig = packageConfig?.tsconfig ?? 'tsconfig.json'\n\n const validation = createValidator(verifyConfig, flags, errors)\n\n const ts = await readTSConfig({basePath, filename: tsconfig})\n\n await validation('studioConfig', async () => validateStudioConfig({basePath}))\n await validation('dependencies', async () => validateSanityDependencies(packageJson))\n await validation('eslintImports', async () => validateImports({basePath}))\n\n if (errors.length) {\n throw new Error(\n outdent`\n Detected validation issues!\n This Sanity Studio is not completely V3 ready. Fix the issues starting from the top, or disable any checks you deem unnecessary.\n\n More information is available here:\n - Migration guide: ${urls.migrationGuideStudio}\n - Reference documentation: ${urls.refDocs}\n\n ${chalk.grey(\n `To fail-fast on first detected issue run:\\nnpx ${cliName} verify-studio --single`,\n )}\n `.trimStart(),\n )\n }\n\n await runTscMaybe(verifyConfig, ts)\n\n log.success(\n outdent`\n No outstanding upgrade issues detected. Studio is V3 ready!\n `.trim(),\n )\n}\n","import path from 'path'\n\nimport meow from 'meow'\n\nimport {verifyStudio} from '../actions/verify-studio'\nimport {verifyFlags} from '../actions/verify/verify-common'\nimport {cliName} from '../constants'\n\nconst description = `Verify that a Sanity Studio is configured correctly for v3, and print upgrade steps if not.`\n\nconst help = `\nUsage\n $ ${cliName} verify-studio [dir] [<args>]\n\nOptions\n --single Enables fail-fast mode: Will only output the first validation that fails.\n --silent Do not print info and warning messages\n --verbose Log everything. This option conflicts with --silent\n --version Output the version number\n --help Output usage information\n\nEach check will describe how they can be individually disabled.\n\nExamples\n # Verify Sanity Studio in current directory\n $ ${cliName} verify-studio\n\n # Verify Sanity Studio in my-sanity-studio directory in silent mode\n $ ${cliName} verify-studio my-sanity-studio --silent\n`\n\nfunction run({argv}: {argv: string[]}) {\n const cli = meow(help, {flags: verifyFlags, argv, description})\n const basePath = path.resolve(cli.input[0] || process.cwd())\n return verifyStudio({basePath, flags: cli.flags})\n}\n\nexport default run\n"],"names":[],"mappings":";;;;;;;;AAkBA,eAAsB,aAAa,EAAC,UAAU,SAAgD;AAC5F,MAAI,SAAmB,CAAA;AAEvB,QAAM,cAA2B,MAAM,WAAW,EAAC,UAAU,UAAU,GAAA,CAAM,GACvE,eAAoC,YAAY,cAAc,iBAAiB,CAAA,GAE/E,YADgB,MAAM,kBAAkB,EAAC,SAAA,CAAS,IACxB,YAAY,iBAEtC,aAAa,gBAAgB,cAAc,OAAO,MAAM,GAExD,KAAK,MAAM,aAAa,EAAC,UAAU,UAAU,UAAS;AAM5D,MAJA,MAAM,WAAW,gBAAgB,YAAY,qBAAqB,EAAC,SAAA,CAAS,CAAC,GAC7E,MAAM,WAAW,gBAAgB,YAAY,2BAA2B,WAAW,CAAC,GACpF,MAAM,WAAW,iBAAiB,YAAY,gBAAgB,EAAC,SAAA,CAAS,CAAC,GAErE,OAAO;AACT,UAAM,IAAI;AAAA,MACR;AAAA;AAAA;AAAA;AAAA;AAAA,6BAKuB,KAAK,oBAAoB;AAAA,qCACjB,KAAK,OAAO;AAAA;AAAA,UAEvC,MAAM;AAAA,QACN;AAAA,MAAkD,OAAO;AAAA,MAAA,CAC1D;AAAA,QACD,UAAA;AAAA,IAAU;AAIhB,QAAM,YAAY,cAAc,EAAE,GAElC,IAAI;AAAA,IACF;AAAA;AAAA,IAEA,KAAA;AAAA,EAAK;AAET;AClDA,MAAM,cAAc,+FAEd,OAAO;AAAA;AAAA,MAEP,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAaP,OAAO;AAAA;AAAA;AAAA,MAGP,OAAO;AAAA;AAGb,SAAS,IAAI,EAAC,QAAyB;AACrC,QAAM,MAAM,KAAK,MAAM,EAAC,OAAO,aAAa,MAAM,YAAA,CAAY,GACxD,WAAW,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,QAAQ,KAAK;AAC3D,SAAO,aAAa,EAAC,UAAU,OAAO,IAAI,OAAM;AAClD;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sanity/plugin-kit",
3
- "version": "5.0.1",
3
+ "version": "5.0.3",
4
4
  "description": "Enhanced Sanity.io plugin development experience",
5
5
  "keywords": [
6
6
  "bootstrap",
@@ -45,7 +45,7 @@
45
45
  "get-latest-version": "^5.1.0",
46
46
  "git-remote-origin-url": "^3.1.0",
47
47
  "github-url-to-object": "^4.0.6",
48
- "inquirer": "^8.2.6",
48
+ "inquirer": "^8.2.7",
49
49
  "json5": "^2.2.3",
50
50
  "meow": "^9.0.0",
51
51
  "nodemon": "3.1.0",
@@ -53,7 +53,7 @@
53
53
  "outdent": "^0.8.0",
54
54
  "p-any": "^3.0.0",
55
55
  "p-props": "^4.0.0",
56
- "validate-npm-package-name": "^5.0.0",
56
+ "validate-npm-package-name": "^8.0.0",
57
57
  "xdg-basedir": "^4.0.0",
58
58
  "yalc": "1.0.0-pre.53"
59
59
  },
@@ -71,7 +71,7 @@
71
71
  "eslint-config-sanity": "^7.1.2",
72
72
  "eslint-plugin-prettier": "^5.2.1",
73
73
  "eslint-plugin-react": "^7.37.0",
74
- "eslint-plugin-react-hooks": "^4.6.2",
74
+ "eslint-plugin-react-hooks": "^7.1.1",
75
75
  "prettier": "^3.3.3",
76
76
  "react": "^19.2.7",
77
77
  "react-dom": "^19.2.7",
@@ -1 +0,0 @@
1
- {"version":3,"file":"ts.js","sources":["../../src/util/command-parser.ts","../../src/actions/verify/verify-common.ts","../../src/dependencies/import-linter.ts","../../src/util/ts.ts"],"sourcesContent":["import childProcess from 'child_process'\n\nimport npmRunPath from 'npm-run-path'\n\nimport log from './log'\n\ninterface Command {\n command: string\n args: string[]\n}\n\nfunction parseCommand(commandString: string): Command {\n const normalized = commandString.replace(/ +/g, ' ')\n const commandAndArg = normalized.split(' ')\n return {\n command: commandAndArg[0],\n args: commandAndArg.length > 1 ? commandAndArg.slice(1) : [],\n }\n}\n\nexport async function runCommand(commandString: string): Promise<{code: number}> {\n log.info(`Running command: ${commandString}`)\n const {command, args} = parseCommand(commandString)\n\n let options: any = {stdio: 'inherit', env: npmRunPath.env()}\n\n // ref: https://stackoverflow.com/questions/37459717/error-spawn-enoent-on-windows/37487465\n options = process.platform === 'win32' ? {...options, shell: true} : options\n\n return new Promise((resolve, reject) => {\n childProcess\n .spawn(command, args, options)\n .on('error', reject)\n .on('close', (exitCode) => {\n resolve({code: exitCode ?? 0})\n })\n })\n}\n","import chalk from 'chalk'\nimport {TypedFlags} from 'meow'\nimport outdent from 'outdent'\nimport {ParsedCommandLine} from 'typescript'\n\nimport sharedFlags from '../../sharedFlags'\nimport {runCommand} from '../../util/command-parser'\nimport log from '../../util/log'\n\nconst splitLine = `\\n----------------------------------------------------------`\n\nexport const verifyPackageConfigDefaults = {\n 'packageName': true,\n 'tsconfig': true,\n 'tsc': true,\n 'dependencies': true,\n 'deprecatedDependencies': true,\n 'babelConfig': true,\n 'sanityV2Json': true,\n 'eslintImports': true,\n 'scripts': true,\n 'pkg-utils': true,\n 'nodeEngine': true,\n 'studioConfig': true,\n 'srcIndex': true,\n 'duplicateConfig': true,\n} as const\n\nexport type VerifyPackageConfig = Partial<Record<keyof typeof verifyPackageConfigDefaults, boolean>>\n\nexport const verifyFlags = {\n ...sharedFlags,\n single: {\n default: false,\n type: 'boolean',\n },\n} as const\n\nexport type VerifyFlags = TypedFlags<typeof verifyFlags>\n\nfunction disableCheckText(checkKey: string) {\n return chalk.grey(\n outdent`\n To skip this validation add the following to your package.json:\n \"sanityPlugin\": {\n \"verifyPackage\": {\n \"${checkKey}\": false\n }\n }\n `.trimStart(),\n )\n}\n\nexport function createValidator(\n verifyConfig: VerifyPackageConfig,\n flags: VerifyFlags,\n errors: string[],\n) {\n return async function validation(\n checkKey: keyof VerifyPackageConfig,\n task: () => Promise<string[] | undefined>,\n ) {\n if (verifyConfig[checkKey] !== false) {\n const result = await task()\n if (result?.length) {\n result.push(disableCheckText(checkKey))\n const errorMessage = result.join('\\n\\n')\n errors.push(errorMessage)\n log.error(`\\n` + errorMessage + splitLine)\n }\n }\n\n if (flags.single && errors.length) {\n throw new Error(\n outdent`Detected outstanding upgrade issues.\n\n Fail-fast (--single) mode enabled, stopping validation here.\n `,\n )\n }\n }\n}\n\nexport async function runTscMaybe(verifyConfig: VerifyPackageConfig, ts?: ParsedCommandLine) {\n if (ts && verifyConfig.tsc !== false) {\n log.info('All checks ok, running Typescript compiler.')\n const {code} = await runCommand('tsc --build')\n if (code !== 0) {\n throw new Error('Compilation failed. See output above.\\n\\n' + disableCheckText('tsc'))\n }\n }\n}\n","import path from 'path'\n\nimport {ESLint} from 'eslint'\nimport outdent from 'outdent'\n\nimport {mergedPackages} from '../configs/banned-packages'\nimport {urls} from '../constants'\nimport log from '../util/log'\n\nconst removedImportSuffix = `imports where removed in Sanity v3. Please refer to the migration guide: ${urls.migrationGuideStudio}, or new API-reference docs: ${urls.refDocs}`\n\nexport async function validateImports({basePath}: {basePath: string}): Promise<string[]> {\n log.debug('Running ESLint with Sanity Studio import hints...')\n const eslint = new ESLint({\n cwd: basePath,\n overrideConfig: {\n ignorePatterns: ['node_modules'],\n rules: {\n 'no-restricted-imports': [\n 'error',\n {\n patterns: [\n ...mergedPackages.map((packageName) => ({\n group: [`${packageName}*`],\n message: `Use sanity instead of ${packageName}.`,\n })),\n {\n group: ['config:*'],\n message: `config: imports are no longer supported. Please see the new plugin API for alternatives: ${urls.migrationGuideStudio}`,\n },\n {\n group: ['part:*'],\n message: `part: ${removedImportSuffix}`,\n },\n {\n group: ['all:part:*'],\n message: `all:part: ${removedImportSuffix}`,\n },\n {\n group: ['sanity:*'],\n message: `sanity: ${removedImportSuffix}`,\n },\n ],\n },\n ],\n },\n },\n })\n\n try {\n const results = await eslint.lintFiles([path.join(basePath, '**/*.{js,jsx,ts,tsx}')])\n\n const onlyImportErrors = results\n .map((r) => {\n const limitErrors = r.messages.filter((m) => m.ruleId === 'no-restricted-imports')\n return {\n ...r,\n messages: limitErrors,\n errorCount: limitErrors.length,\n }\n })\n .filter((r) => r.errorCount)\n\n if (onlyImportErrors.length) {\n const formatter = await eslint.loadFormatter('stylish')\n const resultText = await formatter.format(onlyImportErrors)\n\n const addtionalInfo = outdent`\n ESLint detected Studio V2 imports that are no longer available.\n It is recommended configure @sanity/eslint-config-no-v2-imports for ESLint.\n\n Run:\n npm install --save-dev @sanity/eslint-config-no-v2-imports\n\n In .eslintrc add:\n \"extends\": [\"@sanity/no-v2-imports\"]\n\n This way, V2-imports can be identified directly in the IDE, or using eslint CLI.\n For more, see ${urls.linterPackage}\n\n If the plugin package does not use eslint, disable this check.\n `\n return [resultText + addtionalInfo]\n }\n } catch (e) {\n log.error('Failed to run eslint check', e)\n return [\n outdent`\n Failed to run ESLint. Is ESLint configured?\n\n If the package does not use eslint, disable this check.\n `,\n ]\n }\n\n return []\n}\n","import path from 'path'\n\nimport * as ts from 'typescript'\n\nimport {fileExists} from './files'\n\nexport async function readTSConfig(options: {basePath: string; filename: string}) {\n const {basePath, filename} = options\n const filePath = path.resolve(basePath, filename)\n const exists = await fileExists(filePath)\n\n if (!exists) return undefined\n\n return ts.readConfigFile(filePath, ts.sys.readFile).config\n ? ts.parseJsonConfigFileContent(\n ts.readConfigFile(filePath, ts.sys.readFile).config,\n ts.sys,\n basePath,\n )\n : undefined\n}\n"],"names":["ts"],"mappings":";;;;;;;;;AAWA,SAAS,aAAa,eAAgC;AAEpD,QAAM,gBADa,cAAc,QAAQ,OAAO,GAAG,EAClB,MAAM,GAAG;AAC1C,SAAO;AAAA,IACL,SAAS,cAAc,CAAC;AAAA,IACxB,MAAM,cAAc,SAAS,IAAI,cAAc,MAAM,CAAC,IAAI,CAAA;AAAA,EAAC;AAE/D;AAEA,eAAsB,WAAW,eAAgD;AAC/E,MAAI,KAAK,oBAAoB,aAAa,EAAE;AAC5C,QAAM,EAAC,SAAS,SAAQ,aAAa,aAAa;AAElD,MAAI,UAAe,EAAC,OAAO,WAAW,KAAK,WAAW,MAAI;AAG1D,SAAA,UAAU,QAAQ,aAAa,UAAU,EAAC,GAAG,SAAS,OAAO,GAAA,IAAQ,SAE9D,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,iBACG,MAAM,SAAS,MAAM,OAAO,EAC5B,GAAG,SAAS,MAAM,EAClB,GAAG,SAAS,CAAC,aAAa;AACzB,cAAQ,EAAC,MAAM,YAAY,EAAA,CAAE;AAAA,IAC/B,CAAC;AAAA,EACL,CAAC;AACH;AC5BA,MAAM,YAAY;AAAA,6DAqBL,cAAc;AAAA,EACzB,GAAG;AAAA,EACH,QAAQ;AAAA,IACN,SAAS;AAAA,IACT,MAAM;AAAA,EAAA;AAEV;AAIA,SAAS,iBAAiB,UAAkB;AAC1C,SAAO,MAAM;AAAA,IACX;AAAA;AAAA;AAAA;AAAA,uBAImB,QAAQ;AAAA;AAAA;AAAA,YAGnB,UAAA;AAAA,EAAU;AAEtB;AAEO,SAAS,gBACd,cACA,OACA,QACA;AACA,SAAO,eACL,UACA,MACA;AACA,QAAI,aAAa,QAAQ,MAAM,IAAO;AACpC,YAAM,SAAS,MAAM,KAAA;AACrB,UAAI,QAAQ,QAAQ;AAClB,eAAO,KAAK,iBAAiB,QAAQ,CAAC;AACtC,cAAM,eAAe,OAAO,KAAK;AAAA;AAAA,CAAM;AACvC,eAAO,KAAK,YAAY,GACxB,IAAI,MAAM;AAAA,IAAO,eAAe,SAAS;AAAA,MAC3C;AAAA,IACF;AAEA,QAAI,MAAM,UAAU,OAAO;AACzB,YAAM,IAAI;AAAA,QACR;AAAA;AAAA;AAAA;AAAA,MAAA;AAAA,EAMN;AACF;AAEA,eAAsB,YAAY,cAAmCA,KAAwB;AAC3F,MAAIA,OAAM,aAAa,QAAQ,IAAO;AACpC,QAAI,KAAK,6CAA6C;AACtD,UAAM,EAAC,KAAA,IAAQ,MAAM,WAAW,aAAa;AAC7C,QAAI,SAAS;AACX,YAAM,IAAI,MAAM;AAAA;AAAA,IAA8C,iBAAiB,KAAK,CAAC;AAAA,EAEzF;AACF;AClFA,MAAM,sBAAsB,4EAA4E,KAAK,oBAAoB,gCAAgC,KAAK,OAAO;AAE7K,eAAsB,gBAAgB,EAAC,YAAkD;AACvF,MAAI,MAAM,mDAAmD;AAC7D,QAAM,SAAS,IAAI,OAAO;AAAA,IACxB,KAAK;AAAA,IACL,gBAAgB;AAAA,MACd,gBAAgB,CAAC,cAAc;AAAA,MAC/B,OAAO;AAAA,QACL,yBAAyB;AAAA,UACvB;AAAA,UACA;AAAA,YACE,UAAU;AAAA,cACR,GAAG,eAAe,IAAI,CAAC,iBAAiB;AAAA,gBACtC,OAAO,CAAC,GAAG,WAAW,GAAG;AAAA,gBACzB,SAAS,yBAAyB,WAAW;AAAA,cAAA,EAC7C;AAAA,cACF;AAAA,gBACE,OAAO,CAAC,UAAU;AAAA,gBAClB,SAAS,4FAA4F,KAAK,oBAAoB;AAAA,cAAA;AAAA,cAEhI;AAAA,gBACE,OAAO,CAAC,QAAQ;AAAA,gBAChB,SAAS,SAAS,mBAAmB;AAAA,cAAA;AAAA,cAEvC;AAAA,gBACE,OAAO,CAAC,YAAY;AAAA,gBACpB,SAAS,aAAa,mBAAmB;AAAA,cAAA;AAAA,cAE3C;AAAA,gBACE,OAAO,CAAC,UAAU;AAAA,gBAClB,SAAS,WAAW,mBAAmB;AAAA,cAAA;AAAA,YACzC;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF,CACD;AAED,MAAI;AAGF,UAAM,oBAFU,MAAM,OAAO,UAAU,CAAC,KAAK,KAAK,UAAU,sBAAsB,CAAC,CAAC,GAGjF,IAAI,CAAC,MAAM;AACV,YAAM,cAAc,EAAE,SAAS,OAAO,CAAC,MAAM,EAAE,WAAW,uBAAuB;AACjF,aAAO;AAAA,QACL,GAAG;AAAA,QACH,UAAU;AAAA,QACV,YAAY,YAAY;AAAA,MAAA;AAAA,IAE5B,CAAC,EACA,OAAO,CAAC,MAAM,EAAE,UAAU;AAE7B,QAAI,iBAAiB,QAAQ;AAE3B,YAAM,aAAa,OADD,MAAM,OAAO,cAAc,SAAS,GACnB,OAAO,gBAAgB,GAEpD,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAWJ,KAAK,aAAa;AAAA;AAAA;AAAA;AAIpC,aAAO,CAAC,aAAa,aAAa;AAAA,IACpC;AAAA,EACF,SAAS,GAAG;AACV,WAAA,IAAI,MAAM,8BAA8B,CAAC,GAClC;AAAA,MACL;AAAA;AAAA;AAAA;AAAA;AAAA,IAAA;AAAA,EAMJ;AAEA,SAAO,CAAA;AACT;AC1FA,eAAsB,aAAa,SAA+C;AAChF,QAAM,EAAC,UAAU,SAAA,IAAY,SACvB,WAAW,KAAK,QAAQ,UAAU,QAAQ;AAGhD,MAFe,MAAM,WAAW,QAAQ;AAIxC,WAAO,GAAG,eAAe,UAAU,GAAG,IAAI,QAAQ,EAAE,SAChD,GAAG;AAAA,MACD,GAAG,eAAe,UAAU,GAAG,IAAI,QAAQ,EAAE;AAAA,MAC7C,GAAG;AAAA,MACH;AAAA,IAAA,IAEF;AACN;"}