@sanity/plugin-kit 4.0.20 → 5.0.0

package/src/actions/verify-studio.ts

@@ -1,58 +0,0 @@
-import {loadConfig as loadPackageConfig} from '@sanity/pkg-utils'
-import {getPackage} from '../npm/package'
-import log from '../util/log'
-import {cliName, urls} from '../constants'
-import {validateImports} from '../dependencies/import-linter'
-import outdent from 'outdent'
-import chalk from 'chalk'
-import {
-  createValidator,
-  runTscMaybe,
-  VerifyFlags,
-  VerifyPackageConfig,
-} from './verify/verify-common'
-import {PackageJson} from './verify/types'
-import {validateSanityDependencies, validateStudioConfig} from './verify/validations'
-import {readTSConfig} from '../util/ts'
-
-export async function verifyStudio({basePath, flags}: {basePath: string; flags: VerifyFlags}) {
-  let errors: string[] = []
-
-  const packageJson: PackageJson = await getPackage({basePath, validate: false})
-  const verifyConfig: VerifyPackageConfig = packageJson.sanityPlugin?.verifyPackage || {}
-  const packageConfig = await loadPackageConfig({cwd: basePath})
-  const tsconfig = packageConfig?.tsconfig ?? 'tsconfig.json'
-
-  const validation = createValidator(verifyConfig, flags, errors)
-
-  const ts = await readTSConfig({basePath, filename: tsconfig})
-
-  await validation('studioConfig', async () => validateStudioConfig({basePath}))
-  await validation('dependencies', async () => validateSanityDependencies(packageJson))
-  await validation('eslintImports', async () => validateImports({basePath}))
-
-  if (errors.length) {
-    throw new Error(
-      outdent`
-        Detected validation issues!
-        This Sanity Studio is not completely V3 ready. Fix the issues starting from the top, or disable any checks you deem unnecessary.
-
-        More information is available here:
-        - Migration guide: ${urls.migrationGuideStudio}
-        - Reference documentation: ${urls.refDocs}
-
-        ${chalk.grey(
-          `To fail-fast on first detected issue run:\nnpx ${cliName} verify-studio --single`,
-        )}
-      `.trimStart(),
-    )
-  }
-
-  await runTscMaybe(verifyConfig, ts)
-
-  log.success(
-    outdent`
-    No outstanding upgrade issues detected. Studio is V3 ready!
-  `.trim(),
-  )
-}

package/src/cli.ts

@@ -1,77 +0,0 @@
-import meow from 'meow'
-import log from './util/log'
-import commands from './cmds'
-import sharedFlags from './sharedFlags'
-import {cliName} from './constants'
-
-/** @public */
-export async function cliEntry(argv = process.argv, autoExit = true) {
-  const cli = meow(
-    `
-	Usage
-	  $ ${cliName} [--help] [--debug] <command> [<args>]
-
-  These are common commands used in various situations:
-
-    init            Create a new Sanity plugin
-    inject          Inject config into an existing Sanity v3 plugin
-    verify-package  Check that a Sanity plugin package follows V3 conventions. Prints upgrade steps.
-    verify-studio   Check that a Sanity Studio follows V3 conventions. Prints upgrade steps.
-    link-watch      Recompiles plugin automatically on changes and runs yalc push --publish
-    version         Show the version of ${cliName} currently installed
-
-  Options
-    --silent        Do not print info and warning messages
-    --verbose       Log everything. This option conflicts with --silent
-    --debug         Print stack trace on errors
-    --version       Output the version number
-    --help          Output usage information
-
-  Examples
-    # Init a new plugin in current directory
-    $ ${cliName} init
-
-    # Init a new plugin in my-sanity-plugin directory
-    $ ${cliName} init my-sanity-plugin
-
-    # Check that a Sanity plugin package in current directory follows V3 conventions
-    $ ${cliName} verify-package
-
-    # Check that a Sanity Studio in current directory  follows V3 conventions
-    $ ${cliName} verify-studio
-`,
-    {
-      autoHelp: false,
-      flags: sharedFlags,
-      argv: argv.slice(2),
-    },
-  )
-
-  const commandName = cli.input[0]
-  if (!commandName) {
-    cli.showHelp() // Exits
-  }
-
-  if (!(commandName in commands)) {
-    console.error(`Unknown command "${commandName}"`)
-    cli.showHelp() // Exits
-  }
-
-  if (cli.flags.silent && cli.flags.verbose) {
-    log.error(`--silent and --verbose are mutually exclusive`)
-    cli.showHelp() // Exits
-  }
-
-  // Lazy-load command
-  const cmd = commands[commandName as keyof typeof commands]
-
-  try {
-    log.setVerbosity(cli.flags)
-    await cmd({argv: argv.slice(3)})
-  } catch (err: any) {
-    log.error(err instanceof TypeError || cli.flags.debug ? err.stack : err.message)
-
-    // eslint-disable-next-line no-process-exit
-    process.exit(1)
-  }
-}

