@sanity/plugin-kit 4.0.19 → 5.0.0

package/src/actions/link-watch.ts

@@ -1,98 +0,0 @@
-/*
-ISC License (ISC)
-Copyright 2019 Johan Otterud
-
-Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
-provided that the above copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
-WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH
-THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-/*
-This code is a modified version of https://github.com/johot/yalc-watch,
-and the ISC License has been added for this file only, in accordance with the package.json license field in that package
-*/
-
-import nodemon from 'nodemon'
-import concurrently from 'concurrently'
-import chalk from 'chalk'
-import fs from 'fs'
-import path from 'path'
-import log from '../util/log'
-import {getPackage} from '../npm/package'
-import outdent from 'outdent'
-import {fileExists, mkdir} from '../util/files'
-import {loadConfig as loadPackageConfig} from '@sanity/pkg-utils'
-import {defaultOutDir} from '../constants'
-
-interface YalcWatchConfig {
-  command?: string
-  extensions?: string
-}
-
-interface PackageJson {
-  sanityPlugin?: {linkWatch?: YalcWatchConfig}
-}
-
-export async function linkWatch({basePath}: {basePath: string}) {
-  const packageJson: PackageJson = JSON.parse(
-    fs.readFileSync(path.join(basePath, 'package.json'), 'utf8'),
-  )
-
-  const packageConfig = await loadPackageConfig({cwd: basePath})
-  const outDir = packageConfig?.dist ?? defaultOutDir
-
-  const watch: Required<YalcWatchConfig> = {
-    command: 'npm run watch',
-    extensions: 'ts,js,png,svg,gif,jpeg,css',
-    ...packageJson.sanityPlugin?.linkWatch,
-  }
-
-  nodemon({
-    watch: [outDir],
-    ext: watch.extensions,
-    exec: 'yalc push --changed',
-    //delay: 1000
-  })
-
-  // ensure the folder exits so it can be watched
-  const folder = path.join(basePath, outDir)
-  if (!(await fileExists(folder))) {
-    await mkdir(folder)
-  }
-
-  const pkg = await getPackage({basePath, validate: false})
-
-  concurrently([watch.command])
-
-  nodemon
-    .on('start', function () {
-      log.info(
-        outdent`
-        Watching ${outDir} for changes to files with extensions: ${watch.extensions}
-
-        To test this package in Sanity Studio or another package, in a separate shell run:
-        cd /path/to/sanity/studio-or-package
-
-        Then, run one of the below commands, based on the package manager used in studio-or-package:
-
-        ## yarn
-        ${chalk.greenBright(`yalc add --link ${pkg.name} && yarn install`)}
-
-        ## npm
-        ${chalk.greenBright(`npx yalc add ${pkg.name} && npx yalc link ${pkg.name} && npm install`)}
-      `.trimStart(),
-      )
-    })
-    .on('quit', function () {
-      process.exit()
-    })
-    .on('restart', function (files: any) {
-      log.info('Found changes in files:', chalk.magentaBright(files))
-      log.info('Pushing new yalc package...')
-    })
-}

package/src/actions/verify/types.ts

@@ -1,56 +0,0 @@
-import {VerifyPackageConfig} from './verify-common'
-
-export interface SanityPlugin {
-  verifyPackage?: VerifyPackageConfig
-}
-
-export interface PackageJson {
-  name?: string
-  version?: string
-  description?: string
-  author?: string
-  license?: string
-  source?: string
-  exports?: {
-    [index: string]: Record<string, string> | string | undefined
-  }
-  main?: string
-  module?: string
-  types?: string
-  browser?: string
-  files?: string[]
-  scripts?: Record<string, string>
-  dependencies?: Record<string, string>
-  peerDependencies?: Record<string, string>
-  devDependencies?: Record<string, string>
-  sanityPlugin?: SanityPlugin
-  engines?: {
-    node?: string
-  }
-  keywords?: string[]
-  repository?: {url?: string}
-
-  [index: string]: unknown
-}
-
-export interface SanityV2Json {
-  parts?: [
-    {
-      implements?: string
-      path?: 'string'
-    },
-  ]
-}
-
-export interface SanityStudioJson {
-  root?: boolean
-  project?: {
-    name?: string
-  }
-  api?: {
-    projectId?: string
-    dataset?: string
-  }
-  plugins?: string[]
-  parts?: Record<string, unknown>[]
-}

