@sanity/plugin-kit 0.0.1-studio-v3.1

package/package.json

@@ -0,0 +1,127 @@
+{
+  "name": "@sanity/plugin-kit",
+  "version": "0.0.1-studio-v3.1",
+  "description": "Enhanced Sanity.io plugin development experience",
+  "scripts": {
+    "clean": "rimraf lib",
+    "prebuild": "npm run clean",
+    "build": "tsc",
+    "postbuild": "node executable-index.js",
+    "watch": "tsc --watch",
+    "test": "tap",
+    "prepare": "husky install",
+    "commit": "git-cz",
+    "lint": "eslint .",
+    "compile": "tsc --noEmit",
+    "format": "prettier src -w",
+    "semantic-release": "semantic-release",
+    "prepublishOnly": "npm run build"
+  },
+  "binname": "sanity-plugin",
+  "source": "./src/index.ts",
+  "types": "./lib/src/index.d.ts",
+  "bin": "lib/src/index.js",
+  "main": "./lib/src/index.js",
+  "files": [
+    "v2-incompatible.js",
+    "src",
+    "lib",
+    "assets"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/rexxars/sanipack.git"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "keywords": [
+    "sanity-io",
+    "sanity",
+    "plugin",
+    "development",
+    "babel",
+    "typescript",
+    "bootstrap"
+  ],
+  "author": "Sanity.io <hello@sanity.io>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/rexxars/sanipack/issues"
+  },
+  "homepage": "https://github.com/rexxars/sanipack#readme",
+  "dependencies": {
+    "@rexxars/choosealicense-list": "^1.1.2",
+    "chalk": "^4.1.2",
+    "concurrently": "^7.1.0",
+    "discover-path": "^1.0.0",
+    "email-validator": "^2.0.4",
+    "execa": "^5.1.1",
+    "find-babel-config": "^1.2.0",
+    "get-it": "^5.0.5",
+    "get-latest-version": "^2.0.0",
+    "git-remote-origin-url": "^3.1.0",
+    "git-user-info": "^1.0.1",
+    "github-url-to-object": "^4.0.6",
+    "inquirer": "^8.2.0",
+    "meow": "^9.0.0",
+    "nodemon": "^2.0.15",
+    "npm-packlist": "^3.0.0",
+    "npm-run-path": "^4.0.1",
+    "outdent": "^0.8.0",
+    "p-any": "^3.0.0",
+    "p-props": "^4.0.0",
+    "postcss": "^8.3.9",
+    "rimraf": "^3.0.2",
+    "semver": "^7.3.5",
+    "spdx-license-ids": "^3.0.10",
+    "validate-npm-package-name": "^3.0.0",
+    "xdg-basedir": "^4.0.0",
+    "yalc": "^1.0.0-pre.53"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
+    "@parcel/packager-ts": "^2.6.0",
+    "@parcel/transformer-typescript-types": "^2.6.0",
+    "@types/eslint": "^8.4.3",
+    "@types/inquirer": "^8.2.1",
+    "@types/node": "^17.0.40",
+    "@types/nodemon": "^1.19.1",
+    "@types/tap": "^15.0.7",
+    "@typescript-eslint/eslint-plugin": "^5.20.0",
+    "@typescript-eslint/parser": "^5.20.0",
+    "eslint": "^8.15.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-sanity": "^5.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^7.0.4",
+    "json5": "^2.2.1",
+    "lint-staged": "^12.4.0",
+    "parcel": "^2.6.0",
+    "prettier": "^2.6.2",
+    "readdirp": "^3.6.0",
+    "rimraf": "^3.0.2",
+    "semantic-release": "^19.0.2",
+    "sanity": "^2.30.1-purple-unicorn.940",
+    "sinon": "^14.0.0",
+    "tap": "^16.2.0",
+    "ts-node": "^10.8.0",
+    "typescript": "^4.7.2"
+  },
+  "tap": {
+    "jobs": 2,
+    "browser": false,
+    "timeout": 120,
+    "reporter": "spec",
+    "check-coverage": false,
+    "coverage-report": [
+      "html"
+    ],
+    "test-ignore": "^lib/.*|.*ignore.*|.*run-test-command.*|.*fixture.utils.*",
+    "ts": true
+  }
+}

