@sanity/cli-test 0.0.2-alpha.4 → 0.0.2-alpha.6

package/examples/worst-case-studio/src/descriptionInput.tsx

@@ -0,0 +1,55 @@
+import {useEffect, useState} from 'react'
+
+// Look ma, SVG imports in the config 🙈
+import iconPath from './descriptionIcon.svg'
+// Look ma, CSS module imports in the config 🙈
+import styles from './descriptionInput.module.css'
+
+// Look ma, process.env variables in the config 🙈
+if (process.env.SANITY_STUDIO_PREFIXED_VAR !== 'yes-this-is-prefixed') {
+  throw new Error('`process.env.SANITY_STUDIO_PREFIXED_VAR` is not set to `yes-this-is-prefixed`')
+}
+
+// Look ma, import.meta.env variables in the config 🙈
+if (import.meta.env.SANITY_STUDIO_PREFIXED_VAR !== 'yes-this-is-prefixed') {
+  throw new Error(
+    '`import.meta.env.SANITY_STUDIO_PREFIXED_VAR` is not set to `yes-this-is-prefixed`',
+  )
+}
+
+export default function DescriptionInput() {
+  const [counter, setCounter] = useState(0)
+  useEffect(() => {
+    const timer = setInterval(() => {
+      setCounter((prev) => prev + 1)
+    }, 1000)
+
+    return () => clearInterval(timer)
+  }, [])
+
+  return (
+    <div className={styles.input}>
+      <img src={iconPath} style={{width: '32px'}} />
+      Look ma, gradients, icons & counters
+      <div className={styles.counter}>{counter}</div>
+    </div>
+  )
+}
+
+const logCallback = requestIdleCallback(() => {
+  console.log('Look ma, requestIdleCallback in the config 🙈')
+})
+
+if (document.location.hostname === 'localhost') {
+  console.log('Look ma, `document` references in the config 🙈')
+}
+
+// Look ma, unchecked `window` references in the config 🙈
+window.addEventListener('beforeunload', () => {
+  cancelIdleCallback(logCallback)
+})
+
+// Look ma, this will just run forever 🙈
+setInterval(() => {
+  console.log('Look ma, setInterval in the config 🙈')
+}, 15_000)

package/examples/worst-case-studio/src/schemaTypes/author.ts

@@ -0,0 +1,52 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'author',
+  title: 'Author',
+  type: 'document',
+
+  fields: [
+    defineField({
+      name: 'name',
+      title: 'Name',
+      type: 'string',
+    }),
+    defineField({
+      name: 'slug',
+      options: {
+        maxLength: 96,
+        source: 'name',
+      },
+      title: 'Slug',
+      type: 'slug',
+    }),
+    defineField({
+      name: 'image',
+      options: {
+        hotspot: true,
+      },
+      title: 'Image',
+      type: 'image',
+    }),
+    defineField({
+      name: 'bio',
+      of: [
+        {
+          lists: [],
+          styles: [{title: 'Normal', value: 'normal'}],
+          title: 'Block',
+          type: 'block',
+        },
+      ],
+      title: 'Bio',
+      type: 'array',
+    }),
+  ],
+
+  preview: {
+    select: {
+      media: 'image',
+      title: 'name',
+    },
+  },
+})

package/examples/worst-case-studio/src/schemaTypes/blockContent.ts