package/src/actions/verify/validations.ts

@@ -1,505 +0,0 @@
-import outdent from 'outdent'
-// @ts-expect-error missing types
-import validateNpmPackageName from 'validate-npm-package-name'
-import {incompatiblePluginPackage, urls} from '../../constants'
-import {deprecatedDevDeps, mergedPackages} from '../../configs/banned-packages'
-import path from 'path'
-import {fileExists, readJson5File} from '../../util/files'
-import chalk from 'chalk'
-import {PackageJson, SanityStudioJson, SanityV2Json} from './types'
-import {ParsedCommandLine} from 'typescript'
-
-export const expectedScripts = {
-  build: 'plugin-kit verify-package --silent && pkg-utils build --strict --check --clean',
-  watch: 'pkg-utils watch --strict',
-  'link-watch': 'plugin-kit link-watch',
-  prepublishOnly: 'npm run build',
-}
-
-function filesWithSuffixes(fileBases: string[], suffixes: string[]): string[] {
-  return fileBases.flatMap((file) => suffixes.map((suffix) => `${file}.${suffix}`))
-}
-
-export function validateNodeEngine(packageJson: PackageJson) {
-  const nodeVersionRange = '>=18'
-  if (!packageJson.engines?.node?.startsWith(nodeVersionRange)) {
-    return [
-      outdent`
-        Expected package.json to contain engines.node: ">=18" to ensure Studio compatible builds,
-        but it was: ${packageJson.engines?.node}
-
-        Please add the following to package.json:
-
-        "engines": {
-          "node": "${nodeVersionRange}"
-        }`.trimStart(),
-    ]
-  }
-}
-
-export function validateScripts(packageJson: PackageJson): string[] {
-  const errors: string[] = []
-
-  const divergentScripts = Object.entries(expectedScripts).filter(([key, expectedCommand]) => {
-    const command = packageJson.scripts?.[key]
-    // check for includes instead of equals to give some leniency in command params and such
-    return !command || !command.includes(expectedCommand)
-  })
-
-  if (divergentScripts.length) {
-    errors.push(
-      outdent`
-      The following script commands did not contain expected defaults: ${divergentScripts
-        .map(([key]) => key)
-        .join(', ')}
-
-      This checks for that the commands-strings includes these terms.
-
-      Please add the following to your package.json "scripts":
-
-      ${divergentScripts.map(([key, value]) => `"${key}": "${value}"`).join(',\n')}
-  `.trimStart(),
-    )
-  }
-  return errors
-}
-
-export async function validateTsConfig(
-  ts: ParsedCommandLine,
-  options: {basePath: string; outDir: string; tsconfig: string},
-) {
-  const {basePath, outDir, tsconfig} = options
-
-  const errors: string[] = []
-
-  const expectedCompilerOptions = {
-    target: 'esnext',
-    jsx: 'preserve',
-    module: 'preserve',
-    rootDir: '.',
-    outDir,
-    noEmit: true,
-  }
-
-  const wrongEntries = Object.entries(expectedCompilerOptions).filter(([key, value]) => {
-    let option: any = ts.options[key]
-
-    if (key === 'rootDir' && typeof option === 'string') {
-      option = path.relative(basePath, option) || '.'
-    }
-
-    if (key === 'outDir' && typeof option === 'string') {
-      option = path.relative(basePath, option) || '.'
-    }
-
-    if (key === 'target' && option === 99) {
-      option = 'esnext'
-    }
-
-    if (key === 'module' && option === 200) {
-      option = 'preserve'
-    }
-
-    if (key === 'jsx' && option === 1) {
-      option = 'preserve'
-    }
-
-    return typeof value === 'string' && typeof option === 'string'
-      ? value.toLowerCase() !== option?.toLowerCase()
-      : value !== option
-  })
-
-  if (wrongEntries.length) {
-    const expectedOutput = wrongEntries
-      .map(([key, value]) => `"${key}": ${typeof value === 'string' ? `"${value}"` : value},`)
-      .join('\n')
-
-    errors.push(
-      outdent`
-        Recommended ${tsconfig} compilerOptions missing:
-
-        The following fields had unexpected values: [${wrongEntries.map(([key]) => key).join(', ')}]
-        Expected to find these values:
-        ${expectedOutput}
-
-        Please update your ${tsconfig} accordingly.
-      `.trimStart(),
-    )
-  }
-
-  return errors
-}
-
-export function validatePkgUtilsDependency({devDependencies}: PackageJson): string[] {
-  if (!devDependencies?.['@sanity/pkg-utils']) {
-    return [
-      outdent`
-        package.json does not list @sanity/pkg-utils as a devDependency.
-        @sanity/pkg-utils replaced parcel as the recommended build tool in @sanity/plugin-kit 2.0.0
-
-        Please add it by running 'npm install --save-dev @sanity/pkg-utils'.
-    `.trimStart(),
-    ]
-  }
-  return []
-}
-
-export function validateSanityDependencies(packageJson: PackageJson): string[] {
-  const {dependencies, devDependencies, peerDependencies} = packageJson
-  const allDependencies = {...dependencies, ...devDependencies, ...peerDependencies}
-
-  const illegalDeps = Object.keys(allDependencies).filter((dep) => mergedPackages.includes(dep))
-  const deps = new Set<string>(illegalDeps)
-  const unique = [...deps.values()]
-  if (unique.length) {
-    return [
-      outdent`
-        package.json depends on "@sanity/*" packages that have moved into "sanity" package.
-
-        The following dependencies should be replaced with "sanity":
-        - ${unique.join('\n- ')}
-
-        Refer to the reference docs to find replacement imports:
-        ${urls.refDocs}
-    `.trimStart(),
-    ]
-  }
-  return []
-}
-
-export function validateDeprecatedDependencies(packageJson: PackageJson): string[] {
-  const {dependencies, devDependencies, peerDependencies} = packageJson
-  const allDependencies = {...dependencies, ...devDependencies, ...peerDependencies}
-
-  const illegalDeps = Object.keys(allDependencies).filter((dep) => deprecatedDevDeps.includes(dep))
-  const deps = new Set<string>(illegalDeps)
-  const unique = [...deps.values()]
-  if (unique.length) {
-    return [
-      outdent`
-        package.json contains deprecated dependencies that should be removed:
-        - ${unique.join('\n- ')}
-    `.trimStart(),
-    ]
-  }
-
-  return []
-}
-
-export async function validateBabelConfig({basePath}: {basePath: string}) {
-  const suffixes = ['json', 'js', 'cjs', 'mjs']
-  const babelFileNames = ['.babelrc', 'babel.config']
-  const filenames = ['.babelrc', ...filesWithSuffixes(babelFileNames, suffixes)]
-
-  const babelFiles: string[] = []
-  for (const filename of filenames) {
-    const filepath = path.normalize(path.join(basePath, filename))
-    if (await fileExists(filepath)) {
-      babelFiles.push(filename)
-    }
-  }
-
-  if (babelFiles.length) {
-    return [
-      outdent`
-        Found babel-config file: [${babelFiles.join(
-          ', ',
-        )}]. When using default @sanity/plugin-kit build command,
-        this is probably not needed.
-
-        Delete the file, or disable this check.
-      `.trimStart(),
-    ]
-  }
-  return []
-}
-
-export async function validateStudioConfig({basePath}: {basePath: string}): Promise<string[]> {
-  const suffixes = ['ts', 'js', 'tsx', 'jsx']
-
-  const filenames = filesWithSuffixes(['sanity.config', 'sanity.cli'], suffixes)
-
-  const files: Record<string, boolean | undefined> = {}
-
-  for (const filename of filenames) {
-    const filepath = path.normalize(path.join(basePath, filename))
-    files[filename] = await fileExists(filepath)
-  }
-
-  const sanityJson = await readJson5File<SanityStudioJson>({basePath, filename: 'sanity.json'})
-
-  const hasConfigFile = (fileBase: string) =>
-    filesWithSuffixes([fileBase], suffixes).some((filename) => files[filename])
-  const hasCliConfig = hasConfigFile('sanity.cli')
-  const hasStudioConfig = hasConfigFile('sanity.config')
-
-  const errors: string[] = []
-
-  if (sanityJson) {
-    const info = [
-      outdent`
-        Found sanity.json. This file is not used by Sanity Studio V3.
-
-        Please consult the Studio V3 migration guide:
-         ${urls.migrationGuideStudio}
-        It will detail how to convert sanity.json to sanity.config.ts (or .js) and sanity.cli.ts (or .js) equivalents.
-      `.trimStart(),
-      sanityJson.plugins?.length &&
-        outdent`
-        For V3 versions and alternatives to V2 plugins, please refer to the Sanity Exchange:
-        ${urls.sanityExchange}
-      `.trimStart(),
-    ].filter((s): s is string => !!s)
-
-    errors.push(info.join('\n\n'))
-  }
-
-  if (!hasCliConfig) {
-    errors.push(
-      outdent`
-        sanity.cli.(${suffixes.join(
-          ' | ',
-        )}) missing. Please create a file named sanity.cli.ts with the following content:
-
-        ${chalk.green(
-          outdent`
-        import {createCliConfig} from 'sanity/cli'
-
-        export default createCliConfig({
-          api: {
-            projectId: '${sanityJson?.api?.projectId ?? 'project-id'}',
-            dataset: '${sanityJson?.api?.dataset ?? 'dataset'}',
-          }
-        })`,
-        )}
-
-        Make sure to replace the projectId and dataset fields with your own.
-
-        For more, see ${urls.migrationGuideStudio}
-    `.trimStart(),
-    )
-  }
-
-  if (!hasStudioConfig) {
-    errors.push(
-      outdent`
-        sanity.config.(${suffixes.join(
-          ' | ',
-        )}) missing. At a minimum sanity.config.ts should contain:
-
-        ${chalk
-          .green(
-            outdent`
-            import { defineConfig } from "sanity"
-            import { deskTool } from "sanity/desk"
-
-            export default defineConfig({
-              name: "default",
-
-              projectId: '${sanityJson?.api?.projectId ?? 'project-id'}',
-              dataset: '${sanityJson?.api?.dataset ?? 'dataset'}',
-
-              plugins: [
-                deskTool(),
-              ],
-
-              schema: {
-                types: [
-                  /* put your v2 schema-types here */
-                ],
-              },
-            })`,
-          )
-          .trimStart()}
-
-        Make sure to replace the projectId and dataset fields with your own.
-
-        For more, see ${urls.migrationGuideStudio}
-    `.trimStart(),
-    )
-  }
-
-  return errors.length ? [errors.join(`\n\n---\n\n`)] : []
-}
-
-export async function validatePluginSanityJson({
-  basePath,
-  packageJson,
-}: {
-  basePath: string
-  packageJson: PackageJson
-}) {
-  const sanityJson = await readJson5File<SanityV2Json>({basePath, filename: 'sanity.json'})
-
-  const expectedDefaults = {
-    parts: [
-      {
-        implements: 'part:@sanity/base/sanity-root',
-        path: './v2-incompatible.js',
-      },
-    ],
-  }
-
-  const hasSinglePart =
-    sanityJson &&
-    Object.keys(sanityJson).length === 1 &&
-    sanityJson?.parts &&
-    sanityJson.parts.length === 1
-
-  const firstPart = hasSinglePart ? sanityJson?.parts?.[0] : undefined
-  const correctImplements = firstPart?.implements === expectedDefaults.parts[0].implements
-  const pathExists =
-    firstPart?.path && (await fileExists(path.normalize(path.join(basePath, firstPart.path))))
-  const hasDependency = !!packageJson.dependencies?.[incompatiblePluginPackage]
-  const isValid = sanityJson && hasSinglePart && correctImplements && pathExists && hasDependency
-
-  if (!isValid) {
-    const errors = [
-      !sanityJson ? 'sanity.json does not exist' : null,
-      !hasSinglePart ? 'sanity.json should have exactly one entry in "parts", but did not.' : null,
-      !correctImplements
-        ? `The part should implement ${expectedDefaults.parts[0].implements}, but did not.`
-        : null,
-      firstPart?.path && !pathExists
-        ? `The file in "path", ${firstPart?.path}, does not exist.`
-        : null,
-
-      !hasDependency
-        ? outdent`
-      package.json should have ${incompatiblePluginPackage} as a dependency, but did not.
-        Install it with: npm install --save ${incompatiblePluginPackage}
-      `.trimStart()
-        : null,
-    ].filter((e): e is string => !!e)
-
-    return [
-      outdent`
-        Invalid sanity.json. It is used for compatibility checking in V2 studios:
-
-        - ${errors.join('\n- ')}
-
-        sanity.json will only be used when incorrectly installing a v3 plugin in a v2 Studio.
-
-        This check ensures that sanity.json conforms with the usage section of
-        ${urls.incompatiblePlugin}
-    `.trimStart(),
-    ]
-  }
-  return []
-}
-
-export function validatePackageName(packageJson: PackageJson) {
-  const valid: {validForNewPackages?: boolean; errors: string[]} = validateNpmPackageName(
-    packageJson.name,
-  )
-  if (!valid.validForNewPackages) {
-    return [`Invalid package.json: "name" is invalid: ${valid.errors.join(', ')}`]
-  }
-
-  const isScoped = packageJson.name?.startsWith('@')
-  if (!isScoped && !packageJson.name?.startsWith('sanity-plugin-')) {
-    return [
-      `Invalid package.json: "name" should be prefixed with "sanity-plugin-" (or scoped - @your-company/plugin-name)`,
-    ]
-  }
-}
-
-export async function validateSrcIndexFile(basePath: string) {
-  const paths = ['index.js', 'index.ts'].map((p) => path.join('src', p))
-  const allowedIndexFiles = paths.map((file) => path.join(basePath, file))
-
-  let hasIndex = false
-  for (const indexFile of allowedIndexFiles) {
-    hasIndex = hasIndex || (await fileExists(indexFile))
-  }
-  if (!hasIndex) {
-    return [
-      outdent`
-      Expected one of [${paths.join(', ')}] to exist.
-
-      @sanity/pkg-utils expects a non-jsx file to be the source entry-point for the plugin.
-      If you currently have JSX in your index file, extract it into a separate file and import it.
-      `,
-    ]
-  }
-
-  return []
-}
-
-export async function disallowDuplicateConfig({
-  basePath,
-  pkgJson,
-  configKey,
-  files,
-}: {
-  basePath: string
-  pkgJson: PackageJson
-  configKey: string
-  files: string[]
-}) {
-  const found: string[] = []
-  for (const file of files) {
-    const filePath = path.join(basePath, file)
-    const exits = await fileExists(filePath)
-    if (exits) {
-      found.push(file)
-    }
-  }
-  if (found.length > 1) {
-    return [
-      outdent`
-      Found multiple config files that serve the same purpose: [${found.join(', ')}].
-
-      There should be at most one of these files. Delete the rest.
-      `,
-    ]
-  }
-  if (found.length && pkgJson[configKey]) {
-    return [
-      outdent`
-      package.json contains ${configKey}, but there also exists a config file that serves the same purpose.
-      Config file: ${found.join('')}]
-
-      Either delete the file or remove ${configKey} entry from package.json.
-      `,
-    ]
-  }
-
-  return []
-}
-
-export async function disallowDuplicateEslintConfig(basePath: string, pkgJson: PackageJson) {
-  return disallowDuplicateConfig({
-    basePath,
-    pkgJson,
-    configKey: 'eslint',
-    files: [
-      '.eslintrc',
-      '.eslintrc.js',
-      '.eslintrc.cjs',
-      '.eslintrc.yaml',
-      '.eslintrc.yml',
-      '.eslintrc.json',
-    ],
-  })
-}
-
-export async function disallowDuplicatePrettierConfig(basePath: string, pkgJson: PackageJson) {
-  return disallowDuplicateConfig({
-    basePath,
-    pkgJson,
-    configKey: 'prettier',
-    files: [
-      '.prettierrc',
-      '.prettierrc.json5',
-      '.prettierrc.json',
-      '.prettierrc.yaml',
-      '.prettierrc.yml',
-      '.prettierrc.js',
-      '.prettierrc.cjs',
-      '.prettier.config,js',
-      '.prettier.config.cjs',
-      '.prettierrc.toml',
-    ],
-  })
-}