@sanity/cli 5.9.0-next.8 → 6.0.0-alpha.11

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+import {execute} from '@oclif/core'
+
+var err = '\u001B[31m\u001B[1mERROR:\u001B[22m\u001B[39m '
+var nodeVersionParts = process.version.replace(/^v/i, '').split('.').map(Number)
+
+var majorVersion = nodeVersionParts[0]
+var minorVersion = nodeVersionParts[1]
+var patchVersion = nodeVersionParts[2]
+
+function isSupportedNodeVersion(major, minor, patch) {
+  if (major === 20) {
+    if (minor > 19) return true
+    if (minor === 19 && patch >= 1) return true
+    return false
+  }
+  if (major === 21) return true
+  if (major === 22 && minor >= 12) return true
+  if (major > 22) return true
+  return false
+}
+
+if (!isSupportedNodeVersion(majorVersion, minorVersion, patchVersion)) {
+  // eslint-disable-next-line no-console
+  console.error(
+    `${err}Node.js version >=20.19.1 <22 or >=22.12 required. You are running ${process.version}`,
+  )
+  // eslint-disable-next-line no-console
+  console.error('')
+  process.exit(1)
+}
+
+await execute({dir: import.meta.url})

package/codemods/deskRename.js

@@ -1,8 +1,7 @@
 // @ts-check
