@sanity/dashboard 3.0.0-v3-studio.0 → 3.0.0-v3-studio.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +10 -17
  3. package/package.json +12 -11
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2016 - 2022 Sanity.io
3
+ Copyright (c) 2022 - 2022 Sanity.io
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -20,11 +20,11 @@ The Dashboard itself is mostly concerned about the layout of the configured widg
20
20
 
21
21
  In your Sanity Content Studio run:
22
22
 
23
- `npm install --save @sanity/dashboard@sanity-v3`
23
+ `npm install --save @sanity/dashboard@studio-v3`
24
24
 
25
25
  or
26
26
 
27
- `yarn add @sanity/dashboard@sanity-v3`
27
+ `yarn add @sanity/dashboard@studio-v3`
28
28
 
29
29
  ## Basic usage
30
30
  In `sanity.config.js` (or .ts), add the dashboard tool to the createConfig plugins array:
@@ -175,23 +175,16 @@ If you were previously using @sanity/dashboard in a v2 Sanity Studio, will have
175
175
 
176
176
  ## Develop & test
177
177
 
178
- Make sure to run `npm run build` once, then run
178
+ This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
179
+ with default configuration for build & watch scripts.
179
180
 
180
- ```bash
181
- npm run link-watch
182
- ```
181
+ See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
182
+ on how to run this plugin with hotreload in the studio.
183
183
 
184
- In another shell, `cd` to your test studio and run:
184
+ ### Release new version
185
185
 
186
- ```bash
187
- npx yalc add @sanity/dashboard --link && yarn install
188
- ```
186
+ Run ["CI & Release" workflow](https://github.com/sanity-io/dashboard/actions/workflows/main.yml).
187
+ Make sure to select the main branch and check "Release new version".
189
188
 
190
- Now, changes in this repo will be automatically built and pushed to the studio,
191
- triggering hotreload. Yalc avoids issues with react-hooks that are typical when using yarn/npm link.
189
+ Semantic release will only release on configured branches, so it is safe to run release on any branch.
192
190
 
193
-
194
- ### About build & watch
195
-
196
- This plugin uses [@sanity/plugin-sdk](https://github.com/sanity-io/plugin-sdk)
197
- with default configuration for build & watch scripts.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sanity/dashboard",
3
- "version": "3.0.0-v3-studio.0",
3
+ "version": "3.0.0-v3-studio.2",
4
4
  "description": "Tool for rendering dashboard widgets",
5
5
  "source": "./src/index.tsx",
6
6
  "exports": {
@@ -42,19 +42,20 @@
42
42
  "sanity-tool"
43
43
  ],
44
44
  "dependencies": {
45
- "@sanity/icons": "^1.2.8",
45
+ "@sanity/icons": "^1.3.6",
46
46
  "@sanity/image-url": "^1.0.1",
47
- "@sanity/incompatible-plugin": "^0.0.1-studio-v3.1",
48
- "@sanity/ui": "^0.37.9",
47
+ "@sanity/incompatible-plugin": "^1.0.1",
48
+ "@sanity/ui": "^0.38.2",
49
49
  "lodash": "^4.17.21",
50
50
  "rxjs": "^6.5.3"
51
51
  },
52
52
  "devDependencies": {
53
- "@commitlint/cli": "^16.1.0",
54
- "@commitlint/config-conventional": "^15.0.0",
53
+ "@commitlint/cli": "^17.1.2",
54
+ "@commitlint/config-conventional": "^17.1.0",
55
55
  "@parcel/packager-ts": "^2.6.0",
56
56
  "@parcel/transformer-typescript-types": "^2.6.0",
57
- "@sanity/plugin-kit": "^0.0.1-studio-v3.4",
57
+ "@sanity/plugin-kit": "^1.1.0-ecosystem-preset.5",
58
+ "@sanity/semantic-release-preset": "^2.0.1",
58
59
  "@types/styled-components": "^5.1.25",
59
60
  "@typescript-eslint/eslint-plugin": "^5.12.0",
60
61
  "@typescript-eslint/parser": "^5.12.0",
@@ -64,15 +65,15 @@
64
65
  "eslint-plugin-prettier": "4.0.0",
65
66
  "eslint-plugin-react": "^7.28.0",
66
67
  "eslint-plugin-react-hooks": "^4.5.0",
67
- "husky": "^7.0.0",
68
- "lint-staged": "^12.3.3",
68
+ "husky": "^8.0.1",
69
+ "lint-staged": "^13.0.3",
69
70
  "parcel": "^2.6.0",
70
71
  "prettier": "^2.5.1",
71
72
  "react": "^17.0.0 || ^18.0.0",
72
73
  "rimraf": "^3.0.2",
73
- "sanity": "^3.0.0-dev-preview.7",
74
+ "sanity": "3.0.0-dev-preview.15",
74
75
  "styled-components": "^5.3.5",
75
- "typescript": "^4.7.3"
76
+ "typescript": "4.7.3"
76
77
  },
77
78
  "peerDependencies": {
78
79
  "react": "^17.0.0 || ^18.0.0",