@sanity/plugin-kit 2.2.0 → 3.1.0

package/src/presets/semver-workflow.ts

@@ -1,4 +1,4 @@
-import {FromTo, InjectOptions, writeAssets} from '../actions/inject'
+import {Injectable, InjectOptions, writeAssets} from '../actions/inject'
 import {resolveLatestVersions} from '../npm/resolveLatestVersions'
 import {Preset} from './presets'
 import {
@@ -148,19 +148,31 @@ function closeEnough(a: string, b: string) {
   return isCloseEnough
 }
 
-function semverWorkflowFiles(): FromTo[] {
-  return [
-    {from: ['.github', 'workflows', 'main.yml'], to: ['.github', 'workflows', 'main.yml']},
-    {from: ['.husky', 'commit-msg'], to: ['.husky', 'commit-msg']},
-    {from: ['.husky', 'pre-commit'], to: ['.husky', 'pre-commit']},
-    {from: ['.releaserc.json'], to: '.releaserc.json'},
-    {from: ['npmrc'], to: '.npmrc'},
-    {from: ['commitlint.template.js'], to: 'commitlint.config.js'},
-    {from: ['lint-staged.template.js'], to: 'lint-staged.config.js'},
-  ].map((fromTo) => ({
-    ...fromTo,
-    from: ['semver-workflow', ...fromTo.from],
-  }))
+function semverWorkflowFiles(): Injectable[] {
+  const base: Injectable[] = [
+    {
+      type: 'copy',
+      from: ['.github', 'workflows', 'main.yml'],
+      to: ['.github', 'workflows', 'main.yml'],
+    },
+    {type: 'copy', from: ['.husky', 'commit-msg'], to: ['.husky', 'commit-msg']},
+    {type: 'copy', from: ['.husky', 'pre-commit'], to: ['.husky', 'pre-commit']},
+    {type: 'copy', from: ['.releaserc.json'], to: '.releaserc.json'},
+    {type: 'copy', from: ['npmrc'], to: '.npmrc'},
+    {type: 'copy', from: ['commitlint.template.js'], to: 'commitlint.config.js'},
+    {type: 'copy', from: ['lint-staged.template.js'], to: 'lint-staged.config.js'},
+  ]
+
+  return base.map((fromTo) => {
+    if (fromTo.type === 'copy') {
+      return {
+        ...fromTo,
+        from: ['semver-workflow', ...fromTo.from],
+      }
+    }
+
+    return fromTo
+  })
 }
 
 async function semverWorkflowDependencies(): Promise<Record<string, string>> {

package/src/presets/ui-workshop.ts

@@ -1,5 +1,5 @@
 import {Preset} from './presets'
-import {FromTo, InjectOptions, writeAssets} from '../actions/inject'
+import {Injectable, InjectOptions, writeAssets} from '../actions/inject'
 import {getPackage, sortKeys, writePackageJsonDirect} from '../npm/package'
 import log from '../util/log'
 import chalk from 'chalk'
@@ -32,16 +32,32 @@ async function applyPreset(options: InjectOptions) {
   )
 }
 
-function files(): FromTo[] {
-  return [
-    {from: ['workshop.config.ts'], to: ['workshop.config.ts']},
-    {from: ['src', 'CustomField.tsx'], to: ['src', 'CustomField.tsx']},
-    {from: ['src', '__workshop__', 'index.tsx'], to: ['src', '__workshop__', 'index.tsx']},
-    {from: ['src', '__workshop__', 'props.tsx'], to: ['src', '__workshop__', 'props.tsx']},
-  ].map((fromTo) => ({
-    ...fromTo,
-    from: ['ui-workshop', ...fromTo.from],
-  }))
+function files(): Injectable[] {
+  const base: Injectable[] = [
+    {type: 'copy', from: ['workshop.config.ts'], to: ['workshop.config.ts']},
+    {type: 'copy', from: ['src', 'CustomField.tsx'], to: ['src', 'CustomField.tsx']},
+    {
+      type: 'copy',
+      from: ['src', '__workshop__', 'index.tsx'],
+      to: ['src', '__workshop__', 'index.tsx'],
+    },
+    {
+      type: 'copy',
+      from: ['src', '__workshop__', 'props.tsx'],
+      to: ['src', '__workshop__', 'props.tsx'],
+    },
+  ]
+
+  return base.map((fromTo) => {
+    if (fromTo.type === 'copy') {
+      return {
+        ...fromTo,
+        from: ['ui-workshop', ...fromTo.from],
+      }
+    }
+
+    return fromTo
+  })
 }
 
 async function updateGitIgnore(options: InjectOptions) {
@@ -76,6 +92,6 @@ async function devDependencies(): Promise<Record<string, string>> {
     '@sanity/ui',
     'react',
     'react-dom',
-    'styled-component',
+    'styled-components',
   ])
 }

package/src/presets/ui.ts

@@ -0,0 +1,68 @@
+import {Preset} from './presets'
+import {InjectOptions} from '../actions/inject'
+import {forceDependencyVersions, getPackage, sortKeys, writePackageJsonDirect} from '../npm/package'
+import log from '../util/log'
+import chalk from 'chalk'
+import {resolveLatestVersions} from '../npm/resolveLatestVersions'
+import {forcedDevPackageVersions, forcedPackageVersions} from '../configs/forced-package-versions'
+
+export const ui: Preset = {
+  name: 'ui',
+  description: '`@sanity/ui` and dependencies',
+  apply: applyPreset,
+}
+
+async function applyPreset(options: InjectOptions) {
+  await addDependencies(options)
+  await addDevDependencies(options)
+
+  log.info(chalk.green('ui preset injected'))
+}
+
+async function addDependencies(options: InjectOptions) {
+  const pkg = await getPackage(options)
+  const newDeps = sortKeys(
+    forceDependencyVersions(
+      {
+        ...pkg.dependencies,
+        ...(await resolveDependencyList()),
+      },
+      forcedPackageVersions
+    )
+  )
+  const newPkg = {...pkg}
+  newPkg.dependencies = newDeps
+  await writePackageJsonDirect(newPkg, options)
+  log.info('Updated dependencies.')
+}
+
+async function addDevDependencies(options: InjectOptions) {
+  const pkg = await getPackage(options)
+  const newDeps = sortKeys(
+    forceDependencyVersions(
+      {
+        ...pkg.devDependencies,
+        ...(await resolveDevDependencyList()),
+      },
+      forcedDevPackageVersions
+    )
+  )
+  const newPkg = {...pkg}
+  newPkg.devDependencies = newDeps
+  await writePackageJsonDirect(newPkg, options)
+  log.info('Updated devDependencies.')
+}
+
+async function resolveDependencyList(): Promise<Record<string, string>> {
+  return resolveLatestVersions(['@sanity/icons', '@sanity/ui'])
+}
+
+async function resolveDevDependencyList(): Promise<Record<string, string>> {
+  return resolveLatestVersions([
+    // install the peer dependencies of `@sanity/ui` as dev dependencies
+    'react',
+    'react-dom',
+    'react-is',
+    'styled-components',
+  ])
+}

package/src/sanity/manifest.ts

@@ -233,7 +233,7 @@ async function validatePartFiles(
     return
   }
 
-  const [srcExists, libExists] = await Promise.all([
+  const [srcExists, outDirExists] = await Promise.all([
     hasSourceFile(part.path, paths),
     verifyCompiledParts && hasCompiledFile(part.path, paths),
   ])
@@ -246,7 +246,7 @@ async function validatePartFiles(
     )
   }
 
-  if (verifyCompiledParts && !libExists) {
+  if (verifyCompiledParts && !outDirExists) {
     throw new Error(
       `Invalid sanity.json: Part path references file ("${part.path}") that does not exist in compiled directory (${paths?.compiled}) (parts[${index}])`
     )

package/src/util/files.ts

@@ -24,10 +24,10 @@ export function hasSourceEquivalent(compiledFile: string, paths: ManifestPaths)
     )
   }
 
-  // /plugin/lib/MyComponent.js => /plugin/src
+  // /plugin/dist/MyComponent.js => /plugin/src
   const baseDir = path.dirname(compiledFile.replace(paths.compiled as string, paths.source))
 
-  // /plugin/lib/MyComponent.js => MyComponent
+  // /plugin/dist/MyComponent.js => MyComponent
   const baseName = path.basename(compiledFile, path.extname(compiledFile))
 
   // MyComponent => /plugin/src/MyComponent
@@ -72,14 +72,14 @@ export function hasCompiledFile(filePath: string, paths?: ManifestPaths) {
   }
 
   // filePath: components/SomeInput
-  // paths: {compiled: '/plugin/lib'}
+  // paths: {compiled: '/plugin/dist'}
 
-  // components/SomeInput => /plugin/lib/components/SomeInput
+  // components/SomeInput => /plugin/dist/components/SomeInput
   const absPath = path.isAbsolute(filePath) ? filePath : path.resolve(paths.compiled, filePath)
 
-  // /plugin/lib/components/SomeInput     => /plugin/lib/components/SomeInput.js
-  // /plugin/lib/components/SomeInput.js  => /plugin/lib/components/SomeInput.js
-  // /plugin/lib/components/SomeInput.css => /plugin/lib/components/SomeInput.css
+  // /plugin/dist/components/SomeInput     => /plugin/dist/components/SomeInput.js
+  // /plugin/dist/components/SomeInput.js  => /plugin/dist/components/SomeInput.js
+  // /plugin/dist/components/SomeInput.css => /plugin/dist/components/SomeInput.css
   const fileExt = path.extname(absPath)
   const withExt = fileExt === '' ? `${absPath}.js` : absPath
 
@@ -106,7 +106,7 @@ export async function readJsonFile<T>(filePath: string) {
 }
 
 export function writeJsonFile(filePath: string, content: Record<string, unknown>) {
-  const data = JSON.stringify(content, null, 2)
+  const data = JSON.stringify(content, null, 2) + '\n'
   return writeFile(filePath, data, {encoding: 'utf8'})
 }
 

package/src/util/readme.ts

@@ -7,7 +7,8 @@ import {User} from './user'
 export function generateReadme(data: PackageData) {
   const {user, pluginName, license, description} = data
 
-  return outdent`
+  return (
+    outdent`
     # ${pluginName}
 
     ${v3BannerNotice()}
@@ -15,22 +16,23 @@ export function generateReadme(data: PackageData) {
     ${installationSnippet(pluginName ?? 'unknown')}
 
     ## Usage
-    Add it as a plugin in sanity.config.ts (or .js):
 
+    Add it as a plugin in \`sanity.config.ts\` (or .js):
+
+    \`\`\`ts
+    import {defineConfig} from 'sanity'
+    import {myPlugin} from '${pluginName}'
+
+    export default defineConfig({
+      //...
+      plugins: [myPlugin({})],
+    })
     \`\`\`
-     import {defineConfig} from 'sanity'
-     import {myPlugin} from '${pluginName}'
-
-     export const defineConfig({
-         //...
-         plugins: [
-             myPlugin({})
-         ]
-     })
-    \`\`\`
+
     ${getLicenseText(license?.id, user?.name ? (user as User) : undefined)}
     ${developTestSnippet()}
-  `
+  ` + '\n'
+  )
 }
 
 export function v3BannerNotice() {
@@ -41,8 +43,8 @@ export function installationSnippet(packageName: string) {
   return outdent`
     ## Installation
 
-    \`\`\`
-    npm install --save ${packageName}@studio-v3
+    \`\`\`sh
+    npm install ${packageName}
     \`\`\`
     `
 }

package/src/util/ts.ts

@@ -0,0 +1,13 @@
+import {loadTSConfig} from '@sanity/pkg-utils'
+import path from 'path'
+import {fileExists} from './files'
+
+export async function readTSConfig(options: {basePath: string; filename: string}) {
+  const {basePath, filename} = options
+  const filePath = path.resolve(basePath, filename)
+  const exists = await fileExists(filePath)
+
+  if (!exists) return undefined
+
+  return await loadTSConfig({cwd: basePath, tsconfigPath: filename})
+}

package/assets/inject/gitignore

@@ -1,57 +0,0 @@
-# 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

package/assets/inject/package.config.template

@@ -1,16 +0,0 @@
-import {defineConfig} from '@sanity/pkg-utils'
-
-export default defineConfig({
-  dist: 'lib',
-  minify: true,
-  legacyExports: true,
-  // Remove this block to enable strict export validation
-  extract: {
-    rules: {
-      'ae-forgotten-export': 'off',
-      'ae-incompatible-release-tags': 'off',
-      'ae-internal-missing-underscore': 'off',
-      'ae-missing-release-tag': 'off',
-    },
-  },
-})

package/assets/inject/template-tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "compilerOptions": {
-    "jsx": "preserve",
-    "moduleResolution": "node",
-    "target": "esnext",
-    "module": "esnext",
-    "esModuleInterop": true,
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "strict": true,
-    "sourceMap": false,
-    "inlineSourceMap": false,
-    "downlevelIteration": true,
-    "declaration": true,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "outDir": "lib",
-    "skipLibCheck": true,
-    "isolatedModules": true,
-    "checkJs": false,
-    "rootDir": "src"
-  },
-  "include": ["src/**/*"]
-}

package/lib/package.json

@@ -1,129 +0,0 @@
-{
-    "name": "@sanity/plugin-kit",
-    "version": "2.2.0",
-    "description": "Enhanced Sanity.io plugin development experience",
-    "keywords": [
-        "sanity-io",
-        "sanity",
-        "plugin",
-        "development",
-        "babel",
-        "typescript",
-        "bootstrap"
-    ],
-    "homepage": "https://github.com/sanity-io/plugin-kit#readme",
-    "bugs": {
-        "url": "https://github.com/sanity-io/plugin-kit/issues"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+ssh://git@github.com/sanity-io/plugin-kit.git"
-    },
-    "license": "MIT",
-    "author": "Sanity.io <hello@sanity.io>",
-    "main": "./lib/src/index.js",
-    "source": "./src/index.ts",
-    "types": "./lib/src/index.d.ts",
-    "bin": "lib/src/index.js",
-    "files": [
-        "v2-incompatible.js",
-        "src",
-        "lib",
-        "assets"
-    ],
-    "scripts": {
-        "prebuild": "npm run clean",
-        "build": "tsc",
-        "postbuild": "node executable-index.js",
-        "clean": "rimraf lib",
-        "commit": "git-cz",
-        "compile": "tsc --noEmit",
-        "format": "prettier src -w",
-        "lint": "eslint .",
-        "prepare": "husky install",
-        "prepublishOnly": "npm run build",
-        "test": "tap",
-        "watch": "tsc --watch"
-    },
-    "tap": {
-        "browser": false,
-        "check-coverage": false,
-        "coverage-report": [
-            "html"
-        ],
-        "jobs": 2,
-        "reporter": "spec",
-        "test-ignore": "^lib/.*|.*ignore.*|.*run-test-command.*|.*fixture.utils.*",
-        "timeout": 120,
-        "ts": true
-    },
-    "dependencies": {
-        "@rexxars/choosealicense-list": "^1.1.2",
-        "chalk": "^4.1.2",
-        "concurrently": "^7.5.0",
-        "discover-path": "^1.0.0",
-        "email-validator": "^2.0.4",
-        "execa": "^5.1.1",
-        "find-babel-config": "^1.2.0",
-        "get-it": "^7.0.2",
-        "get-latest-version": "^4.0.0",
-        "git-remote-origin-url": "^3.1.0",
-        "git-user-info": "^2.0.3",
-        "github-url-to-object": "^4.0.6",
-        "inquirer": "^8.2.5",
-        "meow": "^9.0.0",
-        "nodemon": "^2.0.20",
-        "npm-packlist": "^7.0.2",
-        "npm-run-path": "^4.0.1",
-        "outdent": "^0.8.0",
-        "p-any": "^3.0.0",
-        "p-props": "^4.0.0",
-        "postcss": "^8.4.19",
-        "rimraf": "^3.0.2",
-        "semver": "^7.3.8",
-        "spdx-license-ids": "^3.0.12",
-        "validate-npm-package-name": "^5.0.0",
-        "xdg-basedir": "^4.0.0",
-        "yalc": "^1.0.0-pre.53"
-    },
-    "devDependencies": {
-        "@commitlint/cli": "^17.2.0",
-        "@commitlint/config-conventional": "^17.2.0",
-        "@sanity/pkg-utils": "^1.20.1",
-        "@sanity/semantic-release-preset": "^2.0.2",
-        "@sanity/ui-workshop": "^1.0.1",
-        "@types/eslint": "^8.4.10",
-        "@types/fs-extra": "^9.0.13",
-        "@types/inquirer": "^9.0.3",
-        "@types/node": "^18.11.9",
-        "@types/nodemon": "^1.19.2",
-        "@types/tap": "^15.0.7",
-        "@typescript-eslint/eslint-plugin": "^5.43.0",
-        "@typescript-eslint/parser": "^5.43.0",
-        "eslint": "^8.27.0",
-        "eslint-config-prettier": "^8.5.0",
-        "eslint-config-sanity": "^6.0.0",
-        "eslint-plugin-prettier": "^4.2.1",
-        "eslint-plugin-react-hooks": "^4.6.0",
-        "fs-extra": "^10.1.0",
-        "husky": "^8.0.2",
-        "json5": "^2.2.1",
-        "lint-staged": "^13.0.3",
-        "prettier": "^2.7.1",
-        "prettier-plugin-packagejson": "^2.3.0",
-        "readdirp": "^3.6.0",
-        "rimraf": "^3.0.2",
-        "sanity": "^3.0.0",
-        "sinon": "^14.0.2",
-        "tap": "^16.3.1",
-        "ts-node": "^10.9.1",
-        "typescript": "^4.8.4"
-    },
-    "peerDependencies": {
-        "eslint": ">=8.0.0"
-    },
-    "engines": {
-        "node": ">=14"
-    },
-    "binname": "sanity-plugin"
-}

package/lib/src/actions/init.d.ts

@@ -1,73 +0,0 @@
-import { TypedFlags } from 'meow';
-export declare const initFlags: {
-    readonly scripts: {
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly eslint: {
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly typescript: {
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly prettier: {
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly license: {
-        readonly type: "string";
-    };
-    readonly editorconfig: {
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly gitignore: {
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly force: {
-        readonly type: "boolean";
-        readonly default: false;
-    };
-    readonly install: {
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly name: {
-        readonly type: "string";
-    };
-    readonly author: {
-        readonly type: "string";
-    };
-    readonly repo: {
-        readonly type: "string";
-    };
-    readonly presetOnly: {
-        readonly type: "boolean";
-        readonly default: false;
-    };
-    readonly preset: {
-        readonly type: "string";
-        readonly isMultiple: true;
-    };
-    readonly debug: {
-        readonly default: false;
-        readonly type: "boolean";
-    };
-    readonly silent: {
-        readonly type: "boolean";
-        readonly default: false;
-    };
-    readonly verbose: {
-        readonly type: "boolean";
-        readonly default: false;
-    };
-};
-export declare type InitFlags = TypedFlags<typeof initFlags>;
-export interface InitOptions {
-    basePath: string;
-    flags: InitFlags;
-}
-export declare function init(options: InitOptions): Promise<void>;