package/src/cmds/index.ts

@@ -1,20 +0,0 @@
-export default {
-  init: async (options: {argv: string[]}) => {
-    await (await import('./init')).default(options)
-  },
-  inject: async (options: {argv: string[]}) => {
-    await (await import('./inject')).default(options)
-  },
-  'link-watch': async (options: {argv: string[]}) => {
-    await (await import('./link-watch')).default(options)
-  },
-  'verify-package': async (options: {argv: string[]}) => {
-    await (await import('./verify-package')).default(options)
-  },
-  'verify-studio': async (options: {argv: string[]}) => {
-    await (await import('./verify-studio')).default(options)
-  },
-  version: async (options: {argv: string[]}) => {
-    await (await import('./version')).default(options)
-  },
-}

package/src/cmds/init.ts

@@ -1,90 +0,0 @@
-import path from 'path'
-import meow from 'meow'
-import log from '../util/log'
-import {init, initFlags} from '../actions/init'
-import {isEmptyish, ensureDir} from '../util/files'
-import {installDependencies, promptForPackageManager} from '../npm/manager'
-import {findStudioV3Config, hasSanityJson} from '../sanity/manifest'
-import {prompt} from '../util/prompt'
-import {cliName} from '../constants'
-import {presetHelpList} from '../presets/presets'
-
-const description = `Initialize a new Sanity plugin`
-
-const help = `
-Usage
-  $ ${cliName} init [dir] [<args>]
-
-Options
-  --no-eslint             Disables ESLint config and dependencies from being added
-  --no-prettier           Disables prettier config and dependencies from being added
-  --no-typescript         Disables typescript config and dependencies from being added
-  --no-license            Disables LICENSE + package.json license field from being added
-  --no-editorconfig       Disables .editorconfig from being added
-  --no-gitignore          Disables .gitignore from being added
-  --no-scripts            Disables scripts from being added to package.json
-  --no-install            Disables automatically running package manager install
-
-  --name [package-name]   Use the provided package-name
-  --author [name]         Use the provided author
-  --repo [url]            Use the provided repo url
-  --license [spdx]        Use the license with the given SPDX identifier
-  --force                 No promt when overwriting files
-
-  --preset [preset-name]  Adds config and files from a named preset. --preset can be supplied multiple times.
-                          The following presets are available:
-${presetHelpList(30)}
-
-Examples
-  # Initialize a new plugin in the current directory
-  $ ${cliName} init
-
-  # Initialize a plugin in the directory ~/my-plugin
-  $ ${cliName} init ~/my-plugin
-
-  # Don't add eslint or prettier
-  $ ${cliName} init --no-eslint --no-prettier
-`
-
-async function run({argv}: {argv: string[]}) {
-  const cli = meow(help, {flags: initFlags, argv, description})
-  const basePath = path.resolve(cli.input[0] || process.cwd())
-
-  const {exists, isRoot} = await hasSanityJson(basePath)
-  if (exists && isRoot) {
-    throw new Error(
-      `sanity.json has a "root" property set to true - are you trying to init into a studio instead of a plugin?`,
-    )
-  }
-
-  const {v3ConfigFile} = await findStudioV3Config(basePath)
-  if (v3ConfigFile) {
-    throw new Error(
-      `${v3ConfigFile} exsists - are you trying to init into a studio instead of a plugin?`,
-    )
-  }
-
-  log.info('Initializing new plugin in "%s"', basePath)
-  if (
-    !cli.flags.force &&
-    !(await isEmptyish(basePath)) &&
-    !(await prompt('Directory is not empty, proceed?', {type: 'confirm', default: false}))
-  ) {
-    log.error('Directory is not empty. Cancelled.')
-    return
-  }
-
-  await ensureDir(basePath)
-  await init({basePath, flags: cli.flags})
-  if (cli.flags.install) {
-    if (await installDependencies(await promptForPackageManager(), {cwd: basePath})) {
-      log.info('Done!')
-    } else {
-      log.error('Failed to install dependencies, try manually running `npm install`')
-    }
-  } else {
-    log.info('Dependency installation skipped.')
-  }
-}
-
-export default run

