@sanity/cli/src/actions/init-project/createPackageManifest.ts

Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets

import sortObject from 'deep-sort-object'

import {type PackageJson, type SanityJson} from '../../types'

const manifestPropOrder = [
  'name',
  'private',
  'version',
  'description',
  'main',
  'author',
  'license',
  'scripts',
  'keywords',
  'dependencies',
  'devDependencies',
]

export function createPackageManifest(
  data: Omit<PackageJson, 'version'> & {gitRemote?: string} & {isAppTemplate?: boolean},
): string {
  const {isAppTemplate} = data

  const dependencies = data.dependencies ? {dependencies: sortObject(data.dependencies)} : {}

  const devDependencies = data.devDependencies
    ? {devDependencies: sortObject(data.devDependencies)}
    : {}

  // Don't write a prettier config for SDK apps; we want to allow developers to use their own
  const prettierConfig = isAppTemplate
    ? {}
    : {
        prettier: {
          semi: false,
          printWidth: 100,
          bracketSpacing: false,
          singleQuote: true,
        },
      }

  const pkg = {
    ...getCommonManifest(data),

    main: 'package.json',
    keywords: ['sanity'],
    scripts: data.scripts || {
      'dev': 'sanity dev',
      'start': 'sanity start',
      'build': 'sanity build',
      'deploy': 'sanity deploy',
      'deploy-graphql': 'sanity graphql deploy',
    },

    ...dependencies,
    ...devDependencies,
    ...prettierConfig,
  }

  return serializeManifest(pkg)
}

function getCommonManifest(data: Omit<PackageJson, 'version'> & {gitRemote?: string}) {
  const pkg: PackageJson = {
    name: data.name,
    version: '1.0.0',
    description: data.description,
    author: data.author,
    license: data.license || 'UNLICENSED',
    devDependencies: {},
  }

  if (pkg.license === 'UNLICENSED') {
    pkg.private = true
  }

  if (data.gitRemote) {
    pkg.repository = {
      type: 'git',
      url: data.gitRemote,
    }
  }

  return pkg
}

function serializeManifest(src: PackageJson | SanityJson): string {
  const props = manifestPropOrder.concat(Object.keys(src))
  const ordered = props.reduce(
    (target, prop) => {
      const source = src as any
      if (typeof source[prop] !== 'undefined' && typeof target[prop] === 'undefined') {
        target[prop] = source[prop]
      }

      return target
    },
    {} as Record<string, any>,
  )

  return `${JSON.stringify(ordered, null, 2)}\n`
}