@@ -0,0 +1,70 @@
+import {defineArrayMember, defineType} from 'sanity'
+
+/**
+ * This is the schema definition for the rich text fields used for
+ * for this blog studio. When you import it in schemas.js it can be
+ * reused in other parts of the studio with:
+ * ```ts
+ * {
+ *    name: 'someName',
+ *    title: 'Some title',
+ *    type: 'blockContent'
+ *  }
+ * ```
+ */
+export default defineType({
+  name: 'blockContent',
+  title: 'Block Content',
+  type: 'array',
+
+  of: [
+    defineArrayMember({
+      lists: [{title: 'Bullet', value: 'bullet'}],
+      // Marks let you mark up inline text in the block editor.
+      marks: {
+        // Annotations can be any object structure – e.g. a link or a footnote.
+        annotations: [
+          {
+            fields: [
+              {
+                name: 'href',
+                title: 'URL',
+                type: 'url',
+              },
+            ],
+            name: 'link',
+            title: 'URL',
+            type: 'object',
+          },
+        ],
+        // Decorators usually describe a single property – e.g. a typographic
+        // preference or highlighting by editors.
+        decorators: [
+          {title: 'Strong', value: 'strong'},
+          {title: 'Emphasis', value: 'em'},
+        ],
+      },
+      // Styles let you set what your user can mark up blocks with. These
+      // correspond with HTML tags, but you can set any title or value
+      // you want and decide how you want to deal with it where you want to
+      // use your content.
+      styles: [
+        {title: 'Normal', value: 'normal'},
+        {title: 'H1', value: 'h1'},
+        {title: 'H2', value: 'h2'},
+        {title: 'H3', value: 'h3'},
+        {title: 'H4', value: 'h4'},
+        {title: 'Quote', value: 'blockquote'},
+      ],
+      title: 'Block',
+      type: 'block',
+    }),
+    // You can add additional types here. Note that you can't use
+    // primitive types such as 'string' and 'number' in the same array
+    // as a block type.
+    defineArrayMember({
+      options: {hotspot: true},
+      type: 'image',
+    }),
+  ],
+})

package/examples/worst-case-studio/src/schemaTypes/category.ts

@@ -0,0 +1,20 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'category',
+  title: 'Category',
+  type: 'document',
+
+  fields: [
+    defineField({
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+    }),
+    defineField({
+      name: 'description',
+      title: 'Description',
+      type: 'text',
+    }),
+  ],
+})

package/examples/worst-case-studio/src/schemaTypes/index.ts

@@ -0,0 +1,6 @@
+import author from './author'
+import blockContent from './blockContent'
+import category from './category'
+import post from './post'
+
+export const schemaTypes = [post, author, category, blockContent]

package/examples/worst-case-studio/src/schemaTypes/post.ts

@@ -0,0 +1,71 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'post',
+  title: 'Post',
+  type: 'document',
+
+  fields: [
+    defineField({
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+    }),
+    defineField({
+      name: 'slug',
+      options: {
+        maxLength: 96,
+        source: 'title',
+      },
+      title: 'Slug',
+      type: 'slug',
+    }),
+    defineField({
+      name: 'author',
+      title: 'Author',
+      to: {type: 'author'},
+      type: 'reference',
+    }),
+    defineField({
+      name: 'mainImage',
+      options: {
+        hotspot: true,
+      },
+      title: 'Main image',
+      type: 'image',
+    }),
+    defineField({
+      name: 'code',
+      type: 'code',
+    }),
+    defineField({
+      name: 'categories',
+      of: [{to: {type: 'category'}, type: 'reference'}],
+      title: 'Categories',
+      type: 'array',
+    }),
+    defineField({
+      name: 'publishedAt',
+      title: 'Published at',
+      type: 'datetime',
+    }),
+    defineField({
+      name: 'body',
+      title: 'Body',
+      type: 'blockContent',
+    }),
+  ],
+
+  preview: {
+    select: {
+      author: 'author.name',
+      media: 'mainImage',
+      title: 'title',
+    },
+
+    prepare(selection) {
+      const {author} = selection
+      return {...selection, subtitle: author && `by ${author}`}
+    },
+  },
+})