package/src/actions/init.ts

@@ -0,0 +1,104 @@
+import path from 'path'
+import {splat} from './splat'
+import {ensureDir, writeFile} from '../util/files'
+import {resolveLatestVersions} from '../npm/resolveLatestVersions'
+import sharedFlags from '../sharedFlags'
+import {TypedFlags} from 'meow'
+import {getPackage} from '../npm/package'
+import {defaultSourceJs, defaultSourceTs} from '../configs/default-source'
+import {incompatiblePluginPackage} from '../constants'
+
+export const initFlags = {
+  ...sharedFlags,
+  scripts: {
+    type: 'boolean',
+    default: true,
+  },
+  eslint: {
+    type: 'boolean',
+    default: true,
+  },
+  typescript: {
+    type: 'boolean',
+    default: true,
+  },
+  prettier: {
+    type: 'boolean',
+    default: true,
+  },
+  license: {
+    type: 'string',
+  },
+  editorconfig: {
+    type: 'boolean',
+    default: true,
+  },
+  gitignore: {
+    type: 'boolean',
+    default: true,
+  },
+  force: {
+    type: 'boolean',
+    default: false,
+  },
+  install: {
+    type: 'boolean',
+    default: true,
+  },
+  name: {
+    type: 'string',
+  },
+  author: {
+    type: 'string',
+  },
+  repo: {
+    type: 'string',
+  },
+} as const
+
+export type InitFlags = TypedFlags<typeof initFlags>
+
+const defaultDependencies = [incompatiblePluginPackage]
+// purple-unicorn as version in devDependencies will install 2.29.5, so must be explicit
+// using ^2.29.5-purple-unicorn.856 is not safe either
+const defaultDevDependencies = {react: '^17.0.0 || ^18.0.0', sanity: '2.29.5-purple-unicorn.856'}
+const defaultPeerDependencies = {react: '^17.0.0 || ^18.0.0', sanity: 'purple-unicorn'}
+
+export interface InitOptions {
+  basePath: string
+  flags: InitFlags
+}
+
+export async function init(options: InitOptions) {
+  let dependencies = {}
+  let devDependencies = {}
+  let peerDependencies = {}
+
+  dependencies = {...dependencies, ...(await resolveLatestVersions(defaultDependencies))}
+  devDependencies = {
+    ...devDependencies,
+    ...defaultDevDependencies,
+    ...(await resolveLatestVersions(['rimraf'])),
+  }
+  peerDependencies = {
+    ...peerDependencies,
+    ...defaultPeerDependencies,
+  }
+
+  await splat({
+    ...options,
+    requireUserConfirmation: !options.flags.force,
+    dependencies,
+    devDependencies,
+    peerDependencies,
+    validate: false,
+  })
+
+  const packageJson = await getPackage({basePath: options.basePath, validate: false})
+  const typescript = options.flags.typescript
+  const source = typescript ? defaultSourceTs(packageJson) : defaultSourceJs(packageJson)
+  const filename = typescript ? 'index.ts' : 'index.js'
+  const srcDir = path.resolve(options.basePath, 'src')
+  await ensureDir(srcDir)
+  await writeFile(path.join(srcDir, filename), source, {encoding: 'utf8'})
+}

package/src/actions/link-watch.ts

