@sanity/plugin-kit 2.2.0 → 3.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Sanity.io
+Copyright (c) 2023 Sanity.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,21 +1,28 @@
 # @sanity/plugin-kit
 
-> **NOTE**
->
-> This is a developer preview package meant for **Sanity Studio v3** plugin development.
->
-> For a v2 alternative, consider using [Sanipack](https://github.com/rexxars/sanipack).
-
 ## What is it?
 
-`@sanity/plugin-kit` is an opinionated, enhanced [Sanity.io](https://www.sanity.io/) v3 plugin development experience.
+`@sanity/plugin-kit` is an opinionated, enhanced [Sanity](https://www.sanity.io/) plugin development experience.
+
+It provides a set of CLI commands for initializing, verifying and testing a Sanity plugin for Sanity Studio.
+
+```sh
+# Initialize a new Sanity plugin project
+npx @sanity/plugin-kit init my-sanity-plugin
+```
 
-It provides a set of CLI commands for initializing, verifying and testing a Sanity plugin for Sanity Studio v3.
-The verify-package command can be used when upgrading V2 plugins to Studio V3 versions.
+```sh
+# Verify your plugin package.
+# This command can also be used when upgrading plugins from Sanity Studio v2 → v3.
+npx @sanity/plugin-kit verify-package
+```
 
-@sanity/plugin-kit also comes with a verify-studio command that can be used to recommend upgrade steps in existing Sanity Studio v2 studio.
+```sh
+# Get help upgrading from Sanity Studio v2 → v3.
+npx @sanity/plugin-kit verify-studio
+```
 
-This package assumes and recommends [@sanity/pkg-utils](https://github.com/sanity-io/pkg-utils#sanitypkg-utils) for building,
+`@sanity/plugin-kit` assumes and recommends [`@sanity/pkg-utils`](https://github.com/sanity-io/pkg-utils#sanitypkg-utils) for building,
 and [Yalc](https://github.com/wclr/yalc) with watch for testing the plugin in Sanity Studio.
 Check the [FAQ](#faq) fro more on these.
 
@@ -39,7 +46,7 @@ Check the [FAQ](#faq) fro more on these.
 
 ### Install build tool
 
-@sanity/plugin-kit assumes the plugin will use [@sanity/pkg-utils](https://github.com/sanity-io/pkg-utils#sanitypkg-utils) for build and watch:
+`@sanity/plugin-kit` assumes the plugin will use [@sanity/pkg-utils](https://github.com/sanity-io/pkg-utils#sanitypkg-utils) for build and watch:
 
 > npm install --save-dev @sanity/plugin-kit
 
@@ -57,7 +64,7 @@ npx @sanity/plugin-kit init sanity-plugin-testing-it-out
 cd sanity-plugin-testing-it-out
 npm run link-watch
 
-# In another shell 
+# In another shell
 cd /path/to/my-studio
 # now link the plugin to your Sanity studio using the command indicated by link-watch output (see below)
 ```
@@ -71,23 +78,21 @@ yalc add --link sanity-plugin-testing-it-out && yarn install
 ```
 
 ```bash
-# studio uses npm 
+# studio uses npm
 cd /path/to/my-studio
 npx yalc add sanity-plugin-testing-it-out && npx yalc link sanity-plugin-testing-it-out && npm install
 ```
 
-Now, configure the plugin in sanity.config.ts (or .js) in Sanity Studio:
+Now, configure the plugin in `sanity.config.ts` (or .js) in Sanity Studio:
 
 ```ts
-  import {defineConfig} from 'sanity'
-  import {myPlugin} from 'sanity-plugin-testing-it-out'
+import {defineConfig} from 'sanity'
+import {myPlugin} from 'sanity-plugin-testing-it-out'
 
-  export const defineConfig({
-      //...
-      plugins: [
-          myPlugin({})
-      ]
-  })
+export default defineConfig({
+  //...
+  plugins: [myPlugin({})],
+})
 ```
 
 Start the Sanity Studio development server:
@@ -129,7 +134,7 @@ Verify that the plugin package is configured correctly by running:
 - Check for sanity imports that has changed in v3, using eslint
 - Check tsconfig.json settings
 - Check for [SPDX](https://spdx.org/licenses/) compatible license definition
-- If the package uses TypeScript, this will also run `tsc --noEmit` when all other checks have passed
+- If the package uses TypeScript, this will also run `tsc --build` when all other checks have passed
 
 Each check will explain why it is needed, steps to fix it and how it can be individually disabled.
 
@@ -179,13 +184,15 @@ This will only output the first validation that fails. Useful when working throu
 ## Inject config into existing package
 
 ```
-npx @sanity/plugin-kit inject 
+npx @sanity/plugin-kit inject
 ```
+
 will inject recommended V3 plugin package boilerplate into an existing plugin.
 Be sure to commit any local changes before running this command, so you can easily revert anything
 you dont want.
 
 Consult the inject command CLI help:
+
 ```
 npx @sanity/plugin-kit inject --help
 ```
@@ -196,9 +203,10 @@ for up-to-date specifics.
 
 The inject command can do more work by adding presets. Consult the individual preset docs for details:
 
-* [semver-workflow](./docs/semver-workflow.md) - Add an opinionated Github workflow to automate NPM releases
-* [renovatebot](./docs/renovatebot.md) - Add opinionated Renovatebot config to make dependency management a breeze
-* [ui-workshop](./docs/ui-workshop.md) - Add  [@sanity/ui-workshop](https://github.com/sanity-io/ui-workshop) to make component testing a breeze
+- [semver-workflow](./docs/semver-workflow.md) - Add an opinionated Github workflow to automate NPM releases
+- [renovatebot](./docs/renovatebot.md) - Add opinionated Renovatebot config to make dependency management a breeze
+- [ui](./docs/ui.md) - Add [@sanity/ui](https://github.com/sanity-io/ui) to build plugin UIs.
+- [ui-workshop](./docs/ui-workshop.md) - Add [@sanity/ui-workshop](https://github.com/sanity-io/ui-workshop) to make component testing a breeze
 
 ## Testing a plugin in Sanity Studio
 
@@ -251,16 +259,14 @@ This command can be configured using `sanityPlugin.linkWatch` in package.json:
 
 ```json5
 {
-  "sanityPlugin": {
-    "linkWatch": {
-      // directory to watch
-      "folder": "lib",
+  sanityPlugin: {
+    linkWatch: {
       // command to run when content in linkWatch.folder changes
-      "command": "npm run watch",
+      command: 'npm run watch',
       // file extensions to watch for changes in the linkWatch.folder
-      "extensions": "js,png,svg,gif,jpeg,css"
-    }
-  }
+      extensions: 'js,png,svg,gif,jpeg,css',
+    },
+  },
 }
 ```
 
@@ -365,6 +371,16 @@ Your plugin may have other needs.
 You are also free to not use @sanity/pkg-utils at all; simply change your package.json build script, and disable any verification-steps
 you don't care for with `sanityPlugin.verifyPackage`.
 
+#### Q: Why multiple `tsconfig*.json` files?
+
+After running `plugin-kit init` you will get these tsconfig files:
+
+- `tsconfig.json` used by the IDE (this typically includes test files)
+- `tsconfig.dist.json` used by the build system, and ignores test files
+- `tsconfig.settings.json` with shared settings between tsconfig.json and tsconfig.dist.json
+
+This configuration allows for type-checking you scripts and tests, and not only the distribution files. When building the scripts and test files will not be included in the npm package distribution.
+
 ## CLI Help
 
 ```sh
@@ -377,7 +393,7 @@ Usage
 
     init            Create a new Sanity plugin
     verify-package  Verify that a Sanity plugin follows plugin-kit conventions
-    inject          Inject plugin-kit complatible package config into an existing plugin directory
+    inject          Inject plugin-kit compatible package config into an existing plugin directory
     link-watch      Recompile plugin automatically on changes and push to yalc
     version         Show the version of ${cliName} currently installed
 
@@ -404,7 +420,6 @@ Provide a sanityPlugin config in package.json (defaults shown):
 {
   "sanityPlugin": {
     "linkWatch": {
-      "folder": "lib",
       "command": "npm run watch",
       "extensions": "js,png,svg,gif,jpeg,css"
     }

package/assets/inject/semver-workflow/lint-staged.template.js

@@ -1,4 +1,4 @@
 module.exports = {
   '**/*.{js,jsx}': ['eslint'],
-  '**/*.{ts,tsx}': ['eslint', () => 'tsc --noEmit'],
+  '**/*.{ts,tsx}': ['eslint', () => 'tsc --build'],
 }

package/bin/plugin-kit.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../dist/cli').cliEntry()

package/dist/_chunks/cli-dbe00b65.js

@@ -0,0 +1,162 @@
+'use strict';
+
+var meow = require('meow');
+var chalk = require('chalk');
+function _interopDefaultCompat(e) {
+  return e && typeof e === 'object' && 'default' in e ? e : {
+    default: e
+  };
+}
+var meow__default = /*#__PURE__*/_interopDefaultCompat(meow);
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+let beQuiet = false;
+let beVerbose = false;
+function setVerbosity(_ref) {
+  let {
+    verbose,
+    silent
+  } = _ref;
+  if (silent) {
+    beVerbose = false;
+    beQuiet = true;
+  } else if (verbose) {
+    beVerbose = true;
+    beQuiet = false;
+  }
+}
+var log = {
+  setVerbosity,
+  msg: function (msg) {
+    for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+      args[_key - 1] = arguments[_key];
+    }
+    return !beQuiet && console.log(msg, ...args);
+  },
+  debug: function (msg) {
+    for (var _len2 = arguments.length, args = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
+      args[_key2 - 1] = arguments[_key2];
+    }
+    return !beQuiet && beVerbose && console.debug("".concat(chalk__default.default.bgBlack.white("[debug]"), " ").concat(msg), ...args);
+  },
+  success: function (msg) {
+    for (var _len3 = arguments.length, args = new Array(_len3 > 1 ? _len3 - 1 : 0), _key3 = 1; _key3 < _len3; _key3++) {
+      args[_key3 - 1] = arguments[_key3];
+    }
+    return !beQuiet && console.info("".concat(chalk__default.default.bgBlack.greenBright("[success]"), " ").concat(msg), ...args);
+  },
+  info: function (msg) {
+    for (var _len4 = arguments.length, args = new Array(_len4 > 1 ? _len4 - 1 : 0), _key4 = 1; _key4 < _len4; _key4++) {
+      args[_key4 - 1] = arguments[_key4];
+    }
+    return !beQuiet && console.info("".concat(chalk__default.default.bgBlack.cyanBright("[info]"), " ").concat(msg), ...args);
+  },
+  warn: function (msg) {
+    for (var _len5 = arguments.length, args = new Array(_len5 > 1 ? _len5 - 1 : 0), _key5 = 1; _key5 < _len5; _key5++) {
+      args[_key5 - 1] = arguments[_key5];
+    }
+    return !beQuiet && console.warn("".concat(chalk__default.default.bgBlack.yellowBright("[warn]"), " ").concat(msg), ...args);
+  },
+  error: function (msg) {
+    for (var _len6 = arguments.length, args = new Array(_len6 > 1 ? _len6 - 1 : 0), _key6 = 1; _key6 < _len6; _key6++) {
+      args[_key6 - 1] = arguments[_key6];
+    }
+    return console.error("".concat(chalk__default.default.bgBlack.redBright("[error]"), " ").concat(msg), ...args);
+  }
+};
+var commands = {
+  init: async options => {
+    await (await Promise.resolve().then(function () {
+      return require('./init-2a3b4528.js');
+    })).default(options);
+  },
+  inject: async options => {
+    await (await Promise.resolve().then(function () {
+      return require('./inject-f8928379.js');
+    })).default(options);
+  },
+  "link-watch": async options => {
+    await (await Promise.resolve().then(function () {
+      return require('./link-watch-9e3f1174.js');
+    })).default(options);
+  },
+  "verify-package": async options => {
+    await (await Promise.resolve().then(function () {
+      return require('./verify-package-73b843df.js');
+    })).default(options);
+  },
+  "verify-studio": async options => {
+    await (await Promise.resolve().then(function () {
+      return require('./verify-studio-5e333969.js');
+    })).default(options);
+  },
+  version: async options => {
+    await (await Promise.resolve().then(function () {
+      return require('./version-f89917d7.js');
+    })).default(options);
+  }
+};
+var sharedFlags = {
+  debug: {
+    default: false,
+    type: "boolean"
+  },
+  silent: {
+    type: "boolean",
+    default: false
+  },
+  verbose: {
+    type: "boolean",
+    default: false
+  }
+};
+const cliName = "@sanity/plugin-kit";
+const urls = {
+  refDocs: "https://beta.sanity.io/docs/reference",
+  migrationGuideStudio: "https://beta.sanity.io/docs/platform/v2-to-v3",
+  migrationGuidePlugin: "https://beta.sanity.io/docs/platform/v2-to-v3/plugins",
+  pluginReadme: "https://github.com/sanity-io/plugin-kit",
+  incompatiblePlugin: "https://github.com/sanity-io/incompatible-plugin",
+  sanityExchange: "https://www.sanity.io/exchange",
+  linterPackage: "https://github.com/sanity-io/eslint-config-no-v2-imports"
+};
+const incompatiblePluginPackage = "@sanity/incompatible-plugin";
+const defaultOutDir = "dist";
+async function cliEntry() {
+  let argv = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : process.argv;
+  let autoExit = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+  const cli = meow__default.default("\n\tUsage\n\t  $ ".concat(cliName, " [--help] [--debug] <command> [<args>]\n\n  These are common commands used in various situations:\n\n    init            Create a new Sanity plugin\n    inject          Inject config into an existing Sanity v3 plugin\n    verify-package  Check that a Sanity plugin package follows V3 conventions. Prints upgrade steps.\n    verify-studio   Check that a Sanity Studio follows V3 conventions. Prints upgrade steps.\n    link-watch      Recompiles plugin automatically on changes and runs yalc push --publish\n    version         Show the version of ").concat(cliName, " currently installed\n\n  Options\n    --silent        Do not print info and warning messages\n    --verbose       Log everything. This option conflicts with --silent\n    --debug         Print stack trace on errors\n    --version       Output the version number\n    --help          Output usage information\n\n  Examples\n    # Init a new plugin in current directory\n    $ ").concat(cliName, " init\n\n    # Init a new plugin in my-sanity-plugin directory\n    $ ").concat(cliName, " init my-sanity-plugin\n\n    # Check that a Sanity plugin package in current directory follows V3 conventions\n    $ ").concat(cliName, " verify-package\n\n    # Check that a Sanity Studio in current directory  follows V3 conventions\n    $ ").concat(cliName, " verify-studio\n"), {
+    autoHelp: false,
+    flags: sharedFlags,
+    argv: argv.slice(2)
+  });
+  const commandName = cli.input[0];
+  if (!commandName) {
+    cli.showHelp();
+  }
+  if (!(commandName in commands)) {
+    console.error("Unknown command \"".concat(commandName, "\""));
+    cli.showHelp();
+  }
+  if (cli.flags.silent && cli.flags.verbose) {
+    log.error("--silent and --verbose are mutually exclusive");
+    cli.showHelp();
+  }
+  const cmd = commands[commandName];
+  try {
+    log.setVerbosity(cli.flags);
+    await cmd({
+      argv: argv.slice(3)
+    });
+  } catch (err) {
+    log.error(err instanceof TypeError || cli.flags.debug ? err.stack : err.message);
+    process.exit(1);
+  }
+}
+exports.cliEntry = cliEntry;
+exports.cliName = cliName;
+exports.defaultOutDir = defaultOutDir;
+exports.incompatiblePluginPackage = incompatiblePluginPackage;
+exports.log = log;
+exports.sharedFlags = sharedFlags;
+exports.urls = urls;
+//# sourceMappingURL=cli-dbe00b65.js.map

package/dist/_chunks/cli-dbe00b65.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-dbe00b65.js","sources":["../../src/util/log.ts","../../src/cmds/index.ts","../../src/sharedFlags.ts","../../src/constants.ts","../../src/cli.ts"],"sourcesContent":["// Note: This is _specifically_ meant for CLI usage,\n// I realize that \"singletons\" are bad.\n\nimport chalk from 'chalk'\n\nlet beQuiet = false\nlet beVerbose = false\n\nfunction setVerbosity({verbose, silent}: {verbose: boolean; silent: boolean}) {\n  if (silent) {\n    beVerbose = false\n    beQuiet = true\n  } else if (verbose) {\n    beVerbose = true\n    beQuiet = false\n  }\n}\n\nexport default {\n  setVerbosity: setVerbosity,\n\n  // Bypasses any checks, prints regardless (only use for things like `cli --version`)\n  msg: (msg: any, ...args: any[]) => !beQuiet && console.log(msg, ...args),\n\n  // Debug only printed on --verbose\n  debug: (msg: any, ...args: any[]) =>\n    !beQuiet && beVerbose && console.debug(`${chalk.bgBlack.white('[debug]')} ${msg}`, ...args),\n\n  // Success messages only printed if not --silent\n  success: (msg: any, ...args: any[]) =>\n    !beQuiet && console.info(`${chalk.bgBlack.greenBright('[success]')} ${msg}`, ...args),\n\n  // Info only printed if not --silent (\"standard\" level)\n  info: (msg: any, ...args: any[]) =>\n    !beQuiet && console.info(`${chalk.bgBlack.cyanBright('[info]')} ${msg}`, ...args),\n\n  // Warning only printed if not --silent\n  warn: (msg: any, ...args: any[]) =>\n    !beQuiet && console.warn(`${chalk.bgBlack.yellowBright('[warn]')} ${msg}`, ...args),\n\n  // Errors are always printed\n  error: (msg: any, ...args: any[]) =>\n    console.error(`${chalk.bgBlack.redBright('[error]')} ${msg}`, ...args),\n}\n","export default {\n  init: async (options: {argv: string[]}) => {\n    await (await import('./init')).default(options)\n  },\n  inject: async (options: {argv: string[]}) => {\n    await (await import('./inject')).default(options)\n  },\n  'link-watch': async (options: {argv: string[]}) => {\n    await (await import('./link-watch')).default(options)\n  },\n  'verify-package': async (options: {argv: string[]}) => {\n    await (await import('./verify-package')).default(options)\n  },\n  'verify-studio': async (options: {argv: string[]}) => {\n    await (await import('./verify-studio')).default(options)\n  },\n  version: async (options: {argv: string[]}) => {\n    await (await import('./version')).default(options)\n  },\n}\n","export default {\n  debug: {\n    default: false,\n    type: 'boolean',\n  },\n  silent: {\n    type: 'boolean',\n    default: false,\n  },\n  verbose: {\n    type: 'boolean',\n    default: false,\n  },\n} as const\n","export const cliName = '@sanity/plugin-kit'\n\nexport const urls = {\n  refDocs: 'https://beta.sanity.io/docs/reference',\n  migrationGuideStudio: 'https://beta.sanity.io/docs/platform/v2-to-v3',\n  migrationGuidePlugin: 'https://beta.sanity.io/docs/platform/v2-to-v3/plugins',\n  pluginReadme: 'https://github.com/sanity-io/plugin-kit',\n  incompatiblePlugin: 'https://github.com/sanity-io/incompatible-plugin',\n  sanityExchange: 'https://www.sanity.io/exchange',\n  linterPackage: 'https://github.com/sanity-io/eslint-config-no-v2-imports',\n}\n\nexport const incompatiblePluginPackage = '@sanity/incompatible-plugin'\n\nexport const defaultOutDir = 'dist'\n","import meow from 'meow'\nimport log from './util/log'\nimport commands from './cmds'\nimport sharedFlags from './sharedFlags'\nimport {cliName} from './constants'\n\nexport async function cliEntry(argv = process.argv, autoExit = true) {\n  const cli = meow(\n    `\n\tUsage\n\t  $ ${cliName} [--help] [--debug] <command> [<args>]\n\n  These are common commands used in various situations:\n\n    init            Create a new Sanity plugin\n    inject          Inject config into an existing Sanity v3 plugin\n    verify-package  Check that a Sanity plugin package follows V3 conventions. Prints upgrade steps.\n    verify-studio   Check that a Sanity Studio follows V3 conventions. Prints upgrade steps.\n    link-watch      Recompiles plugin automatically on changes and runs yalc push --publish\n    version         Show the version of ${cliName} currently installed\n\n  Options\n    --silent        Do not print info and warning messages\n    --verbose       Log everything. This option conflicts with --silent\n    --debug         Print stack trace on errors\n    --version       Output the version number\n    --help          Output usage information\n\n  Examples\n    # Init a new plugin in current directory\n    $ ${cliName} init\n\n    # Init a new plugin in my-sanity-plugin directory\n    $ ${cliName} init my-sanity-plugin\n\n    # Check that a Sanity plugin package in current directory follows V3 conventions\n    $ ${cliName} verify-package\n\n    # Check that a Sanity Studio in current directory  follows V3 conventions\n    $ ${cliName} verify-studio\n`,\n    {\n      autoHelp: false,\n      flags: sharedFlags,\n      argv: argv.slice(2),\n    }\n  )\n\n  const commandName = cli.input[0]\n  if (!commandName) {\n    cli.showHelp() // Exits\n  }\n\n  if (!(commandName in commands)) {\n    console.error(`Unknown command \"${commandName}\"`)\n    cli.showHelp() // Exits\n  }\n\n  if (cli.flags.silent && cli.flags.verbose) {\n    log.error(`--silent and --verbose are mutually exclusive`)\n    cli.showHelp() // Exits\n  }\n\n  // Lazy-load command\n  const cmd = commands[commandName as keyof typeof commands]\n\n  try {\n    log.setVerbosity(cli.flags)\n    await cmd({argv: argv.slice(3)})\n  } catch (err: any) {\n    log.error(err instanceof TypeError || cli.flags.debug ? err.stack : err.message)\n\n    // eslint-disable-next-line no-process-exit\n    process.exit(1)\n  }\n}\n"],"names":["beQuiet","beVerbose","setVerbosity","verbose","silent","log","msg","args","console","debug","chalk","bgBlack","white","success","info","default","greenBright","cyanBright","warn","yellowBright","error","redBright","commands","init","options","Promise","resolve","then","require","inject","version","sharedFlags","type","cliName","urls","refDocs","migrationGuideStudio","migrationGuidePlugin","pluginReadme","incompatiblePlugin","sanityExchange","linterPackage","incompatiblePluginPackage","defaultOutDir","cliEntry","argv","process","autoExit","cli","meow","autoHelp","flags","slice","commandName","input","showHelp","cmd","err","TypeError","stack","message","exit"],"mappings":";;;;;;;;;;;AAKA,IAAIA,OAAU,GAAA,KAAA;AACd,IAAIC,SAAY,GAAA,KAAA;AAEhB,SAASC,YAAa,OAAwD;EAAA,IAAxD;IAACC,OAAS;IAAAC;GAA8C;EAC5E,IAAIA,MAAQ,EAAA;IACEH,SAAA,GAAA,KAAA;IACFD,OAAA,GAAA,IAAA;aACDG,OAAS,EAAA;IACNF,SAAA,GAAA,IAAA;IACFD,OAAA,GAAA,KAAA;EACZ;AACF;AAEA,IAAeK,GAAA,GAAA;EACbH,YAAA;EAGAI,GAAA,EAAK,UAACA,GAAA;IAAA,kCAAaC,IAAgB;MAAhBA,IAAgB;IAAA;IAAA,OAAA,CAACP,WAAWQ,OAAQ,CAAAH,GAAA,CAAIC,GAAK,EAAA,GAAGC,IAAI,CAAA;EAAA;EAGvEE,OAAO,UAACH,GAAA;IAAA,mCAAaC,IACnB;MADmBA,IACnB;IAAA;IAAA,OAAA,CAACP,WAAWC,SAAa,IAAAO,OAAA,CAAQC,KAAM,WAAGC,cAAAA,CAAAA,QAAMC,OAAQ,CAAAC,KAAA,CAAM,SAAS,CAAK,cAAAN,GAAA,GAAO,GAAGC,IAAI,CAAA;EAAA;EAG5FM,SAAS,UAACP,GAAA;IAAA,mCAAaC,IACrB;MADqBA,IACrB;IAAA;IAAA,OAAA,CAACP,WAAWQ,OAAQ,CAAAM,IAAA,WAAQJ,cAAA,CAAAK,OAAA,CAAMJ,QAAQK,WAAY,CAAA,WAAW,CAAK,cAAAV,GAAA,GAAO,GAAGC,IAAI,CAAA;EAAA;EAGtFO,MAAM,UAACR,GAAA;IAAA,mCAAaC,IAClB;MADkBA,IAClB;IAAA;IAAA,OAAA,CAACP,WAAWQ,OAAQ,CAAAM,IAAA,WAAQJ,cAAA,CAAAK,OAAA,CAAMJ,QAAQM,UAAW,CAAA,QAAQ,CAAK,cAAAX,GAAA,GAAO,GAAGC,IAAI,CAAA;EAAA;EAGlFW,MAAM,UAACZ,GAAA;IAAA,mCAAaC,IAClB;MADkBA,IAClB;IAAA;IAAA,OAAA,CAACP,WAAWQ,OAAQ,CAAAU,IAAA,WAAQR,cAAA,CAAAK,OAAA,CAAMJ,QAAQQ,YAAa,CAAA,QAAQ,CAAK,cAAAb,GAAA,GAAO,GAAGC,IAAI,CAAA;EAAA;EAGpFa,KAAO,EAAA,UAACd,GAAa;IAAA,mCAAAC,IAAA;MAAAA,IAAA;IAAA;IAAA,OACnBC,QAAQY,KAAM,WAAGV,cAAAA,CAAAA,OAAM,CAAAC,OAAA,CAAQU,SAAU,CAAA,SAAS,CAAK,cAAAf,GAAA,GAAO,GAAGC,IAAI,CAAA;EAAA;AACzE,CAAA;AC3CA,IAAee,QAAA,GAAA;EACbC,IAAA,EAAM,MAAOC,OAA8B,IAAA;IACzC,MAAA,CAAO,MAAMC,OAAO,CAAAC,OAAA,EAAA,CAAAC,IAAA,CAAA,YAAA;MAAA,OAAAC,OAAA,CAAA,oBAAW,CAAA;IAAA,CAAA,CAAA,EAAAb,OAAA,CAAQS,OAAO,CAAA;EAChD,CAAA;EACAK,MAAA,EAAQ,MAAOL,OAA8B,IAAA;IAC3C,MAAA,CAAO,MAAMC,OAAO,CAAAC,OAAA,EAAA,CAAAC,IAAA,CAAA,YAAA;MAAA,OAAAC,OAAA,CAAA,sBAAa,CAAA;IAAA,CAAA,CAAA,EAAAb,OAAA,CAAQS,OAAO,CAAA;EAClD,CAAA;EACA,YAAA,EAAc,MAAOA,OAA8B,IAAA;IACjD,MAAA,CAAO,MAAMC,OAAO,CAAAC,OAAA,EAAA,CAAAC,IAAA,CAAA,YAAA;MAAA,OAAAC,OAAA,CAAA,0BAAiB,CAAA;IAAA,CAAA,CAAA,EAAAb,OAAA,CAAQS,OAAO,CAAA;EACtD,CAAA;EACA,gBAAA,EAAkB,MAAOA,OAA8B,IAAA;IACrD,MAAA,CAAO,MAAMC,OAAO,CAAAC,OAAA,EAAA,CAAAC,IAAA,CAAA,YAAA;MAAA,OAAAC,OAAA,CAAA,8BAAqB,CAAA;IAAA,CAAA,CAAA,EAAAb,OAAA,CAAQS,OAAO,CAAA;EAC1D,CAAA;EACA,eAAA,EAAiB,MAAOA,OAA8B,IAAA;IACpD,MAAA,CAAO,MAAMC,OAAO,CAAAC,OAAA,EAAA,CAAAC,IAAA,CAAA,YAAA;MAAA,OAAAC,OAAA,CAAA,6BAAoB,CAAA;IAAA,CAAA,CAAA,EAAAb,OAAA,CAAQS,OAAO,CAAA;EACzD,CAAA;EACAM,OAAA,EAAS,MAAON,OAA8B,IAAA;IAC5C,MAAA,CAAO,MAAMC,OAAO,CAAAC,OAAA,EAAA,CAAAC,IAAA,CAAA,YAAA;MAAA,OAAAC,OAAA,CAAA,uBAAc,CAAA;IAAA,CAAA,CAAA,EAAAb,OAAA,CAAQS,OAAO,CAAA;EACnD;AACF,CAAA;ACnBA,IAAeO,WAAA,GAAA;EACbtB,KAAO,EAAA;IACLM,OAAS,EAAA,KAAA;IACTiB,IAAM,EAAA;EACR,CAAA;EACA5B,MAAQ,EAAA;IACN4B,IAAM,EAAA,SAAA;IACNjB,OAAS,EAAA;EACX,CAAA;EACAZ,OAAS,EAAA;IACP6B,IAAM,EAAA,SAAA;IACNjB,OAAS,EAAA;EACX;AACF,CAAA;ACbO,MAAMkB,OAAU,GAAA,oBAAA;AAEhB,MAAMC,IAAO,GAAA;EAClBC,OAAS,EAAA,uCAAA;EACTC,oBAAsB,EAAA,+CAAA;EACtBC,oBAAsB,EAAA,uDAAA;EACtBC,YAAc,EAAA,yCAAA;EACdC,kBAAoB,EAAA,kDAAA;EACpBC,cAAgB,EAAA,gCAAA;EAChBC,aAAe,EAAA;AACjB,CAAA;AAEO,MAAMC,yBAA4B,GAAA,6BAAA;AAElC,MAAMC,aAAgB,GAAA,MAAA;ACR7B,eAAsBC,QAAS,GAAsC;EAAA,IAAtCC,IAAA,uEAAOC,OAAQ,CAAAD,IAAA;EAAA,IAAME,+EAAW,IAAM;EACnE,MAAMC,GAAM,GAAAC,aAAA,CAAAlC,OAAA,4BAGPkB,OAAA,gjBASmCA,OAAA,qYAWlCA,OAAA,mFAGAA,OAAA,mIAGAA,OAAA,qHAGAA,OAAA,uBAEJ;IACEiB,QAAU,EAAA,KAAA;IACVC,KAAO,EAAApB,WAAA;IACPc,IAAA,EAAMA,IAAK,CAAAO,KAAA,CAAM,CAAC;EACpB,CAAA,CACF;EAEM,MAAAC,WAAA,GAAcL,IAAIM,KAAM,CAAA,CAAA,CAAA;EAC9B,IAAI,CAACD,WAAa,EAAA;IAChBL,GAAA,CAAIO,QAAS,EAAA;EACf;EAEI,IAAA,EAAEF,eAAe/B,QAAW,CAAA,EAAA;IACtBd,OAAA,CAAAY,KAAA,6BAA0BiC,WAAc,QAAA;IAChDL,GAAA,CAAIO,QAAS,EAAA;EACf;EAEA,IAAIP,GAAI,CAAAG,KAAA,CAAM/C,MAAU,IAAA4C,GAAA,CAAIG,MAAMhD,OAAS,EAAA;IACzCE,GAAA,CAAIe,sDAAqD;IACzD4B,GAAA,CAAIO,QAAS,EAAA;EACf;EAGA,MAAMC,MAAMlC,QAAS,CAAA+B,WAAA,CAAA;EAEjB,IAAA;IACEhD,GAAA,CAAAH,YAAA,CAAa8C,IAAIG,KAAK,CAAA;IAC1B,MAAMK,IAAI;MAACX,IAAA,EAAMA,KAAKO,KAAM,CAAA,CAAC;KAAE,CAAA;WACxBK,GAAP,EAAA;IACIpD,GAAA,CAAAe,KAAA,CAAMqC,eAAeC,SAAa,IAAAV,GAAA,CAAIG,MAAM1C,KAAQ,GAAAgD,GAAA,CAAIE,KAAQ,GAAAF,GAAA,CAAIG,OAAO,CAAA;IAG/Ed,OAAA,CAAQe,KAAK,CAAC,CAAA;EAChB;AACF;;;;;;;"}

package/dist/_chunks/init-2a3b4528.js

@@ -0,0 +1,104 @@
+'use strict';
+
+var path = require('path');
+var meow = require('meow');
+var cli = require('./cli-dbe00b65.js');
+var init = require('./init-7cd30f64.js');
+var _package = require('./package-bdb22a22.js');
+var execa = require('execa');
+function _interopDefaultCompat(e) {
+  return e && typeof e === 'object' && 'default' in e ? e : {
+    default: e
+  };
+}
+var path__default = /*#__PURE__*/_interopDefaultCompat(path);
+var meow__default = /*#__PURE__*/_interopDefaultCompat(meow);
+var execa__default = /*#__PURE__*/_interopDefaultCompat(execa);
+function npmIsAvailable() {
+  return execa__default.default("npm", ["-v"]).then(() => true).catch(() => false);
+}
+function yarnIsAvailable() {
+  return execa__default.default("yarn", ["-v"]).then(() => true).catch(() => false);
+}
+function pnpmAvailable() {
+  return execa__default.default("pnpm", ["-v"]).then(() => true).catch(() => false);
+}
+async function promptForPackageManager() {
+  const [npm, yarn, pnpm] = await Promise.all([npmIsAvailable(), yarnIsAvailable(), pnpmAvailable()]);
+  const choices = [npm && "npm", yarn && "yarn", pnpm && "pnpm"].filter(Boolean);
+  if (choices.length < 2) {
+    return choices[0] || "npm";
+  }
+  return _package.prompt("Which package manager do you prefer?", {
+    choices: choices.map(value => ({
+      value,
+      name: value
+    })),
+    default: choices[0]
+  });
+}
+async function installDependencies(pm, _ref) {
+  let {
+    cwd
+  } = _ref;
+  const proc = execa__default.default(pm, ["install"], {
+    cwd,
+    stdio: "inherit"
+  });
+  const {
+    exitCode
+  } = await proc;
+  return exitCode <= 0;
+}
+const description = "Initialize a new Sanity plugin";
+const help = "\nUsage\n  $ ".concat(cli.cliName, " init [dir] [<args>]\n\nOptions\n  --no-eslint             Disables ESLint config and dependencies from being added\n  --no-prettier           Disables prettier config and dependencies from being added\n  --no-typescript         Disables typescript config and dependencies from being added\n  --no-license            Disables LICENSE + package.json license field from being added\n  --no-editorconfig       Disables .editorconfig from being added\n  --no-gitignore          Disables .gitignore from being added\n  --no-scripts            Disables scripts from being added to package.json\n  --no-install            Disables automatically running package manager install\n\n  --name [package-name]   Use the provided package-name\n  --author [name]         Use the provided author\n  --repo [url]            Use the provided repo url\n  --license [spdx]        Use the license with the given SPDX identifier\n  --force                 No promt when overwriting files\n\n  --preset [preset-name]  Adds config and files from a named preset. --preset can be supplied multiple times.\n                          The following presets are available:\n").concat(init.presetHelpList(30), "\n\nExamples\n  # Initialize a new plugin in the current directory\n  $ ").concat(cli.cliName, " init\n\n  # Initialize a plugin in the directory ~/my-plugin\n  $ ").concat(cli.cliName, " init ~/my-plugin\n\n  # Don't add eslint or prettier\n  $ ").concat(cli.cliName, " init --no-eslint --no-prettier\n");
+async function run(_ref2) {
+  let {
+    argv
+  } = _ref2;
+  const cli$1 = meow__default.default(help, {
+    flags: init.initFlags,
+    argv,
+    description
+  });
+  const basePath = path__default.default.resolve(cli$1.input[0] || process.cwd());
+  const {
+    exists,
+    isRoot
+  } = await _package.hasSanityJson(basePath);
+  if (exists && isRoot) {
+    throw new Error("sanity.json has a \"root\" property set to true - are you trying to init into a studio instead of a plugin?");
+  }
+  const {
+    v3ConfigFile
+  } = await _package.findStudioV3Config(basePath);
+  if (v3ConfigFile) {
+    throw new Error("".concat(v3ConfigFile, " exsists - are you trying to init into a studio instead of a plugin?"));
+  }
+  cli.log.info('Initializing new plugin in "%s"', basePath);
+  if (!cli$1.flags.force && !(await _package.isEmptyish(basePath)) && !(await _package.prompt("Directory is not empty, proceed?", {
+    type: "confirm",
+    default: false
+  }))) {
+    cli.log.error("Directory is not empty. Cancelled.");
+    return;
+  }
+  await _package.ensureDir(basePath);
+  await init.init({
+    basePath,
+    flags: cli$1.flags
+  });
+  if (cli$1.flags.install) {
+    if (await installDependencies(await promptForPackageManager(), {
+      cwd: basePath
+    })) {
+      cli.log.info("Done!");
+    } else {
+      cli.log.error("Failed to install dependencies, try manually running `npm install`");
+    }
+  } else {
+    cli.log.info("Dependency installation skipped.");
+  }
+}
+exports.default = run;
+//# sourceMappingURL=init-2a3b4528.js.map

package/dist/_chunks/init-2a3b4528.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init-2a3b4528.js","sources":["../../src/npm/manager.ts","../../src/cmds/init.ts"],"sourcesContent":["import execa from 'execa'\nimport {prompt} from '../util/prompt'\n\nexport function npmIsAvailable() {\n  return execa('npm', ['-v'])\n    .then(() => true)\n    .catch(() => false)\n}\n\nexport function yarnIsAvailable() {\n  return execa('yarn', ['-v'])\n    .then(() => true)\n    .catch(() => false)\n}\n\nexport function pnpmAvailable() {\n  return execa('pnpm', ['-v'])\n    .then(() => true)\n    .catch(() => false)\n}\n\nexport async function promptForPackageManager() {\n  const [npm, yarn, pnpm] = await Promise.all([\n    npmIsAvailable(),\n    yarnIsAvailable(),\n    pnpmAvailable(),\n  ])\n\n  const choices = [npm && 'npm', yarn && 'yarn', pnpm && 'pnpm'].filter(Boolean)\n  if (choices.length < 2) {\n    return choices[0] || 'npm'\n  }\n\n  return prompt('Which package manager do you prefer?', {\n    choices: choices.map((value) => ({value, name: value})),\n    default: choices[0],\n  })\n}\n\nexport async function installDependencies(pm: string, {cwd}: {cwd?: string}) {\n  const proc = execa(pm, ['install'], {cwd, stdio: 'inherit'})\n  const {exitCode} = await proc\n  return exitCode <= 0\n}\n","import path from 'path'\nimport meow from 'meow'\nimport log from '../util/log'\nimport {init, initFlags} from '../actions/init'\nimport {isEmptyish, ensureDir} from '../util/files'\nimport {installDependencies, promptForPackageManager} from '../npm/manager'\nimport {findStudioV3Config, hasSanityJson} from '../sanity/manifest'\nimport {prompt} from '../util/prompt'\nimport {cliName} from '../constants'\nimport {presetHelpList} from '../presets/presets'\n\nconst description = `Initialize a new Sanity plugin`\n\nconst help = `\nUsage\n  $ ${cliName} init [dir] [<args>]\n\nOptions\n  --no-eslint             Disables ESLint config and dependencies from being added\n  --no-prettier           Disables prettier config and dependencies from being added\n  --no-typescript         Disables typescript config and dependencies from being added\n  --no-license            Disables LICENSE + package.json license field from being added\n  --no-editorconfig       Disables .editorconfig from being added\n  --no-gitignore          Disables .gitignore from being added\n  --no-scripts            Disables scripts from being added to package.json\n  --no-install            Disables automatically running package manager install\n\n  --name [package-name]   Use the provided package-name\n  --author [name]         Use the provided author\n  --repo [url]            Use the provided repo url\n  --license [spdx]        Use the license with the given SPDX identifier\n  --force                 No promt when overwriting files\n\n  --preset [preset-name]  Adds config and files from a named preset. --preset can be supplied multiple times.\n                          The following presets are available:\n${presetHelpList(30)}\n\nExamples\n  # Initialize a new plugin in the current directory\n  $ ${cliName} init\n\n  # Initialize a plugin in the directory ~/my-plugin\n  $ ${cliName} init ~/my-plugin\n\n  # Don't add eslint or prettier\n  $ ${cliName} init --no-eslint --no-prettier\n`\n\nasync function run({argv}: {argv: string[]}) {\n  const cli = meow(help, {flags: initFlags, argv, description})\n  const basePath = path.resolve(cli.input[0] || process.cwd())\n\n  const {exists, isRoot} = await hasSanityJson(basePath)\n  if (exists && isRoot) {\n    throw new Error(\n      `sanity.json has a \"root\" property set to true - are you trying to init into a studio instead of a plugin?`\n    )\n  }\n\n  const {v3ConfigFile} = await findStudioV3Config(basePath)\n  if (v3ConfigFile) {\n    throw new Error(\n      `${v3ConfigFile} exsists - are you trying to init into a studio instead of a plugin?`\n    )\n  }\n\n  log.info('Initializing new plugin in \"%s\"', basePath)\n  if (\n    !cli.flags.force &&\n    !(await isEmptyish(basePath)) &&\n    !(await prompt('Directory is not empty, proceed?', {type: 'confirm', default: false}))\n  ) {\n    log.error('Directory is not empty. Cancelled.')\n    return\n  }\n\n  await ensureDir(basePath)\n  await init({basePath, flags: cli.flags})\n  if (cli.flags.install) {\n    if (await installDependencies(await promptForPackageManager(), {cwd: basePath})) {\n      log.info('Done!')\n    } else {\n      log.error('Failed to install dependencies, try manually running `npm install`')\n    }\n  } else {\n    log.info('Dependency installation skipped.')\n  }\n}\n\nexport default run\n"],"names":["npmIsAvailable","execa","then","catch","yarnIsAvailable","pnpmAvailable","promptForPackageManager","npm","yarn","pnpm","Promise","all","choices","filter","Boolean","length","prompt","map","value","name","default","installDependencies","pm","cwd","proc","stdio","exitCode","description","help","cliName","presetHelpList","run","argv","cli","meow","flags","initFlags","basePath","path","resolve","input","process","exists","isRoot","hasSanityJson","Error","v3ConfigFile","findStudioV3Config","log","info","force","isEmptyish","type","error","ensureDir","init","install"],"mappings":";;;;;;;;;;;;;;;;AAGO,SAASA,cAAiB,GAAA;EAC/B,OAAOC,sBAAM,CAAA,KAAA,EAAO,CAAC,IAAI,CAAC,CAAA,CACvBC,IAAK,CAAA,MAAM,IAAI,CAAA,CACfC,KAAM,CAAA,MAAM,KAAK,CAAA;AACtB;AAEO,SAASC,eAAkB,GAAA;EAChC,OAAOH,sBAAM,CAAA,MAAA,EAAQ,CAAC,IAAI,CAAC,CAAA,CACxBC,IAAK,CAAA,MAAM,IAAI,CAAA,CACfC,KAAM,CAAA,MAAM,KAAK,CAAA;AACtB;AAEO,SAASE,aAAgB,GAAA;EAC9B,OAAOJ,sBAAM,CAAA,MAAA,EAAQ,CAAC,IAAI,CAAC,CAAA,CACxBC,IAAK,CAAA,MAAM,IAAI,CAAA,CACfC,KAAM,CAAA,MAAM,KAAK,CAAA;AACtB;AAEA,eAAsBG,uBAA0B,GAAA;EAC9C,MAAM,CAACC,GAAK,EAAAC,IAAA,EAAMC,IAAI,CAAI,GAAA,MAAMC,QAAQC,GAAI,CAAA,CAC1CX,cAAe,EAAA,EACfI,eAAgB,EAAA,EAChBC,aAAc,EAAA,CACf,CAAA;EAEK,MAAAO,OAAA,GAAU,CAACL,GAAA,IAAO,KAAO,EAAAC,IAAA,IAAQ,QAAQC,IAAQ,IAAA,MAAM,CAAE,CAAAI,MAAA,CAAOC,OAAO,CAAA;EACzE,IAAAF,OAAA,CAAQG,SAAS,CAAG,EAAA;IACtB,OAAOH,QAAQ,CAAM,CAAA,IAAA,KAAA;EACvB;EAEA,OAAOI,QAAAA,CAAAA,OAAO,sCAAwC,EAAA;IACpDJ,OAAA,EAASA,QAAQK,GAAI,CAACC,UAAW;MAACA,KAAA;MAAOC,IAAM,EAAAD;IAAA,CAAO,CAAA,CAAA;IACtDE,SAASR,OAAQ,CAAA,CAAA;EAAA,CAClB,CAAA;AACH;AAEA,eAAsBS,mBAAoB,CAAAC,EAAA,QAAmC;EAAA,IAAvB;IAACC;GAAsB;EACrE,MAAAC,IAAA,GAAOvB,sBAAM,CAAAqB,EAAA,EAAI,CAAC,SAAS,GAAG;IAACC,GAAA;IAAKE,KAAO,EAAA;EAAA,CAAU,CAAA;EACrD,MAAA;IAACC;GAAQ,GAAI,MAAMF,IAAA;EACzB,OAAOE,QAAY,IAAA,CAAA;AACrB;AChCA,MAAMC,WAAc,mCAAA;AAEpB,MAAMC,IAAO,0BAEPC,WAAA,qoCAoBJC,oBAAe,EAAE,CAAA,qFAIbD,WAAA,gFAGAA,WAAA,wEAGAA,WAAA,sCAAA;AAGN,eAAeE,GAAA,QAA8B;EAAA,IAA1B;IAACC;GAAyB;EACrC,MAAAC,KAAA,GAAMC,sBAAKN,IAAM,EAAA;IAACO,OAAOC,cAAW;IAAAJ,IAAA;IAAML;GAAY,CAAA;EACtD,MAAAU,QAAA,GAAWC,sBAAKC,OAAQ,CAAAN,KAAA,CAAIO,MAAM,CAAM,CAAA,IAAAC,OAAA,CAAQlB,KAAK,CAAA;EAE3D,MAAM;IAACmB,MAAQ;IAAAC;EAAA,CAAU,GAAA,MAAMC,uBAAcP,QAAQ,CAAA;EACrD,IAAIK,UAAUC,MAAQ,EAAA;IACpB,MAAM,IAAIE,KAAA,+GAEV;EACF;EAEA,MAAM;IAACC;EAAgB,CAAA,GAAA,MAAMC,4BAAmBV,QAAQ,CAAA;EACxD,IAAIS,YAAc,EAAA;IAChB,MAAM,IAAID,KAAA,WACLC,YAAA,0EACL;EACF;EAEIE,GAAAA,CAAAA,GAAA,CAAAC,IAAA,CAAK,mCAAmCZ,QAAQ,CAAA;EACpD,IACE,CAACJ,KAAI,CAAAE,KAAA,CAAMe,SACX,EAAE,MAAMC,oBAAWd,QAAQ,CAAA,KAC3B,EAAE,MAAMrB,QAAA,CAAAA,MAAA,CAAO,oCAAoC;IAACoC,IAAA,EAAM;IAAWhC,OAAS,EAAA;EAAA,CAAM,CACpF,GAAA;IACA4B,OAAA,CAAIK,MAAM,oCAAoC,CAAA;IAC9C;EACF;EAEA,MAAMC,QAAAA,CAAAA,UAAUjB,QAAQ,CAAA;EACxB,MAAMkB,IAAAA,CAAAA,KAAK;IAAClB,QAAA;IAAUF,KAAO,EAAAF,KAAA,CAAIE;GAAM,CAAA;EACnC,IAAAF,KAAA,CAAIE,MAAMqB,OAAS,EAAA;IACjB,IAAA,MAAMnC,oBAAoB,MAAMf,uBAAA,IAA2B;MAACiB,GAAA,EAAKc;IAAQ,CAAC,CAAG,EAAA;MAC/EW,OAAA,CAAIC,KAAK,OAAO,CAAA;IAAA,CACX,MAAA;MACLD,OAAA,CAAIK,MAAM,oEAAoE,CAAA;IAChF;EAAA,CACK,MAAA;IACLL,OAAA,CAAIC,KAAK,kCAAkC,CAAA;EAC7C;AACF;"}