package/src/cmds/link-watch.ts

@@ -1,50 +0,0 @@
-import path from 'path'
-import meow from 'meow'
-import pkg from '../../package.json'
-import sharedFlags from '../sharedFlags'
-import {linkWatch} from '../actions/link-watch'
-
-const description = `Run the watch command and pushes any changes to yalc`
-
-const help = `
-Usage
-  $ ${pkg.binname} link-watch [<args>]
-
-Options
-  --silent      Do not print info and warning messages
-  --verbose     Log everything. This option conflicts with --silent
-  --version     Output the version number
-  --help        Output usage information
-
-Configuration
-To override the default watch command configuration, provide an override in package.json under sanityPlugin:
-{
-  "sanityPlugin": {
-    "watchCommand": "microbundle watch --format modern,esm,cjs --jsx React.createElement --jsxImportSource react --css inline",
-    "linkWatch": {
-      "command": "npm run watch",
-      "extensions": "js,png,svg,gif,jpeg,css"
-    }
-  }
-}
-
-Examples
-  # Run the watch command and pushes any changes to yalc
-  $ ${pkg.binname} link-watch
-`
-
-const flags = {
-  ...sharedFlags,
-  watch: {
-    type: 'boolean',
-    default: false,
-  },
-} as const
-
-function run({argv}: {argv: string[]}) {
-  const cli = meow(help, {flags, argv, description})
-  const basePath = path.resolve(cli.input[0] || process.cwd())
-  return linkWatch({basePath})
-}
-
-export default run

package/src/cmds/verify-package.ts

@@ -1,36 +0,0 @@
-import path from 'path'
-import meow from 'meow'
-import {verifyPackage} from '../actions/verify-package'
-import {cliName} from '../constants'
-import {verifyFlags} from '../actions/verify/verify-common'
-
-const description = `Verify that a Sanity plugin package is v3 compatible, and print upgrade steps if not.`
-
-const help = `
-Usage
-  $ ${cliName} verify-package [dir] [<args>]
-
-Options
-  --single      Enables fail-fast mode: Will only output the first validation that fails.
-  --silent      Do not print info and warning messages
-  --verbose     Log everything. This option conflicts with --silent
-  --version     Output the version number
-  --help        Output usage information
-
-Each check will describe how they can be individually disabled.
-
-Examples
-  # Verify Sanity plugin package in current directory
-  $ ${cliName} verify-package
-
-  # Verify Sanity plugin package in my-plugin directory in silent mode
-  $ ${cliName} verify-package my-plugin-directory --silent
-`
-
-function run({argv}: {argv: string[]}) {
-  const cli = meow(help, {flags: verifyFlags, argv, description})
-  const basePath = path.resolve(cli.input[0] || process.cwd())
-  return verifyPackage({basePath, flags: cli.flags})
-}
-
-export default run

package/src/cmds/verify-studio.ts

@@ -1,36 +0,0 @@
-import path from 'path'
-import meow from 'meow'
-import {cliName} from '../constants'
-import {verifyFlags} from '../actions/verify/verify-common'
-import {verifyStudio} from '../actions/verify-studio'
-
-const description = `Verify that a Sanity Studio is configured correctly for v3, and print upgrade steps if not.`
-
-const help = `
-Usage
-  $ ${cliName} verify-studio [dir] [<args>]
-
-Options
-  --single      Enables fail-fast mode: Will only output the first validation that fails.
-  --silent      Do not print info and warning messages
-  --verbose     Log everything. This option conflicts with --silent
-  --version     Output the version number
-  --help        Output usage information
-
-Each check will describe how they can be individually disabled.
-
-Examples
-  # Verify Sanity Studio in current directory
-  $ ${cliName} verify-studio
-
-  # Verify Sanity Studio in my-sanity-studio directory in silent mode
-  $ ${cliName} verify-studio my-sanity-studio --silent
-`
-
-function run({argv}: {argv: string[]}) {
-  const cli = meow(help, {flags: verifyFlags, argv, description})
-  const basePath = path.resolve(cli.input[0] || process.cwd())
-  return verifyStudio({basePath, flags: cli.flags})
-}
-
-export default run