-deskRename.parser = 'tsx'
-module.exports = deskRename
-
+/* eslint-disable unicorn/no-array-callback-reference, unicorn/no-array-method-this-argument */
 const renamed = {
+  deskTool: 'structureTool',
   DeskToolContextValue: 'StructureToolContextValue',
   DeskToolFeatures: 'StructureToolFeatures',
   DeskToolMenuItem: 'StructureToolMenuItem',
@@ -10,7 +9,6 @@ const renamed = {
   DeskToolPaneActionHandler: 'StructureToolPaneActionHandler',
   DeskToolProvider: 'StructureToolProvider',
   DeskToolProviderProps: 'StructureToolProviderProps',
-  deskTool: 'structureTool',
   useDeskTool: 'useStructureTool',
 }
 
@@ -35,39 +33,43 @@ function deskRename(fileInfo, api) {
   //
   // from: import {StructureBuilder} from 'sanity/desk'
   //   to: import {StructureBuilder} from 'sanity/structure'
-  root
-    .find(api.jscodeshift.ImportDeclaration, (node) => node.source.value.startsWith('sanity/desk'))
-    .filter((path) => path.node.source.value.startsWith('sanity/desk'))
-    .forEach((path) => {
-      const newSpecifiers = []
-
-      j(path)
-        .find(j.ImportSpecifier)
-        .forEach((specifier) => {
-          const oldName = specifier.node.imported.name
-          const aliasName = specifier.node.local.name
-          const isAliased = oldName !== aliasName
-          if (!(oldName in renamed)) {
-            newSpecifiers.push(specifier.node)
-            return
-          }
-
-          const newName = renamed[oldName]
-          const targetName = isAliased ? aliasName : newName
-          if (newName === targetName) {
-            newSpecifiers.push(j.importSpecifier(j.identifier(newName)))
-            if (isComponent(oldName)) {
-              renamedComponents.add(oldName)
-            } else if (isFunction(oldName)) {
-              renamedFunctions.add(oldName)
-            }
-          } else {
-            newSpecifiers.push(j.importSpecifier(j.identifier(newName), j.identifier(targetName)))
-          }
-        })
-
-      j(path).replaceWith(j.importDeclaration(newSpecifiers, j.literal('sanity/structure')))
-    })
+  const allImportDeclarations = root.find(j.ImportDeclaration)
+  const importDeclarations = []
+  for (const path of allImportDeclarations.paths()) {
+    if (path.node.source.value.startsWith('sanity/desk')) {
+      importDeclarations.push(path)
+    }
+  }
+
+  for (const path of importDeclarations) {
+    const newSpecifiers = []
+
+    const allImportSpecifiers = j(path).find(j.ImportSpecifier)
+    for (const specifier of allImportSpecifiers.paths()) {
+      const oldName = specifier.node.imported.name
+      const aliasName = specifier.node.local.name
+      const isAliased = oldName !== aliasName
+      if (!(oldName in renamed)) {
+        newSpecifiers.push(specifier.node)
+        continue
+      }
+
+      const newName = renamed[oldName]
+      const targetName = isAliased ? aliasName : newName
+      if (newName === targetName) {
+        newSpecifiers.push(j.importSpecifier(j.identifier(newName)))
+        if (isComponent(oldName)) {
+          renamedComponents.add(oldName)
+        } else if (isFunction(oldName)) {
+          renamedFunctions.add(oldName)
+        }
+      } else {
+        newSpecifiers.push(j.importSpecifier(j.identifier(newName), j.identifier(targetName)))
+      }
+    }
+
+    j(path).replaceWith(j.importDeclaration(newSpecifiers, j.literal('sanity/structure')))
+  }
 
   // Requires
   // from: const {deskTool} = require('sanity/desk')
@@ -75,70 +77,87 @@ function deskRename(fileInfo, api) {
   //
   // from: const {StructureBuilder} = require('sanity/desk')
   //   to: const {StructureBuilder} = require('sanity/structure')
-  root
-    .find(api.jscodeshift.VariableDeclarator, {
-      id: {type: 'ObjectPattern'},
-      init: {callee: {name: 'require'}},
-    })
-    .filter((path) => path.value.init.arguments[0].value.startsWith('sanity/desk'))
-    .forEach((path) => {
-      const newProperties = []
-      j(path)
-        .find(j.ObjectProperty)
-        .forEach((prop) => {
-          const oldName = prop.node.key.name
-          const aliasName = prop.node.value.name
-          const isAliased = oldName !== aliasName
-          const newName = renamed[oldName]
-          if (!newName) {
-            newProperties.push(prop.node)
-            return
-          }
-
-          const targetName = isAliased ? aliasName : newName
-          const newProp = j.objectProperty(
-            j.identifier(newName),
-            j.identifier(targetName),
-            false,
-            true,
-          )
-
-          if (newName === targetName) {
-            newProp.shorthand = true
-          }
-          newProperties.push(newProp)
-
-          if (!isAliased) {
-            if (isComponent(oldName)) {
-              renamedComponents.add(oldName)
-            } else if (isFunction(oldName)) {
-              renamedFunctions.add(oldName)
-            }
-          }
-        })
-
-      j(path).replaceWith(
-        j.variableDeclarator(
-          j.objectPattern(newProperties),
-          j.callExpression(j.identifier('require'), [j.stringLiteral('sanity/structure')]),
-        ),
-      )
-    })
+  const allVariableDeclarators = root.find(j.VariableDeclarator, {
+    id: {type: 'ObjectPattern'},
+    init: {callee: {name: 'require'}},
+  })
+  const variableDeclarators = []
+  for (const path of allVariableDeclarators.paths()) {
+    if (path.value.init.arguments[0].value.startsWith('sanity/desk')) {
+      variableDeclarators.push(path)
+    }
+  }
+
+  for (const path of variableDeclarators) {
+    const newProperties = []
+    const allObjectProperties = j(path).find(j.ObjectProperty)
+
+    for (const prop of allObjectProperties.paths()) {
+      const oldName = prop.node.key.name
+      const aliasName = prop.node.value.name
+      const isAliased = oldName !== aliasName
+      const newName = renamed[oldName]
+      if (!newName) {
+        newProperties.push(prop.node)
+        continue
+      }
+
+      const targetName = isAliased ? aliasName : newName
+      const newProp = j.objectProperty(j.identifier(newName), j.identifier(targetName), false, true)
+
+      if (newName === targetName) {
+        newProp.shorthand = true
+      }
+      newProperties.push(newProp)
+
+      if (!isAliased) {
+        if (isComponent(oldName)) {
+          renamedComponents.add(oldName)
+        } else if (isFunction(oldName)) {
+          renamedFunctions.add(oldName)
+        }
+      }
+    }
+
+    j(path).replaceWith(
+      j.variableDeclarator(
+        j.objectPattern(newProperties),
+        j.callExpression(j.identifier('require'), [j.stringLiteral('sanity/structure')]),
+      ),
+    )
+  }
 
   // Replace all remapped instances on a best-effort basis
-  renamedComponents.forEach((oldName) => {
+  for (const oldName of renamedComponents) {
     const newName = renamed[oldName]
-    root
-      .find(api.jscodeshift.JSXIdentifier, {name: oldName})
-      .forEach((path) => j(path).replaceWith(j.jsxIdentifier(newName)))
-  })
-
-  renamedFunctions.forEach((oldName) => {
+    const allJsxIdentifiers = root.find(j.JSXIdentifier)
+    const jsxIdentifiers = []
+    for (const path of allJsxIdentifiers.paths()) {
+      if (path.node.name === oldName) {
+        jsxIdentifiers.push(path)
+      }
+    }
+    for (const path of jsxIdentifiers) {
+      j(path).replaceWith(j.jsxIdentifier(newName))
+    }
+  }
+
+  for (const oldName of renamedFunctions) {
     const newName = renamed[oldName]
-    root.find(api.jscodeshift.CallExpression, {callee: {name: oldName}}).forEach((path) => {
+    const allCallExpressions = root.find(j.CallExpression)
+    const callExpressions = []
+    for (const path of allCallExpressions.paths()) {
+      if (path.node.callee && path.node.callee.name === oldName) {
+        callExpressions.push(path)
+      }
+    }
+    for (const path of callExpressions) {
       j(path).replaceWith(j.callExpression(j.identifier(newName), path.node.arguments))
-    })
-  })
+    }
+  }
 
   return root.toSource()
 }
+
+deskRename.parser = 'tsx'
+export default deskRename

package/codemods/partsTypeDirective.js

@@ -1,16 +1,13 @@
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-const path = require('node:path')
+/* eslint-disable unicorn/no-array-callback-reference, unicorn/no-array-method-this-argument */
+import path from 'node:path'
 
-partsTypeDirective.parser = 'tsx'
-module.exports = partsTypeDirective
-
-const EXTS = ['.ts', '.tsx']
+const EXTS = new Set(['.ts', '.tsx'])
 
 function partsTypeDirective(fileInfo, api) {
   const j = api.jscodeshift
   const root = j(fileInfo.source)
 
-  if (!EXTS.includes(path.extname(fileInfo.path))) {
+  if (!EXTS.has(path.extname(fileInfo.path))) {
     return fileInfo.source
   }
   const partImports = root.find(api.jscodeshift.ImportDeclaration, (node) =>
@@ -45,3 +42,6 @@ const isSanityTypesReferenceDirective = (node) =>
   node.type === 'CommentLine' &&
   // note: the leading '/' is intentional (it's a triple-slash directive)
   node.value === '/<reference types="@sanity/types/parts" />'
+
+partsTypeDirective.parser = 'tsx'
+export default partsTypeDirective

package/codemods/reactIconsV3.js

@@ -1,9 +1,9 @@
+// @ts-check
+/* eslint-disable unicorn/no-array-callback-reference, unicorn/no-array-method-this-argument */
+
 const splitRegexp = [/([a-z0-9])([A-Z])/g, /([A-Z])([A-Z][a-z])/g]
 const stripRegexp = /[^A-Z0-9]+/gi
 
-fixIcons.parser = 'tsx'
-module.exports = fixIcons
-
 function fixIcons(fileInfo, api) {
   const j = api.jscodeshift
   const root = j(fileInfo.source)
@@ -14,28 +14,33 @@ function fixIcons(fileInfo, api) {
   //
   // from: import PersonIcon from 'react-icons/lib/md/person'
   //   to: import {MdPerson as PersonIcon} from 'react-icons/md'
-  root
-    .find(api.jscodeshift.ImportDeclaration, (node) => node.source.value.startsWith('react-icons/'))
-    .filter((path) => isLegacyPath(path.node.source.value))
-    .forEach((path) => {
-      const node = path.value
-      const icon = iconSpecFromPath(node.source.value)
-
-      if (!icon) {
-        // import {MdPerson} from 'react-icons/lib/md' => import {MdPerson} from 'react-icons/md'
-        node.source.value = node.source.value.replace(/react-icons\/lib/, 'react-icons')
-        return
-      }
-
-      // import MdPerson from 'react-icons/lib/md/person' => import {MdPerson} from 'react-icons/md'
-      const oldName = path.value.specifiers[0].local.name
-      j(path).replaceWith(
-        j.importDeclaration(
-          [j.importSpecifier(j.identifier(icon.name), j.identifier(oldName))],
-          j.literal(`react-icons/${icon.pack}`),
-        ),
-      )
-    })
+  const allImportDeclarations = root.find(j.ImportDeclaration)
+  const reactIconsImports = []
+  for (const path of allImportDeclarations.paths()) {
+    if (path.node.source.value.startsWith('react-icons/') && isLegacyPath(path.node.source.value)) {
+      reactIconsImports.push(path)
+    }
+  }
+
+  for (const path of reactIconsImports) {
+    const node = path.value
+    const icon = iconSpecFromPath(node.source.value)
+
+    if (!icon) {
+      // import {MdPerson} from 'react-icons/lib/md' => import {MdPerson} from 'react-icons/md'
+      node.source.value = node.source.value.replace(/react-icons\/lib/, 'react-icons')
+      continue
+    }
+
+    // import MdPerson from 'react-icons/lib/md/person' => import {MdPerson} from 'react-icons/md'
+    const oldName = path.value.specifiers[0].local.name
+    j(path).replaceWith(
+      j.importDeclaration(
+        [j.importSpecifier(j.identifier(icon.name), j.identifier(oldName))],
+        j.literal(`react-icons/${icon.pack}`),
+      ),
+    )
+  }
 
   // Requires
   // from: const PersonIcon = require('react-icons/lib/md/person'
@@ -43,28 +48,38 @@ function fixIcons(fileInfo, api) {
   //
   // from: const {MdPerson} = require('react-icons/lib/md')
   //   to: const {MdPerson} = require('react-icons/md')
-  root
-    .find(j.VariableDeclarator, {
-      id: {type: 'Identifier'},
-      init: {callee: {name: 'require'}},
-    })
-    .filter((path) => isLegacyPath(path.value.init.arguments[0].value))
-    .forEach((path) => {
-      const oldName = path.value.id.name
-      const filePath = path.value.init.arguments[0].value
-      const icon = iconSpecFromPath(filePath)
-      const prop = j.objectProperty(j.identifier(icon.name), j.identifier(oldName), false, true)
-      if (oldName === icon.name) {
-        prop.shorthand = true
-      }
-
-      j(path).replaceWith(
-        j.variableDeclarator(
-          j.objectPattern([prop]),
-          j.callExpression(j.identifier('require'), [j.stringLiteral(`react-icons/${icon.pack}`)]),
-        ),
-      )
-    })
+  const allVariableDeclarators = root.find(j.VariableDeclarator, {
+    id: {type: 'Identifier'},
+    init: {callee: {name: 'require'}},
+  })
+  const legacyRequires = []
+  for (const path of allVariableDeclarators.paths()) {
+    if (isLegacyPath(path.value.init.arguments[0].value)) {
+      legacyRequires.push(path)
+    }
+  }
+
+  for (const path of legacyRequires) {
+    const oldName = path.value.id.name
+    const filePath = path.value.init.arguments[0].value
+    const icon = iconSpecFromPath(filePath)
+
+    if (!icon) {
+      continue
+    }
+
+    const prop = j.objectProperty(j.identifier(icon.name), j.identifier(oldName), false, true)
+    if (oldName === icon.name) {
+      prop.shorthand = true
+    }
+
+    j(path).replaceWith(
+      j.variableDeclarator(
+        j.objectPattern([prop]),
+        j.callExpression(j.identifier('require'), [j.stringLiteral(`react-icons/${icon.pack}`)]),
+      ),
+    )
+  }
 
   return root.toSource()
 }
@@ -72,12 +87,21 @@ function fixIcons(fileInfo, api) {
 function pascalCase(input) {
   const inner = replace(input, splitRegexp, '$1\0$2')
   const result = replace(inner, stripRegexp, '\0')
-  return result.slice(0, result.length).split('\0').map(pascalCaseTransform).join('')
+  const parts = result.split('\0')
+  let output = ''
+  for (const part of parts) {
+    output += pascalCaseTransform(part)
+  }
+  return output
 }
 
 function replace(input, re, value) {
   if (re instanceof RegExp) return input.replace(re, value)
-  return re.reduce((str, pattern) => str.replace(pattern, value), input)
+  let result = input
+  for (const pattern of re) {
+    result = result.replace(pattern, value)
+  }
+  return result
 }
 
 function pascalCaseTransform(input) {
@@ -91,12 +115,12 @@ function iconSpecFromPath(path) {
     path.match(/(ai|bi|bs|cg|di|fa|fc|fi|gi|go|gr|hi|im|io|md|ri|si|src|ti|vsc|wi)\/(.*)/) || []
 
   if (!pack) {
-    return undefined
+    return null
   }
 
   const prefix = pack[0].toUpperCase() + pack.slice(1)
   const suffix = pascalCase(icon.replace(/\.jsx?$/, ''))
-  return {pack, name: prefix + suffix}
+  return {name: prefix + suffix, pack}
 }
 
 function isLegacyPath(path) {
@@ -104,3 +128,6 @@ function isLegacyPath(path) {
     path,
   )
 }
+
+fixIcons.parser = 'tsx'
+export default fixIcons

package/dist/SanityHelp.js

@@ -0,0 +1,43 @@
+import { Help } from '@oclif/core';
+export default class SanityHelp extends Help {
+    formatCommand(command) {
+        const help = super.formatCommand(command);
+        // When `sanity init` is called, but originates from the `create-sanity`
+        // package/binary (eg the one used by `npm create sanity@latest` etc), we want to
+        // customize the help text to show that command instead of `sanity init`. In the
+        // future we may also want to consider prefixing with `npx` etc for non-init
+        // commands - but leaving that for another day.
+        const isFromCreate = process.argv.includes('--from-create') && command.id === 'init';
+        if (!isFromCreate) {
+            return help;
+        }
+        const createCmd = guessCreateCommand();
+        const flagSeparator = needsFlagSeparator() ? ' --' : '';
+        // First replace all `sanity init` references that ends with a newline with the
+        // create variant that does not include any flag separator (eg `--`). Then replace
+        // the other references that do. Most package managers do not require the `--`
+        // separator, but npm does. Only include it if we need to, as the commands look
+        // cleaner without it.
+        return help.replaceAll(/(\s+)sanity(\s+)init(\s*)\n/g, `$1${createCmd}$2\n`).replaceAll(/(\s+)sanity(\s+)init/g, `$1${createCmd}${flagSeparator}`);
+    }
+}
+function guessPackageManager() {
+    const ua = process.env.npm_config_user_agent || '';
+    if (ua.includes('pnpm')) return 'pnpm';
+    if (ua.includes('yarn')) return 'yarn';
+    if (ua.includes('bun')) return 'bun';
+    if (ua.includes('npm')) return 'npm';
+}
+function guessCreateCommand() {
+    const pm = guessPackageManager();
+    if (pm === 'yarn') return `yarn create sanity`;
+    if (pm === 'bun') return `bun create sanity@latest`;
+    if (pm === 'pnpm') return `pnpm create sanity@latest`;
+    return `npm create sanity@latest`;
+}
+function needsFlagSeparator() {
+    const pm = guessPackageManager();
+    return pm === 'npm' || !pm;
+}
+
+//# sourceMappingURL=SanityHelp.js.map

package/dist/SanityHelp.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/SanityHelp.ts"],"sourcesContent":["import {Command, Help} from '@oclif/core'\n\nexport default class SanityHelp extends Help {\n  protected formatCommand(command: Command.Loadable): string {\n    const help = super.formatCommand(command)\n\n    // When `sanity init` is called, but originates from the `create-sanity`\n    // package/binary (eg the one used by `npm create sanity@latest` etc), we want to\n    // customize the help text to show that command instead of `sanity init`. In the\n    // future we may also want to consider prefixing with `npx` etc for non-init\n    // commands - but leaving that for another day.\n    const isFromCreate = process.argv.includes('--from-create') && command.id === 'init'\n    if (!isFromCreate) {\n      return help\n    }\n\n    const createCmd = guessCreateCommand()\n    const flagSeparator = needsFlagSeparator() ? ' --' : ''\n\n    // First replace all `sanity init` references that ends with a newline with the\n    // create variant that does not include any flag separator (eg `--`). Then replace\n    // the other references that do. Most package managers do not require the `--`\n    // separator, but npm does. Only include it if we need to, as the commands look\n    // cleaner without it.\n    return help\n      .replaceAll(/(\\s+)sanity(\\s+)init(\\s*)\\n/g, `$1${createCmd}$2\\n`)\n      .replaceAll(/(\\s+)sanity(\\s+)init/g, `$1${createCmd}${flagSeparator}`)\n  }\n}\n\nfunction guessPackageManager() {\n  const ua = process.env.npm_config_user_agent || ''\n  if (ua.includes('pnpm')) return 'pnpm'\n  if (ua.includes('yarn')) return 'yarn'\n  if (ua.includes('bun')) return 'bun'\n  if (ua.includes('npm')) return 'npm'\n}\n\nfunction guessCreateCommand() {\n  const pm = guessPackageManager()\n  if (pm === 'yarn') return `yarn create sanity`\n  if (pm === 'bun') return `bun create sanity@latest`\n  if (pm === 'pnpm') return `pnpm create sanity@latest`\n  return `npm create sanity@latest`\n}\n\nfunction needsFlagSeparator() {\n  const pm = guessPackageManager()\n  return pm === 'npm' || !pm\n}\n"],"names":["Help","SanityHelp","formatCommand","command","help","isFromCreate","process","argv","includes","id","createCmd","guessCreateCommand","flagSeparator","needsFlagSeparator","replaceAll","guessPackageManager","ua","env","npm_config_user_agent","pm"],"mappings":"AAAA,SAAiBA,IAAI,QAAO,cAAa;AAEzC,eAAe,MAAMC,mBAAmBD;IAC5BE,cAAcC,OAAyB,EAAU;QACzD,MAAMC,OAAO,KAAK,CAACF,cAAcC;QAEjC,wEAAwE;QACxE,iFAAiF;QACjF,gFAAgF;QAChF,4EAA4E;QAC5E,+CAA+C;QAC/C,MAAME,eAAeC,QAAQC,IAAI,CAACC,QAAQ,CAAC,oBAAoBL,QAAQM,EAAE,KAAK;QAC9E,IAAI,CAACJ,cAAc;YACjB,OAAOD;QACT;QAEA,MAAMM,YAAYC;QAClB,MAAMC,gBAAgBC,uBAAuB,QAAQ;QAErD,+EAA+E;QAC/E,kFAAkF;QAClF,8EAA8E;QAC9E,+EAA+E;QAC/E,sBAAsB;QACtB,OAAOT,KACJU,UAAU,CAAC,gCAAgC,CAAC,EAAE,EAAEJ,UAAU,IAAI,CAAC,EAC/DI,UAAU,CAAC,yBAAyB,CAAC,EAAE,EAAEJ,YAAYE,eAAe;IACzE;AACF;AAEA,SAASG;IACP,MAAMC,KAAKV,QAAQW,GAAG,CAACC,qBAAqB,IAAI;IAChD,IAAIF,GAAGR,QAAQ,CAAC,SAAS,OAAO;IAChC,IAAIQ,GAAGR,QAAQ,CAAC,SAAS,OAAO;IAChC,IAAIQ,GAAGR,QAAQ,CAAC,QAAQ,OAAO;IAC/B,IAAIQ,GAAGR,QAAQ,CAAC,QAAQ,OAAO;AACjC;AAEA,SAASG;IACP,MAAMQ,KAAKJ;IACX,IAAII,OAAO,QAAQ,OAAO,CAAC,kBAAkB,CAAC;IAC9C,IAAIA,OAAO,OAAO,OAAO,CAAC,wBAAwB,CAAC;IACnD,IAAIA,OAAO,QAAQ,OAAO,CAAC,yBAAyB,CAAC;IACrD,OAAO,CAAC,wBAAwB,CAAC;AACnC;AAEA,SAASN;IACP,MAAMM,KAAKJ;IACX,OAAOI,OAAO,SAAS,CAACA;AAC1B"}