@@ -0,0 +1,74 @@
+/*
+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'
+
+interface YalcWatchConfig {
+  folder?: string
+  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(process.cwd(), 'package.json'), 'utf8')
+  )
+
+  const watch: Required<YalcWatchConfig> = {
+    folder: 'lib',
+    command: 'npm run watch',
+    extensions: 'js,png,svg,gif,jpeg,css',
+    ...packageJson.sanityPlugin?.linkWatch,
+  }
+
+  nodemon({
+    watch: [watch.folder],
+    ext: watch.extensions,
+    exec: 'yalc push --changed',
+    //delay: 1000
+  })
+
+  const pkg = await getPackage({basePath, validate: false})
+
+  nodemon
+    .on('start', function () {
+      log.info(`Watching ${watch.folder} for changes to files with extensions: ${watch.extensions}`)
+      log.info(`\nTo test this package in another repository directory run:`)
+      log.success(`yalc add --link \n${pkg.name} && yarn install`)
+    })
+    .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...')
+    })
+
+  concurrently([watch.command])
+}

package/src/actions/splat.ts

@@ -0,0 +1,366 @@
+import path from 'path'
+// @ts-expect-error missing types
+import licenses from '@rexxars/choosealicense-list'
+import gitRemoteOriginUrl from 'git-remote-origin-url'
+import log from '../util/log'
+import {getUserInfo} from '../util/user'
+import {errorToUndefined} from '../util/errorToUndefined'
+import {addBuildScripts, getPackage, writePackageJson} from '../npm/package'
+import {prompt, promptForPackageName, promptForRepoOrigin} from '../util/prompt'
+import {generateReadme, isDefaultGitHubReadme} from '../util/readme'
+
+import {
+  copyFileWithOverwritePrompt,
+  fileExists,
+  readFile,
+  writeFile,
+  writeFileWithOverwritePrompt,
+} from '../util/files'
+import {InitFlags} from './init'
+import {PackageJson} from './verify/types'
+
+const bannedFields = ['login', 'description', 'projecturl', 'email']
+const preferredLicenses = ['MIT', 'ISC', 'BSD-3-Clause']
+const otherLicenses = Object.keys(licenses.list).filter((id) => {
+  const license = licenses.list[id]
+  return (
+    !preferredLicenses.includes(id) &&
+    !bannedFields.some((field) => license.body.includes(`[${field}]`))
+  )
+})
+
+export interface SplatOptions {
+  basePath: string
+  requireUserConfirmation?: boolean
+  flags: InitFlags
+  dependencies?: Record<string, string>
+  devDependencies?: Record<string, string>
+  peerDependencies?: Record<string, string>
+  validate?: boolean
+}
+
+export interface PackageData {
+  user?: {name?: string; email?: string}
+  pluginName?: string
+  license?: {id: string; text: string}
+  description?: string
+  pkg?: PackageJson
+  gitOrigin?: string
+}
+
+export async function splat(options: SplatOptions) {
+  const {basePath, flags, requireUserConfirmation} = options
+  const info = (write: boolean, msg: string, ...args: string[]) => write && log.info(msg, ...args)
+  // Gather data
+  const pkg = await getPackage(options).catch(errorToUndefined)
+  log.debug('Plugin has package.json: %s', pkg ? 'yes' : 'no')
+
+  const user = await getUserInfo(options, pkg)
+  log.debug('User information: %o', user)
+
+  const pkgName = flags.name ?? pkg?.name
+  const pluginName =
+    requireUserConfirmation || !pkgName ? await promptForPackageName(options, pkgName) : pkgName
+
+  log.debug('Plugin name: %s', pluginName)
+
+  const license = await getLicense(flags, {user, pluginName, pkg, requireUserConfirmation})
+  const licenseChanged = (pkg && pkg.license) !== (license && license.id)
+  log.debug('License: %s', license ? license.id : '<none>')
+
+  const description = await getProjectDescription(basePath, pkg, requireUserConfirmation)
+  log.debug('Description: %s', description || '<none>')
+
+  const repoUrl =
+    flags.repo ??
+    ((await gitRemoteOriginUrl(basePath).catch(errorToUndefined)) || pkg?.repository?.url)
+
+  const gitOrigin = requireUserConfirmation ? await promptForRepoOrigin(options, repoUrl) : repoUrl
+
+  log.debug('Remote origin: %s', gitOrigin || '<none>')
+
+  // Output
+  const data: PackageData = {user, pluginName, license, description, pkg, gitOrigin}
+  let didWrite
+
+  // Write package.json, if returns the original (data.pkg) if it was unchanged,
+  // otherwise it returns the new object
+  const newPkg = await writePackageJson(data, options)
+  info(newPkg !== pkg, 'Wrote package.json')
+  data.pkg = newPkg
+
+  didWrite = await writeLicense(data, options, licenseChanged)
+  info(didWrite, 'Wrote license file (LICENSE)')
+
+  didWrite = await writeReadme(data, options)
+  info(didWrite, 'Wrote readme file (README.md)')
+
+  didWrite = await writeStaticAssets(options)
+  info(didWrite.length > 0, 'Wrote static asset files: %s', didWrite.join(', '))
+
+  didWrite = await writeEslintrc(options)
+  info(didWrite, 'Wrote .eslintrc.js')
+
+  didWrite = await addBuildScripts(newPkg, options)
+  info(didWrite, 'Added build scripts to package.json')
+
+  didWrite = await addCompileDirToGitIgnore(data, options)
+  info(didWrite, 'Added compilation output directory to .gitignore')
+}
+
+async function writeReadme(data: PackageData, options: SplatOptions) {
+  const {basePath} = options
+
+  const readmePath = path.join(basePath, 'README.md')
+  const readme = await readFile(readmePath, 'utf8').catch(errorToUndefined)
+
+  if (readme && !isDefaultGitHubReadme(readme)) {
+    return false
+  }
+
+  await writeFileWithOverwritePrompt(readmePath, generateReadme(data), {
+    encoding: 'utf8',
+    force: options.flags.force,
+  })
+  return true
+}
+
+async function writeEslintrc(options: SplatOptions) {
+  if (!options.flags.eslint) {
+    return false
+  }
+  const {basePath} = options
+
+  const eslintrc = path.join(basePath, '.eslintrc')
+
+  const config = {
+    root: true,
+    env: {
+      node: true,
+      browser: true,
+    },
+    extends: [
+      'sanity',
+      options.flags.typescript && 'sanity/typescript',
+      'sanity/react',
+      'plugin:react-hooks/recommended',
+      options.flags.prettier && 'plugin:prettier/recommended',
+    ].filter(Boolean),
+  }
+
+  const content = JSON.stringify(config, null, 2)
+  await writeFileWithOverwritePrompt(eslintrc, content, {
+    encoding: 'utf8',
+    force: options.flags.force,
+  })
+  return true
+}
+
+async function writeLicense(
+  {license}: PackageData,
+  options: SplatOptions,
+  licenseChanged: boolean
+) {
+  const {basePath, flags} = options
+
+  if ((flags.license as unknown as boolean) === false || !license) {
+    return false
+  }
+
+  // Prefer whatever path the user is currenly using (LICENSE.md or LICENSE)
+  const hasLicenseMdFile = await fileExists(path.join(basePath, 'LICENSE.md'))
+  const licensePath = path.join(basePath, hasLicenseMdFile ? 'LICENSE.md' : 'LICENSE')
+
+  await writeFileWithOverwritePrompt(licensePath, license.text, {
+    encoding: 'utf8',
+    default: licenseChanged,
+    force: flags.force,
+  })
+
+  return true
+}
+
+async function getLicense(
+  flags: InitFlags,
+  {
+    user,
+    pluginName,
+    pkg,
+    requireUserConfirmation,
+  }: PackageData & {requireUserConfirmation?: boolean}
+) {
+  const license = await getLicenseIdentifier(flags, pkg, requireUserConfirmation)
+  if (!license) {
+    return undefined
+  }
+
+  const text = license.body
+    .replace(/\[fullname\]/g, user?.name)
+    .replace(/\[project\]/g, pluginName)
+    .replace(/\[year\]/g, new Date().getFullYear())
+
+  return {id: license.id, text}
+}
+
+async function getLicenseIdentifier(
+  flags: InitFlags,
+  pkg: PackageJson | undefined,
+  requireUserConfirmation = false
+) {
+  // --no-license
+  if ((flags.license as unknown) === false) {
+    return null
+  }
+
+  // --license becomes "", --license mit beocomes "mit"
+  if (typeof flags.license === 'string') {
+    const license = licenses.find(`${flags.license}`)
+    if (!license) {
+      throw new Error(`License "${flags.license}" not found`)
+    }
+    return license
+  }
+
+  // no --license flag provided, do we have one in package already?
+  if (pkg && pkg.license && !requireUserConfirmation) {
+    const license = licenses.find(`${pkg.license}`)
+    if (license) {
+      return license
+    }
+
+    // Warn, then prompt the user
+    log.warn(`package.json contains license "${pkg.license}", which is not recognized`)
+  }
+
+  const licenseId = await prompt('Which license do you want to use?', {
+    default: pkg && pkg.license && licenses.find(pkg.license) ? pkg.license : preferredLicenses[0],
+    choices: [
+      prompt.separator(),
+      ...preferredLicenses.map((value) => ({value, name: licenses.list[value].title})),
+      prompt.separator(),
+      ...otherLicenses.map((value) => ({value, name: licenses.list[value].title})),
+    ],
+  })
+
+  return licenses.find(licenseId)
+}
+
+async function getProjectDescription(
+  basePath: string,
+  pkg: PackageJson | undefined,
+  requireUserConfirmation = false
+) {
+  let description = await resolveProjectDescription(basePath, pkg)
+  if (requireUserConfirmation) {
+    description = await prompt('Plugin description', {default: description || ''})
+  }
+  return description ?? ''
+}
+
+async function resolveProjectDescription(basePath: string, pkg: PackageJson | undefined) {
+  // Try to grab from package.json
+  if (pkg && typeof pkg.description === 'string' && pkg.description.length > 5) {
+    return pkg.description
+  }
+
+  // Try to grab a project description from a standard GitHub-generated readme
+  try {
+    const readmePath = path.join(basePath, 'README.md')
+    const readme = await readFile(readmePath, 'utf8')
+    const [title, description] = readme.split('\n').filter(Boolean)
+    if (!title || !description || !title.match(/^#\s+\w+/)) {
+      return null
+    }
+
+    // Naive, but this isn't too important
+    const unlinked = description.replace(/\[(.*?)\]\(.*?\)/g, '$1')
+    if (/^[^#]/.test(unlinked)) {
+      return unlinked
+    }
+
+    return null
+  } catch (err) {
+    return errorToUndefined(err)
+  }
+}
+
+type FromTo = {from: string; to: string}
+
+async function writeStaticAssets({basePath, flags}: SplatOptions) {
+  const assetsDir = await findAssetsDir()
+
+  const from = (...segments: string[]) => path.join(assetsDir, 'splat', ...segments)
+  const to = (...segments: string[]) => path.join(basePath, ...segments)
+
+  const files: FromTo[] = [
+    {from: 'editorconfig', to: '.editorconfig'},
+    {from: 'npmignore', to: '.npmignore'},
+    {from: 'sanity.json', to: 'sanity.json'},
+    {from: 'v2-incompatible.js.template', to: 'v2-incompatible.js'},
+    flags.gitignore && {from: 'gitignore', to: '.gitignore'},
+    flags.typescript && {from: 'template-tsconfig.json', to: 'tsconfig.json'},
+    flags.prettier && {from: 'prettierrc.js', to: '.prettierrc.js'},
+  ].filter((f): f is FromTo => !!f)
+
+  const writes: string[] = []
+  for (const file of files) {
+    if (await copyFileWithOverwritePrompt(from(file.from), to(file.to), flags)) {
+      writes.push(file.to)
+    }
+  }
+
+  return writes
+}
+
+/**
+ * assets dir might be in higher or lower in the dir hierarchy depending on
+ * if we run from lib or src
+ */
+async function findAssetsDir(): Promise<string> {
+  let maxBackpaddle = 3
+  let currDir = __dirname
+  let assetsDir: string = ''
+  while (!assetsDir && maxBackpaddle) {
+    currDir = path.join(currDir, '..')
+    const assets = path.join(currDir, 'assets')
+    if (await fileExists(assets)) {
+      assetsDir = assets
+    } else {
+      maxBackpaddle--
+    }
+  }
+
+  if (!assetsDir) {
+    throw new Error('Could not find assets directory!')
+  }
+  return assetsDir
+}
+
+async function addCompileDirToGitIgnore(data: PackageData, options: SplatOptions) {
+  const gitIgnorePath = path.join(options.basePath, '.gitignore')
+  const gitignore = await readFile(gitIgnorePath, 'utf8').catch(errorToUndefined)
+  if (!gitignore) {
+    return false
+  }
+
+  const output = data.pkg?.main ?? data.pkg?.module
+  if (!output) {
+    return false
+  }
+
+  const ignorePath = output.replace(/^[./]+/, '')
+  const ignore = ignorePath.split('/')[0]
+  if (!ignore) {
+    return false
+  }
+
+  const lines = gitignore.split('\n')
+  if (lines.includes(ignore)) {
+    return false
+  }
+
+  lines.push('# Compiled plugin', ignore, '\n')
+
+  await writeFile(gitIgnorePath, lines.join('\n'), {encoding: 'utf8'})
+  return true
+}