package/src/cmds/version.ts

@@ -1,67 +0,0 @@
-import meow from 'meow'
-import pkg from '../../package.json'
-import log from '../util/log'
-import sharedFlags from '../sharedFlags'
-
-const description = `Show the installed version of ${pkg.name}`
-
-const help = `
-Usage
-  $ ${pkg.binname} version
-
-Options
-  --major  Show only the major version
-  --minor  Show only the minor version
-  --patch  Show only the patch version
-
-Examples
-  $ ${pkg.binname} version
-  ${pkg.name} version ${pkg.version}
-
-  $ ${pkg.binname} version --major
-  ${pkg.version.split('.')[0]}
-`
-
-const flags = {
-  ...sharedFlags,
-
-  major: {
-    type: 'boolean',
-    default: false,
-  },
-
-  minor: {
-    type: 'boolean',
-    default: false,
-  },
-
-  patch: {
-    type: 'boolean',
-    default: false,
-  },
-} as const
-
-function run({argv}: {argv: string[]}) {
-  const cli = meow(help, {flags, argv, description})
-  const versionParts = pkg.version.split('.')
-  const versionNames = ['major', 'minor', 'patch']
-  const versionFlags = versionNames.filter((flagName) => cli.flags[flagName])
-  const versionFlag = versionFlags[0]
-  const numVersionFlags = versionFlags.length
-
-  if (numVersionFlags === 0) {
-    log.msg(`${pkg.name} version ${pkg.version}`)
-    return
-  }
-
-  if (numVersionFlags > 1) {
-    throw new Error(
-      `--major, --minor and --patch are mutually exclusive - only one can be used at a time`,
-    )
-  }
-
-  const partIndex = versionNames.indexOf(versionFlag)
-  log.msg(versionParts[partIndex])
-}
-
-export default run

package/src/configs/banned-packages.ts

@@ -1,27 +0,0 @@
-export const mergedPackages = [
-  '@sanity/base',
-  '@sanity/core',
-  '@sanity/types',
-  '@sanity/data-aspects',
-  '@sanity/default-layout',
-  '@sanity/default-login',
-  '@sanity/desk-tool',
-  '@sanity/field',
-  '@sanity/form-builder',
-  '@sanity/initial-value-templates',
-  '@sanity/language-filter',
-  '@sanity/production-preview',
-  '@sanity/react-hooks',
-  '@sanity/resolver',
-  '@sanity/state-router',
-  '@sanity/structure',
-  '@sanity/studio-hints',
-].sort()
-
-export const deprecatedDevDeps = [
-  'tsdx',
-  'sanipack',
-  'parcel',
-  '@parcel/packager-ts',
-  '@parcel/transformer-typescript-types',
-]

package/src/configs/buildExtensions.ts

@@ -1 +0,0 @@
-export const buildExtensions = ['.js', '.jsx', '.es6', '.es', '.mjs', '.ts', '.tsx']

package/src/configs/default-source.ts

