1.0.4 • Published 3 years ago

@sanity/incompatible-plugin v1.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

@sanity/incompatible-plugin

Small helper library that will display a warning in Sanity Studio v2 when a plugin built for Studio v3 is installed.

Installation

npm i @sanity/incompatible-plugin

or

yarn add @sanity/incompatible-plugin

Usage

In your plugin root directory, create two files:

v2-incompatible.js

const {showIncompatiblePluginDialog} = require('@sanity/incompatible-plugin')
const {name, version} = require('./package.json')

export default showIncompatiblePluginDialog({
  name: name,
  versions: {
    v3: version,
    // Optional: If there is not v2 version of your plugin, v2 can be omitted
    v2: '^1.2.5',
  },
  // Optional: Feel free to put this as field in package.json and import it alongside name and version above
  sanityExchangeUrl: 'https://www.sanity.io/plugins/<plugin-on-sanity-exchanged>',
})

sanity.json

{
  "parts": [
    {
      "implements": "part:@sanity/base/sanity-root",
      "path": "./v2-incompatible.js"
    }
  ]
}

Add these to files in the plugin package.json alongside anything else already there, for instance:

{
  "files": ["src", "lib", "v2-incompatible.js", "sanity.json"]
}

Done!

If your v3 plugin gets installed in a v2 studio by mistake, a dialog will display how to fix it.

Develop

Release new version

Run "CI & Release" workflow. Make sure to select the main branch and check "Release new version".

Semantic release will only release on configured branches, so it is safe to run release on any branch.

@infinitebrahmanuniverse/nolb-_san@zafercuz/sanity-plugin-sanity-test-publish@everything-registry/sub-chunk-805sanity-plugin-image-alt-gen@commercelayer/sanity-plugin-commerce@tinloof/sanity-plugin-pages-navigatorspacedawwwg-language-filterto-gyp-or-not-to-gyp@amexiogroup/sanity-plugin-media-i18n@ashwin-op/color-input@aliameur/sanity-plugin-link-field@alain.kaiser/orderable-document-list@bitfo/sanity-plugin-portable-table@bitfo/sanity-plugin-table@catherineriver/sanity-plugin-generate-ogimage@burgersonbrioche/sanity-scheduled-publishing223300-qr@codingcatdev/sanity-plugin-podcast-rss@dennispassway/sanity-plugin-media@headless.build/sanity-color-picker@headless.build/sanity-font-picker@headless.build/sanity-plugin-range-slider@heavy-dev/sanity-plugin-media@focus-reactive/sanity-ai-toolkit@focus-reactive/sanity-plugin-inline-svg-input@hatchd/sanity-plugin-color-select@hatchd/sanity-plugin-form-builder@hatchd/sanity-plugin-get-coordinates@gearbox-built/sanity-admin-message@gearbox-built/sanity-autocomplete-address@gearbox-built/sanity-content-import@gearbox-built/sanity-multi-reference@gearbox-built/sanity-schema-tool@gearbox-built/sanity-structured-data@gearbox-built/sanity-vimeo@goldsucc/sanity-plugin-taxonomy-manager@frontvibe/sanity-color-picker@frontvibe/sanity-font-picker@frontvibe/sanity-plugin-range-slider@gigadesignstudio/sanity-plugin-dospaces@liamb13/sanity-plugin-gea-icons@liammartens/sanity-plugin-internationalized-array@ismarslomic/sanity-plugin-tag-hierarchy@madebythread/thread-kit@mgrzyb/sanity-plugin-sitemap@microbit/sanity-plugin-python-editor-v3@nadir2k/google-maps-input@equinor/document-internationalization@moller/sanity-plugin-mime@kaliber/sanity-plugin-duplicate@kaliber/sanity-plugin-multi-language@kaliber/sanity-plugin-nav-extend@jlalic/sanity-plugin-seo-pane@jackfowler/sanity-plugin-cloudinary-extended@imageshop-org/sanity-plugin-asset-source-imageshop@jetskis/headup@jetskis/sanity-plugin-headup@q42/sanity-plugin-page-tree@q42/sanity-plugin-user-guide@practical-js/sanity-hierarchical-docs@ptimson/sanity-color-input@prospero-labs/sanity-plugin-icon-picker@sanity/document-internationalization@sanity/google-maps-input@sanity/hierarchical-document-list@sanity/embeddings-index-ui@sanity/rich-date-input@sanity/scheduled-publishing@sanity/studio-secrets@sanity/table@sanity/orderable-document-list@sanity/cross-dataset-duplicator@sanity/color-input@sanity/dashboard@sanity-visx/studio@sanity/assist@sanity/code-input@sanity/language-filter@screentek/sanity-plugin-asset-source-imageshop@pogasanov/sanity-plugin-color-list@nuagedelait/sanity-pagebuilder@planetary/sanity-plugin-apple-news@planetary/sanity-plugin-preflight@operationnation/sanity-plugin-schema-markup@orangelogic/sanity-plugin-asset-source-cortex@selvklart/sanity-plugin-desk-hierarchy@selvklart/sanity-plugin-workflow@seidhr/sanity-plugin-dashboard-widget-muna-docs@seidhr/sanity-plugin-timespan-inputsanity-plugin-cloudinarysanity-plugin-cn-completionsanity-plugin-color-picker-v3sanity-plugin-computed-fieldsanity-plugin-content-calendarsanity-plugin-content-model-graphsanity-plugin-dashboard-widget-catssanity-plugin-asset-source-giphysanity-plugin-asset-source-ogimagesanity-plugin-asset-source-openaisanity-plugin-asset-source-stock-images
1.0.4

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.3

3 years ago

1.0.0

3 years ago

0.0.1

3 years ago