sanity-plugin-workspace-home 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Sanity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# sanity-plugin-workspace-home
+
+> This is a **Sanity Studio v3** plugin.
+
+This plugin adds a "Home" Tool to your Studio with a listing of all available workspaces. Useful as the first page of your Studio to quickly navigate to the workspace of your choice.
+
+![plugin inside sanity studio showing workspaces](https://user-images.githubusercontent.com/9684022/226922805-490922c0-8b85-4d06-9770-ff81e0a33837.png)
+
+## Installation
+
+```sh
+npm install sanity-plugin-workspace-home
+```
+
+## Usage
+
+For simple installation, import the predefined workspace config from the plugin and use it as the first config in your `sanity.config.ts` (or .js) file.
+
+```ts
+import {defineConfig} from 'sanity'
+import {workspaceHomeConfig} from 'sanity-plugin-workspace-home'
+
+export default defineConfig([
+  workspaceHomeConfig({
+    // projectId and dataset are required, but not used by the plugin
+    projectId: 'replace-with-your-project-id',
+    dataset: 'replace-with-your-dataset-name',    
+  }),
+  // ...all other workspaces
+])
+```
+
+Alternatively, define your own workspace config for the plugin. This plugin is designed to be used in a workspace where it is the only plugin. This should be the first workspace configured in `sanity.config.ts` (or .js).
+
+```ts
+import {defineConfig} from 'sanity'
+import {workspaceHome} from 'sanity-plugin-workspace-home'
+
+export default defineConfig([{
+  {
+    name: 'home',
+    title: 'Home',
+    basePath: '/home',
+    icon: HomeIcon,
+    plugins: [workspaceHome()],
+    // projectId and dataset are required, but not used by the plugin
+    projectId: 'replace-with-your-project-id',
+    dataset: 'replace-with-your-dataset-name',
+  },
+  // ...all other workspaces
+}])
+```
+
+## License
+
+[MIT](LICENSE) © Sanity
+
+## Develop & test
+
+This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
+with default configuration for build & watch scripts.
+
+See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
+on how to run this plugin with hotreload in the studio.
+
+
+### Release new version
+
+Run ["CI & Release" workflow](TODO/actions/workflows/main.yml).
+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.

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import {Config} from 'sanity'
+import {Plugin as Plugin_2} from 'sanity'
+
+export declare const workspaceHome: Plugin_2<void>
+
+export declare const workspaceHomeConfig: ({projectId, dataset}: WorkspaceHomeConfigProps) => Config
+
+declare type WorkspaceHomeConfigProps = {
+  projectId: string
+  dataset: string
+}
+
+export {}