@@ -1,64 +0,0 @@
-import outdent from 'outdent'
-import {PackageJson} from '../actions/verify/types'
-
-export function defaultSourceJs(pkg: PackageJson) {
-  return (
-    outdent`
-  import {definePlugin} from 'sanity'
-
-  /**
-   * Usage in sanity.config.js (or .ts)
-   *
-   * \`\`\`js
-   * import {defineConfig} from 'sanity'
-   * import {myPlugin} from '${pkg.name}'
-   *
-   * export default defineConfig({
-   *   // ...
-   *   plugins: [myPlugin({})],
-   * })
-   * \`\`\`
-   */
-  export const myPlugin = definePlugin((config = {}) => {
-    // eslint-disable-next-line no-console
-    console.log(\`hello from ${pkg.name}\`)
-    return {
-      name: '${pkg.name}',
-    }
-  })
-`.trimStart() + '\n'
-  )
-}
-
-export function defaultSourceTs(pkg: PackageJson) {
-  return (
-    outdent`
-  import {definePlugin} from 'sanity'
-
-  interface MyPluginConfig {
-    /* nothing here yet */
-  }
-
-  /**
-   * Usage in \`sanity.config.ts\` (or .js)
-   *
-   * \`\`\`ts
-   * import {defineConfig} from 'sanity'
-   * import {myPlugin} from '${pkg.name}'
-   *
-   * export default defineConfig({
-   *   // ...
-   *   plugins: [myPlugin()],
-   * })
-   * \`\`\`
-   */
-  export const myPlugin = definePlugin<MyPluginConfig | void>((config = {}) => {
-    // eslint-disable-next-line no-console
-    console.log('hello from ${pkg.name}')
-    return {
-      name: '${pkg.name}',
-    }
-  })
-`.trimStart() + '\n'
-  )
-}

package/src/configs/eslint.ts

@@ -1,51 +0,0 @@
-import {InjectTemplate} from '../actions/inject'
-import {InitFlags} from '../actions/init'
-
-export function eslintrcTemplate(options: {flags: InitFlags}): InjectTemplate {
-  const {flags} = options
-
-  const eslintConfig = {
-    root: true,
-    env: {
-      node: true,
-      browser: true,
-    },
-    extends: [
-      'sanity',
-      flags.typescript && 'sanity/typescript',
-      'sanity/react',
-      'plugin:react-hooks/recommended',
-      flags.prettier && 'plugin:prettier/recommended',
-      'plugin:react/jsx-runtime',
-    ].filter(Boolean),
-  }
-
-  return {
-    type: 'template',
-    force: flags.force,
-    to: '.eslintrc',
-    value: JSON.stringify(eslintConfig, null, 2),
-  }
-}
-
-export function eslintignoreTemplate(options: {flags: InitFlags; outDir: string}): InjectTemplate {
-  const {flags, outDir} = options
-
-  const patterns = [
-    '.eslintrc.js',
-    'commitlint.config.js',
-    outDir,
-    'lint-staged.config.js',
-    flags.typescript ? 'package.config.ts' : 'package.config.js',
-    flags.typescript ? '*.js' : '',
-  ].filter(Boolean)
-
-  patterns.sort()
-
-  return {
-    type: 'template',
-    force: flags.force,
-    to: '.eslintignore',
-    value: patterns.join('\n'),
-  }
-}

package/src/configs/forced-package-versions.ts

@@ -1,12 +0,0 @@
-export const forcedPackageVersions = {}
-
-export const forcedDevPackageVersions = forcedPackageVersions
-
-export const forcedPeerPackageVersions = {
-  react: '^18',
-  'react-dom': '^18',
-  '@types/react': '^18',
-  '@types/react-dom': '^18',
-  sanity: '^3',
-  'styled-components': '^5.2',
-}

package/src/configs/git.ts

@@ -1,68 +0,0 @@
-import {outdent} from 'outdent'
-import {InjectTemplate} from '../actions/inject'
-
-export function gitignoreTemplate(): InjectTemplate {
-  return {
-    type: 'template',
-    to: '.gitignore',
-    value: outdent`
-      # Logs
-      logs
-      *.log
-      npm-debug.log*
-
-      # Runtime data
-      pids
-      *.pid
-      *.seed
-
-      # Directory for instrumented libs generated by jscoverage/JSCover
-      lib-cov
-
-      # Coverage directory used by tools like istanbul
-      coverage
-
-      # nyc test coverage
-      .nyc_output
-
-      # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-      .grunt
-
-      # node-waf configuration
-      .lock-wscript
-
-      # Compiled binary addons (http://nodejs.org/api/addons.html)
-      build/Release
-
-      # Dependency directories
-      node_modules
-      jspm_packages
-
-      # Optional npm cache directory
-      .npm
-
-      # Optional REPL history
-      .node_repl_history
-
-      # macOS finder cache file
-      .DS_Store
-
-      # VS Code settings
-      .vscode
-
-      # IntelliJ
-      .idea
-      *.iml
-
-      # Cache
-      .cache
-
-      # Yalc
-      .yalc
-      yalc.lock
-
-      # npm package zips
-      *.tgz
-    `,
-  }
-}