@sanity/cli 5.2.0-next.12 → 6.0.0-alpha.4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 - 2025 Sanity.io
+Copyright (c) 2025 Sanity.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,3 +1,289 @@
-# cli
+# @sanity/cli
 
-Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets
+Code for sanity cli
+
+# Usage
+
+  <!-- usage -->
+
+```sh-session
+$ npm install -g @sanity/cli
+$ sanity COMMAND
+running command...
+$ sanity (--version)
+@sanity/cli/0.0.0 darwin-arm64 node-v20.19.1
+$ sanity --help [COMMAND]
+USAGE
+  $ sanity COMMAND
+...
+```
+
+<!-- usagestop -->
+
+# Commands
+
+  <!-- commands -->
+
+- [`sanity build [OUTPUTDIR]`](#sanity-build-outputdir)
+- [`sanity dev`](#sanity-dev)
+- [`sanity docs`](#sanity-docs)
+- [`sanity help [COMMAND]`](#sanity-help-command)
+- [`sanity learn`](#sanity-learn)
+- [`sanity login`](#sanity-login)
+- [`sanity logout`](#sanity-logout)
+- [`sanity manage`](#sanity-manage)
+- [`sanity projects list`](#sanity-projects-list)
+- [`sanity users list`](#sanity-users-list)
+- [`sanity versions`](#sanity-versions)
+
+## `sanity build [OUTPUTDIR]`
+
+Builds the Sanity Studio configuration into a static bundle
+
+```
+USAGE
+  $ sanity build [OUTPUTDIR] [--auto-updates] [--minify] [--source-maps] [-y]
+
+ARGUMENTS
+  OUTPUTDIR  Output directory
+
+FLAGS
+  -y, --yes                Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
+      --[no-]auto-updates  Enable/disable auto updates of studio versions
+      --[no-]minify        Enable/disable minifying of built bundles
+      --[no-]source-maps   Enable source maps for built bundles (increases size of bundle)
+
+DESCRIPTION
+  Builds the Sanity Studio configuration into a static bundle
+
+EXAMPLES
+  $ sanity build
+
+  $ sanity build --no-minify --source-maps
+```
+
+_See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/v0.0.0/src/commands/build.ts)_
+
+## `sanity dev`
+
+Starts a local development server for Sanity Studio with live reloading
+
+```
+USAGE
+  $ sanity dev [--host <value>] [--port <value>]
+
+FLAGS
+  --host=<value>  [default: 127.0.0.1] The local network interface at which to listen
+  --port=<value>  [default: 3333] TCP port to start server on
+
+DESCRIPTION
+  Starts a local development server for Sanity Studio with live reloading
+
+EXAMPLES
+  $ sanity dev --host=0.0.0.0
+
+  $ sanity dev --port=1942
+```
+
+_See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v0.0.0/src/commands/dev.ts)_
+
+## `sanity docs`
+
+Opens Sanity Studio documentation in your web browser
+
+```
+USAGE
+  $ sanity docs
+
+DESCRIPTION
+  Opens Sanity Studio documentation in your web browser
+```
+
+_See code: [src/commands/docs.ts](https://github.com/sanity-io/cli/blob/v0.0.0/src/commands/docs.ts)_
+
+## `sanity help [COMMAND]`
+
+Display help for sanity.
+
+```
+USAGE
+  $ sanity help [COMMAND...] [-n]
+
+ARGUMENTS
+  COMMAND...  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for sanity.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.28/src/commands/help.ts)_
+
+## `sanity learn`
+
+Opens Sanity Learn in your web browser
+
+```
+USAGE
+  $ sanity learn
+
+DESCRIPTION
+  Opens Sanity Learn in your web browser
+```
+
+_See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v0.0.0/src/commands/learn.ts)_
+
+## `sanity login`
+
+Authenticates the CLI for access to Sanity projects
+
+```
+USAGE
+  $ sanity login [--open] [--provider <providerId>] [--sso <slug>]
+
+FLAGS
+  --[no-]open              Open a browser window to log in (`--no-open` only prints URL)
+  --provider=<providerId>  Log in using the given provider
+  --sso=<slug>             Log in using Single Sign-On, using the given organization slug
+
+DESCRIPTION
+  Authenticates the CLI for access to Sanity projects
+
+EXAMPLES
+  Log in using default settings
+
+    $ sanity login
+
+  Log in using Single Sign-On with the "my-organization" slug
+
+    $ sanity login --sso my-organization
+
+  Login with GitHub provider, but do not open a browser window automatically
+
+    $ sanity login --provider github --no-open
+```
+
+_See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v0.0.0/src/commands/login.ts)_
+
+## `sanity logout`
+
+Logs out the CLI from the current user session
+
+```
+USAGE
+  $ sanity logout
+
+DESCRIPTION
+  Logs out the CLI from the current user session
+```
+
+_See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v0.0.0/src/commands/logout.ts)_
+
+## `sanity manage`
+
+Opens project management interface in your web browser
+
+```
+USAGE
+  $ sanity manage
+
+DESCRIPTION
+  Opens project management interface in your web browser
+```
+
+_See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v0.0.0/src/commands/manage.ts)_
+
+## `sanity projects list`
+
+Lists projects connected to your user
+
+```
+USAGE
+  $ sanity projects list [--order asc|desc] [--sort id|members|name|url|created]
+
+FLAGS
+  --order=<option>  [default: desc]
+                    <options: asc|desc>
+  --sort=<option>   [default: created]
+                    <options: id|members|name|url|created>
+
+DESCRIPTION
+  Lists projects connected to your user
+
+EXAMPLES
+  List projects
+
+    $ sanity projects list
+
+  List all users of the project, but exclude pending invitations and robots
+
+    $ sanity projects list --sort=members --order=asc
+```
+
+_See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v0.0.0/src/commands/projects/list.ts)_
+
+## `sanity users list`
+
+List all users of the project
+
+```
+USAGE
+  $ sanity users list [--invitations] [--order asc|desc] [--robots] [--sort id|name|role|date]
+
+FLAGS
+  --[no-]invitations  Includes or excludes pending invitations
+  --order=<option>    [default: asc] Sort output ascending/descending
+                      <options: asc|desc>
+  --[no-]robots       Includes or excludes robots (token users)
+  --sort=<option>     [default: date] Sort users by specified column
+                      <options: id|name|role|date>
+
+DESCRIPTION
+  List all users of the project
+
+EXAMPLES
+  List all users of the project
+
+    $ sanity users list
+
+  List all users of the project, but exclude pending invitations and robots
+
+    $ sanity users list --no-invitations --no-robots
+
+  List all users, sorted by role
+
+    $ sanity users list --sort role
+```
+
+_See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v0.0.0/src/commands/users/list.ts)_
+
+## `sanity versions`
+
+Shows installed versions of Sanity Studio and components
+
+```
+USAGE
+  $ sanity versions
+
+DESCRIPTION
+  Shows installed versions of Sanity Studio and components
+
+EXAMPLES
+  $ sanity versions
+```
+
+_See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v0.0.0/src/commands/versions.ts)_
+
+<!-- commandsstop -->
+
+# Table of contents
+
+  <!-- toc -->
+
+- [@sanity/cli](#sanitycli)
+- [Usage](#usage)
+- [Commands](#commands)
+- [Table of contents](#table-of-contents)
+<!-- tocstop -->

package/bin/run.cmd

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

package/bin/run.js

@@ -0,0 +1,31 @@
+#!/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)) {
+  console.error(
+    `${err}Node.js version >=20.19.1 <22 or >=22.12 required. You are running ${process.version}`,
+  )
+  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