package/examples/worst-case-studio/src/typings.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="vite/client" />
+
+interface ImportMetaEnv {
+  readonly SANITY_STUDIO_PREFIXED_VAR: string
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv
+}
+
+declare module 'https://themer.sanity.build/api/hues?*' {
+  interface Hue extends Omit<import('@sanity/color').ColorHueConfig, 'midPoint' | 'title'> {
+    midPoint: 50 | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900 | 950
+  }
+  interface Hues {
+    caution: Hue
+    critical: Hue
+    default: Hue
+    positive: Hue
+    primary: Hue
+    transparent: Hue
+  }
+  export const hues: Hues
+  type Theme = import('sanity').StudioTheme
+  export function createTheme(_hues: Hues): Theme
+  export const theme: Theme
+}
+
+declare module '*.module.css' {
+  const classes: {[key: string]: string}
+  export default classes
+}
+
+declare module '*.svg' {
+  const path: string
+  export default path
+}

package/examples/worst-case-studio/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "target": "ES2017",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "noEmit": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"],
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli-test",
-  "version": "0.0.2-alpha.4",
+  "version": "0.0.2-alpha.6",
   "description": "Sanity CLI test helpers and utilities",
   "keywords": [
     "sanity",
@@ -20,6 +20,7 @@
   },
   "license": "MIT",
   "author": "Sanity.io <hello@sanity.io>",
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
@@ -27,36 +28,47 @@
       "require": "./dist/index.js",
       "import": "./dist/index.js"
     },
+    "./vitest": {
+      "source": "./src/vitest.ts",
+      "require": "./dist/vitest.js",
+      "import": "./dist/vitest.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "./dist"
+    "./dist",
+    "./examples"
   ],
   "dependencies": {
-    "@oclif/core": "^4.8.0",
+    "@swc/core": "^1.15.8",
     "ansis": "^4.2.0",
-    "nock": "^14.0.10"
+    "esbuild": "^0.27.2",
+    "nock": "^14.0.10",
+    "ora": "^9.0.0",
+    "tinyglobby": "^0.2.15"
   },
   "devDependencies": {
-    "@eslint/compat": "^2.0.0",
+    "@eslint/compat": "^2.0.1",
     "@oclif/core": "^4.8.0",
-    "@sanity/client": "^7.3.0",
+    "@sanity/client": "^7.14.0",
     "@swc/cli": "^0.7.9",
-    "@swc/core": "^1.15.8",
-    "@types/debug": "^4.1.12",
-    "@types/node": "^20.19.27",
+    "@types/node": "^20.19.30",
     "eslint": "^9.39.2",
+    "publint": "^0.3.16",
     "typescript": "^5.9.3",
-    "vitest": "^3.2.4",
+    "vitest": "^4.0.17",
+    "yaml": "^2.8.2",
     "@repo/tsconfig": "3.70.0",
-    "@sanity/cli-core": "0.1.0-alpha.5",
-    "@sanity/eslint-config-cli": "0.0.0-alpha.1"
+    "@sanity/eslint-config-cli": "0.0.0-alpha.1",
+    "@sanity/cli-core": "0.1.0-alpha.7"
   },
   "peerDependencies": {
     "@oclif/core": "^4.0.0",
-    "@sanity/cli-core": "0.1.0-alpha.5"
+    "@sanity/client": "^7.14.0",
+    "vitest": ">=3.0.0 <4.0.0",
+    "@sanity/cli-core": "0.1.0-alpha.7"
   },
   "engines": {
     "node": ">=20.19.1 <22 || >=22.12"
@@ -65,10 +77,15 @@
     "access": "public"
   },
   "scripts": {
-    "build": "swc --delete-dir-on-start --strip-leading-paths --out-dir dist/ src",
+    "prebuild": "pnpm run clean",
+    "build": "pnpm run build:js && pnpm run copy:examples",
+    "build:js": "swc --delete-dir-on-start --strip-leading-paths --out-dir dist/ src",
     "build:types": "tsc --project tsconfig.lib.json",
     "check:types": "tsc --noEmit",
+    "clean": "rm -rf dist examples",
+    "copy:examples": "node scripts/copy-examples.js",
     "lint": "eslint .",
+    "publint": "publint",
     "test": "vitest run",
     "posttest": "pnpm run lint",
     "test:coverage": "vitest run --coverage",