@sanity/plugin-kit 2.1.12 → 2.1.14
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.
- package/README.md +19 -1
- package/assets/inject/semver-workflow/.github/workflows/main.yml +1 -1
- package/lib/package.json +16 -16
- package/lib/src/actions/link-watch.js +9 -1
- package/lib/src/actions/link-watch.js.map +1 -1
- package/lib/src/presets/semver-workflow.js +1 -8
- package/lib/src/presets/semver-workflow.js.map +1 -1
- package/lib/src/util/readme.d.ts +1 -0
- package/lib/src/util/readme.js +7 -1
- package/lib/src/util/readme.js.map +1 -1
- package/lib/src/util/user.js +5 -4
- package/lib/src/util/user.js.map +1 -1
- package/package.json +16 -16
- package/src/actions/link-watch.ts +9 -1
- package/src/presets/semver-workflow.ts +7 -10
- package/src/util/readme.ts +6 -0
- package/src/util/user.ts +3 -4
package/README.md
CHANGED
|
@@ -57,8 +57,26 @@ npx @sanity/plugin-kit init sanity-plugin-testing-it-out
|
|
|
57
57
|
cd sanity-plugin-testing-it-out
|
|
58
58
|
npm run link-watch
|
|
59
59
|
|
|
60
|
-
# In another shell
|
|
60
|
+
# In another shell
|
|
61
61
|
cd /path/to/my-studio
|
|
62
|
+
# now link the plugin to your Sanity studio using the command indicated by link-watch output (see below)
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Run **ONE** of the below commands, **based on the package manager** used in your studio:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
# studio uses yarn
|
|
69
|
+
cd /path/to/my-studio
|
|
70
|
+
yalc add --link sanity-plugin-testing-it-out && yarn install
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
# studio uses npm
|
|
75
|
+
cd /path/to/my-studio
|
|
76
|
+
npx yalc add sanity-plugin-testing-it-out && npx yalc link sanity-plugin-testing-it-out && npm install
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
# Use this command if your studio uses yarn
|
|
62
80
|
npx yalc add sanity-plugin-testing-it-out && npx yalc link sanity-plugin-testing-it-out && npm install
|
|
63
81
|
|
|
64
82
|
```
|
package/lib/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sanity/plugin-kit",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.14",
|
|
4
4
|
"description": "Enhanced Sanity.io plugin development experience",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"sanity-io",
|
|
@@ -65,47 +65,47 @@
|
|
|
65
65
|
"email-validator": "^2.0.4",
|
|
66
66
|
"execa": "^5.1.1",
|
|
67
67
|
"find-babel-config": "^1.2.0",
|
|
68
|
-
"get-it": "^
|
|
68
|
+
"get-it": "^7.0.2",
|
|
69
69
|
"get-latest-version": "^4.0.0",
|
|
70
70
|
"git-remote-origin-url": "^3.1.0",
|
|
71
|
-
"git-user-info": "^
|
|
71
|
+
"git-user-info": "^2.0.3",
|
|
72
72
|
"github-url-to-object": "^4.0.6",
|
|
73
73
|
"inquirer": "^8.2.5",
|
|
74
74
|
"meow": "^9.0.0",
|
|
75
75
|
"nodemon": "^2.0.20",
|
|
76
|
-
"npm-packlist": "^
|
|
76
|
+
"npm-packlist": "^7.0.2",
|
|
77
77
|
"npm-run-path": "^4.0.1",
|
|
78
78
|
"outdent": "^0.8.0",
|
|
79
79
|
"p-any": "^3.0.0",
|
|
80
80
|
"p-props": "^4.0.0",
|
|
81
|
-
"postcss": "^8.4.
|
|
81
|
+
"postcss": "^8.4.19",
|
|
82
82
|
"rimraf": "^3.0.2",
|
|
83
83
|
"semver": "^7.3.8",
|
|
84
84
|
"spdx-license-ids": "^3.0.12",
|
|
85
|
-
"validate-npm-package-name": "^
|
|
85
|
+
"validate-npm-package-name": "^5.0.0",
|
|
86
86
|
"xdg-basedir": "^4.0.0",
|
|
87
87
|
"yalc": "^1.0.0-pre.53"
|
|
88
88
|
},
|
|
89
89
|
"devDependencies": {
|
|
90
90
|
"@commitlint/cli": "^17.2.0",
|
|
91
91
|
"@commitlint/config-conventional": "^17.2.0",
|
|
92
|
-
"@sanity/pkg-utils": "^1.
|
|
92
|
+
"@sanity/pkg-utils": "^1.18.0",
|
|
93
93
|
"@sanity/semantic-release-preset": "^2.0.2",
|
|
94
|
-
"@types/eslint": "^8.4.
|
|
94
|
+
"@types/eslint": "^8.4.10",
|
|
95
95
|
"@types/fs-extra": "^9.0.13",
|
|
96
|
-
"@types/inquirer": "^
|
|
97
|
-
"@types/node": "^
|
|
96
|
+
"@types/inquirer": "^9.0.3",
|
|
97
|
+
"@types/node": "^18.11.9",
|
|
98
98
|
"@types/nodemon": "^1.19.2",
|
|
99
99
|
"@types/tap": "^15.0.7",
|
|
100
|
-
"@typescript-eslint/eslint-plugin": "^5.
|
|
101
|
-
"@typescript-eslint/parser": "^5.
|
|
102
|
-
"eslint": "^8.
|
|
100
|
+
"@typescript-eslint/eslint-plugin": "^5.43.0",
|
|
101
|
+
"@typescript-eslint/parser": "^5.43.0",
|
|
102
|
+
"eslint": "^8.27.0",
|
|
103
103
|
"eslint-config-prettier": "^8.5.0",
|
|
104
104
|
"eslint-config-sanity": "^6.0.0",
|
|
105
105
|
"eslint-plugin-prettier": "^4.2.1",
|
|
106
106
|
"eslint-plugin-react-hooks": "^4.6.0",
|
|
107
107
|
"fs-extra": "^10.1.0",
|
|
108
|
-
"husky": "^8.0.
|
|
108
|
+
"husky": "^8.0.2",
|
|
109
109
|
"json5": "^2.2.1",
|
|
110
110
|
"lint-staged": "^13.0.3",
|
|
111
111
|
"prettier": "^2.7.1",
|
|
@@ -113,8 +113,8 @@
|
|
|
113
113
|
"readdirp": "^3.6.0",
|
|
114
114
|
"rimraf": "^3.0.2",
|
|
115
115
|
"sanity": "3.0.0-rc.2",
|
|
116
|
-
"sinon": "^14.0.
|
|
117
|
-
"tap": "^16.3.
|
|
116
|
+
"sinon": "^14.0.2",
|
|
117
|
+
"tap": "^16.3.1",
|
|
118
118
|
"ts-node": "^10.9.1",
|
|
119
119
|
"typescript": "^4.8.4"
|
|
120
120
|
},
|
|
@@ -62,7 +62,15 @@ function linkWatch({ basePath }) {
|
|
|
62
62
|
log_1.default.info((0, outdent_1.default) `
|
|
63
63
|
Watching ${watch.folder} for changes to files with extensions: ${watch.extensions}
|
|
64
64
|
|
|
65
|
-
To test this package in another
|
|
65
|
+
To test this package in Sanity Studio or another package, in a separate shell run:
|
|
66
|
+
cd /path/to/sanity/studio-or-package
|
|
67
|
+
|
|
68
|
+
Then, run one of the below commands, based on the package manager used in studio-or-package:
|
|
69
|
+
|
|
70
|
+
## yarn
|
|
71
|
+
${chalk_1.default.greenBright(`yalc add --link ${pkg.name} && yarn install`)}
|
|
72
|
+
|
|
73
|
+
## npm
|
|
66
74
|
${chalk_1.default.greenBright(`npx yalc add ${pkg.name} && npx yalc link ${pkg.name} && npm install`)}
|
|
67
75
|
`.trimStart());
|
|
68
76
|
})
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"link-watch.js","sourceRoot":"","sources":["../../../src/actions/link-watch.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;EAYE;;;;;;;;;;;;;;;AAEF;;;EAGE;AAEF,sDAA6B;AAC7B,gEAAuC;AACvC,kDAAyB;AACzB,4CAAmB;AACnB,gDAAuB;AACvB,sDAA6B;AAC7B,4CAAyC;AACzC,sDAA6B;AAC7B,yCAA+C;AAY/C,SAAsB,SAAS,CAAC,EAAC,QAAQ,EAAqB;;;QAC5D,MAAM,WAAW,GAAgB,IAAI,CAAC,KAAK,CACzC,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAC7D,CAAA;QAED,MAAM,KAAK,mBACT,MAAM,EAAE,KAAK,EACb,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,4BAA4B,IACrC,MAAA,WAAW,CAAC,YAAY,0CAAE,SAAS,CACvC,CAAA;QAED,IAAA,iBAAO,EAAC;YACN,KAAK,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC;YACrB,GAAG,EAAE,KAAK,CAAC,UAAU;YACrB,IAAI,EAAE,qBAAqB;YAC3B,aAAa;SACd,CAAC,CAAA;QAEF,+CAA+C;QAC/C,MAAM,MAAM,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAChD,IAAI,CAAC,CAAC,MAAM,IAAA,kBAAU,EAAC,MAAM,CAAC,CAAC,EAAE;YAC/B,MAAM,IAAA,aAAK,EAAC,MAAM,CAAC,CAAA;SACpB;QAED,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,EAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAA;QAEzD,IAAA,sBAAY,EAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;QAE7B,iBAAO;aACJ,EAAE,CAAC,OAAO,EAAE;YACX,aAAG,CAAC,IAAI,CACN,IAAA,iBAAO,EAAA;mBACI,KAAK,CAAC,MAAM,0CAA0C,KAAK,CAAC,UAAU
|
|
1
|
+
{"version":3,"file":"link-watch.js","sourceRoot":"","sources":["../../../src/actions/link-watch.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;EAYE;;;;;;;;;;;;;;;AAEF;;;EAGE;AAEF,sDAA6B;AAC7B,gEAAuC;AACvC,kDAAyB;AACzB,4CAAmB;AACnB,gDAAuB;AACvB,sDAA6B;AAC7B,4CAAyC;AACzC,sDAA6B;AAC7B,yCAA+C;AAY/C,SAAsB,SAAS,CAAC,EAAC,QAAQ,EAAqB;;;QAC5D,MAAM,WAAW,GAAgB,IAAI,CAAC,KAAK,CACzC,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAC7D,CAAA;QAED,MAAM,KAAK,mBACT,MAAM,EAAE,KAAK,EACb,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,4BAA4B,IACrC,MAAA,WAAW,CAAC,YAAY,0CAAE,SAAS,CACvC,CAAA;QAED,IAAA,iBAAO,EAAC;YACN,KAAK,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC;YACrB,GAAG,EAAE,KAAK,CAAC,UAAU;YACrB,IAAI,EAAE,qBAAqB;YAC3B,aAAa;SACd,CAAC,CAAA;QAEF,+CAA+C;QAC/C,MAAM,MAAM,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAChD,IAAI,CAAC,CAAC,MAAM,IAAA,kBAAU,EAAC,MAAM,CAAC,CAAC,EAAE;YAC/B,MAAM,IAAA,aAAK,EAAC,MAAM,CAAC,CAAA;SACpB;QAED,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,EAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAA;QAEzD,IAAA,sBAAY,EAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;QAE7B,iBAAO;aACJ,EAAE,CAAC,OAAO,EAAE;YACX,aAAG,CAAC,IAAI,CACN,IAAA,iBAAO,EAAA;mBACI,KAAK,CAAC,MAAM,0CAA0C,KAAK,CAAC,UAAU;;;;;;;;UAQ/E,eAAK,CAAC,WAAW,CAAC,mBAAmB,GAAG,CAAC,IAAI,kBAAkB,CAAC;;;UAGhE,eAAK,CAAC,WAAW,CAAC,gBAAgB,GAAG,CAAC,IAAI,qBAAqB,GAAG,CAAC,IAAI,iBAAiB,CAAC;OAC5F,CAAC,SAAS,EAAE,CACZ,CAAA;QACH,CAAC,CAAC;aACD,EAAE,CAAC,MAAM,EAAE;YACV,OAAO,CAAC,IAAI,EAAE,CAAA;QAChB,CAAC,CAAC;aACD,EAAE,CAAC,SAAS,EAAE,UAAU,KAAU;YACjC,aAAG,CAAC,IAAI,CAAC,yBAAyB,EAAE,eAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAA;YAC/D,aAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAA;QACzC,CAAC,CAAC,CAAA;;CACL;AAvDD,8BAuDC"}
|
|
@@ -89,13 +89,6 @@ function readmeSnippets(options) {
|
|
|
89
89
|
const pkg = yield (0, package_1.getPackage)(options);
|
|
90
90
|
const user = yield (0, user_1.getUserInfo)(options, pkg);
|
|
91
91
|
const bestEffortUrl = readmeBaseurl(pkg);
|
|
92
|
-
const v3Banner = (0, outdent_1.default) `
|
|
93
|
-
> **NOTE**
|
|
94
|
-
>
|
|
95
|
-
> This is the **Sanity Studio v3 version** of ${pkg.name}.
|
|
96
|
-
>
|
|
97
|
-
> For the v2 version, please refer to the [v2-branch](${bestEffortUrl}).
|
|
98
|
-
`;
|
|
99
92
|
const install = (0, readme_1.installationSnippet)((_a = pkg.name) !== null && _a !== void 0 ? _a : 'unknown');
|
|
100
93
|
const usage = (0, outdent_1.default) `
|
|
101
94
|
## Usage
|
|
@@ -110,7 +103,7 @@ function readmeSnippets(options) {
|
|
|
110
103
|
Semantic release will only release on configured branches, so it is safe to run release on any branch.
|
|
111
104
|
`;
|
|
112
105
|
return {
|
|
113
|
-
v3Banner,
|
|
106
|
+
v3Banner: (0, readme_1.v3BannerNotice)(),
|
|
114
107
|
install,
|
|
115
108
|
usage,
|
|
116
109
|
license,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"semver-workflow.js","sourceRoot":"","sources":["../../../src/presets/semver-workflow.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8CAAoE;AACpE,wEAAkE;AAElE,4CAMuB;AACvB,sDAA6B;AAC7B,sDAA6B;AAC7B,kDAAyB;AACzB,gDAAuB;AACvB,yCAAiD;AACjD,+DAAyD;AAEzD,
|
|
1
|
+
{"version":3,"file":"semver-workflow.js","sourceRoot":"","sources":["../../../src/presets/semver-workflow.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8CAAoE;AACpE,wEAAkE;AAElE,4CAMuB;AACvB,sDAA6B;AAC7B,sDAA6B;AAC7B,kDAAyB;AACzB,gDAAuB;AACvB,yCAAiD;AACjD,+DAAyD;AAEzD,2CAKuB;AACvB,uCAAwC;AAE3B,QAAA,oBAAoB,GAAW;IAC1C,IAAI,EAAE,iBAAiB;IACvB,WAAW,EACT,wFAAwF;IAC1F,KAAK,EAAE,WAAW;CACnB,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,KAAc,EAAE,GAAW,EAAE,GAAG,IAAc,EAAE,EAAE,CAAC,KAAK,IAAI,aAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;AAEhG,SAAe,WAAW,CAAC,OAAsB;;QAC/C,MAAM,IAAA,oBAAW,EAAC,mBAAmB,EAAE,EAAE,OAAO,CAAC,CAAA;QACjD,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAA;QAC/B,MAAM,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACjC,MAAM,YAAY,CAAC,OAAO,CAAC,CAAA;IAC7B,CAAC;CAAA;AAED,SAAe,gBAAgB,CAAC,OAAsB;;QACpD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAA;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAqB,EAAC,GAAG,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;YACrE,OAAO,CAAC,OAAO,GAAG,IAAA,mBAAS,EAAC,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;YAC7D,OAAO,OAAO,CAAA;QAChB,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,EAAE,sCAAsC,CAAC,CAAA;IACxD,CAAC;CAAA;AAED,SAAe,kBAAkB,CAAC,OAAsB;;QACtD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,IAAA,kBAAQ,kCACnB,GAAG,CAAC,eAAe,GACnB,CAAC,MAAM,0BAA0B,EAAE,CAAC,EACvC,CAAA;QACF,MAAM,MAAM,qBAAO,GAAG,CAAC,CAAA;QACvB,MAAM,CAAC,eAAe,GAAG,OAAO,CAAA;QAChC,MAAM,IAAA,gCAAsB,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC7C,aAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAA;QAEpC,aAAG,CAAC,IAAI,CACN,eAAK,CAAC,KAAK,CACT,IAAA,iBAAO,EAAA;;;;;;GAMV,CAAC,IAAI,EAAE,CACL,CACF,CAAA;IACH,CAAC;CAAA;AAED,SAAe,YAAY,CAAC,OAAsB;;;QAChD,MAAM,EAAC,QAAQ,EAAC,GAAG,OAAO,CAAA;QAE1B,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;QACnD,MAAM,MAAM,GAAG,MAAA,CAAC,MAAM,IAAA,gBAAQ,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,mCAAgB,CAAC,CAAC,mCAAI,EAAE,CAAA;QAEjF,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,cAAc,EAAC,GAAG,MAAM,cAAc,CAC3F,OAAO,CACR,CAAA;QAED,MAAM,eAAe,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;QAC3E,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC,CAAA;QAEtF,IAAI,eAAe,CAAC,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE;YACnD,MAAM,aAAa,GAAG,CAAC,GAAG,eAAe,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;iBAClE,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,CAAC,MAAM,CAAC,CAAA;YACf,MAAM,IAAA,iBAAS,EAAC,UAAU,EAAE,aAAa,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;YAC9D,aAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAA;SACvD;;CACF;AAED,SAAe,cAAc,CAAC,OAAsB;;;QAClD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAA;QACrC,MAAM,IAAI,GAAG,MAAM,IAAA,kBAAW,EAAC,OAAO,EAAE,GAAG,CAAC,CAAA;QAE5C,MAAM,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;QAExC,MAAM,OAAO,GAAG,IAAA,4BAAmB,EAAC,MAAA,GAAG,CAAC,IAAI,mCAAI,SAAS,CAAC,CAAA;QAE1D,MAAM,KAAK,GAAG,IAAA,iBAAO,EAAA;;GAEpB,CAAA;QAED,MAAM,OAAO,GAAG,IAAA,uBAAc,EAAC,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;QAE/F,MAAM,cAAc,GAAG,IAAA,iBAAO,EAAA;;;oCAGI,aAAa;;;;GAI9C,CAAA;QAED,OAAO;YACL,QAAQ,EAAE,IAAA,uBAAc,GAAE;YAC1B,OAAO;YACP,KAAK;YACL,OAAO;YACP,WAAW,EAAE,IAAA,2BAAkB,GAAE;YACjC,cAAc;SACf,CAAA;;CACF;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,MAAc,EAAE,QAAkB;IAChE,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;AACpE,CAAC;AAFD,0CAEC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,CAAS,EAAE,CAAS;IACvC,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAC5B,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAE5B,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAA;IAC5F,MAAM,aAAa,GAAG,aAAa,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,CAAA;IAC1D,OAAO,aAAa,CAAA;AACtB,CAAC;AAED,SAAS,mBAAmB;IAC1B,OAAO;QACL,EAAC,IAAI,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,CAAC,EAAC;QACtF,EAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAC;QAC9D,EAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAC;QAC9D,EAAC,IAAI,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,iBAAiB,EAAC;QAClD,EAAC,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAC;QAC/B,EAAC,IAAI,EAAE,CAAC,wBAAwB,CAAC,EAAE,EAAE,EAAE,sBAAsB,EAAC;QAC9D,EAAC,IAAI,EAAE,CAAC,yBAAyB,CAAC,EAAE,EAAE,EAAE,uBAAuB,EAAC;KACjE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACb,MAAM,KACT,IAAI,EAAE,CAAC,iBAAiB,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,IACzC,CAAC,CAAA;AACL,CAAC;AAED,SAAe,0BAA0B;;QACvC,OAAO,IAAA,6CAAqB,EAAC;YAC3B,iBAAiB;YACjB,iCAAiC;YACjC,iCAAiC;YACjC,OAAO;YACP,aAAa;SACd,CAAC,CAAA;IACJ,CAAC;CAAA;AAED,SAAgB,aAAa,CAAC,GAAgB;;IAC5C,OAAQ,CAAC,MAAA,MAAA,MAAA,GAAG,CAAC,UAAU,0CAAE,GAAG,mCAAI,GAAG,CAAC,QAAQ,mCAAI,MAAM,CAAY;SAC/D,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC;SAC/B,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,OAAO,CAAC,mBAAmB,EAAE,aAAa,CAAC;SAC3C,OAAO,CAAC,kBAAkB,EAAE,qBAAqB,CAAC;SAClD,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;AACxB,CAAC;AAPD,sCAOC"}
|
package/lib/src/util/readme.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { PackageData } from '../actions/inject';
|
|
2
2
|
import { User } from './user';
|
|
3
3
|
export declare function generateReadme(data: PackageData): string;
|
|
4
|
+
export declare function v3BannerNotice(): string;
|
|
4
5
|
export declare function installationSnippet(packageName: string): string;
|
|
5
6
|
export declare function developTestSnippet(): string;
|
|
6
7
|
export declare function getLicenseText(licenseId?: string, user?: User): string;
|
package/lib/src/util/readme.js
CHANGED
|
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.isDefaultGitHubReadme = exports.getLicenseText = exports.developTestSnippet = exports.installationSnippet = exports.generateReadme = void 0;
|
|
6
|
+
exports.isDefaultGitHubReadme = exports.getLicenseText = exports.developTestSnippet = exports.installationSnippet = exports.v3BannerNotice = exports.generateReadme = void 0;
|
|
7
7
|
const outdent_1 = __importDefault(require("outdent"));
|
|
8
8
|
// @ts-expect-error missing types
|
|
9
9
|
const choosealicense_list_1 = __importDefault(require("@rexxars/choosealicense-list"));
|
|
@@ -12,6 +12,8 @@ function generateReadme(data) {
|
|
|
12
12
|
return (0, outdent_1.default) `
|
|
13
13
|
# ${pluginName}
|
|
14
14
|
|
|
15
|
+
${v3BannerNotice()}
|
|
16
|
+
|
|
15
17
|
${installationSnippet(pluginName !== null && pluginName !== void 0 ? pluginName : 'unknown')}
|
|
16
18
|
|
|
17
19
|
## Usage
|
|
@@ -33,6 +35,10 @@ function generateReadme(data) {
|
|
|
33
35
|
`;
|
|
34
36
|
}
|
|
35
37
|
exports.generateReadme = generateReadme;
|
|
38
|
+
function v3BannerNotice() {
|
|
39
|
+
return `> This is a **Sanity Studio v3** plugin.`;
|
|
40
|
+
}
|
|
41
|
+
exports.v3BannerNotice = v3BannerNotice;
|
|
36
42
|
function installationSnippet(packageName) {
|
|
37
43
|
return (0, outdent_1.default) `
|
|
38
44
|
## Installation
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"readme.js","sourceRoot":"","sources":["../../../src/util/readme.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;AAC7B,iCAAiC;AACjC,uFAAmD;AAInD,SAAgB,cAAc,CAAC,IAAiB;IAC9C,MAAM,EAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAC,GAAG,IAAI,CAAA;IAErD,OAAO,IAAA,iBAAO,EAAA;QACR,UAAU;;MAEZ,mBAAmB,CAAC,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,SAAS,CAAC;;;;;;;+BAOnB,UAAU;;;;;;;;;MASnC,cAAc,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,EAAE,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,EAAC,CAAC,CAAE,IAAa,CAAC,CAAC,CAAC,SAAS,CAAC;MACpE,kBAAkB,EAAE;GACvB,CAAA;AACH,CAAC;
|
|
1
|
+
{"version":3,"file":"readme.js","sourceRoot":"","sources":["../../../src/util/readme.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;AAC7B,iCAAiC;AACjC,uFAAmD;AAInD,SAAgB,cAAc,CAAC,IAAiB;IAC9C,MAAM,EAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAC,GAAG,IAAI,CAAA;IAErD,OAAO,IAAA,iBAAO,EAAA;QACR,UAAU;;MAEZ,cAAc,EAAE;;MAEhB,mBAAmB,CAAC,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,SAAS,CAAC;;;;;;;+BAOnB,UAAU;;;;;;;;;MASnC,cAAc,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,EAAE,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,EAAC,CAAC,CAAE,IAAa,CAAC,CAAC,CAAC,SAAS,CAAC;MACpE,kBAAkB,EAAE;GACvB,CAAA;AACH,CAAC;AA3BD,wCA2BC;AAED,SAAgB,cAAc;IAC5B,OAAO,0CAA0C,CAAA;AACnD,CAAC;AAFD,wCAEC;AAED,SAAgB,mBAAmB,CAAC,WAAmB;IACrD,OAAO,IAAA,iBAAO,EAAA;;;;yBAIS,WAAW;;KAE/B,CAAA;AACL,CAAC;AARD,kDAQC;AAED,SAAgB,kBAAkB;IAChC,OAAO,IAAA,iBAAO,EAAA;;;;;;;;GAQb,CAAA;AACH,CAAC;AAVD,gDAUC;AAED,SAAgB,cAAc,CAAC,SAAkB,EAAE,IAAW;IAC5D,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,EAAE,CAAA;KACV;IAED,IAAI,WAAW,GAAuB,6BAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAA;IACpE,WAAW,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;IAEtD,IAAI,WAAW,GAAG,cAAc,CAAA;IAChC,IAAI,WAAW,KAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA,EAAE;QAC7B,WAAW,GAAG,GAAG,WAAW,MAAM,WAAW,gBAAgB,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,IAAI,CAAA;KAC5E;SAAM,IAAI,WAAW,EAAE;QACtB,WAAW,GAAG,GAAG,WAAW,MAAM,WAAW,cAAc,CAAA;KAC5D;SAAM;QACL,WAAW,GAAG,GAAG,WAAW,0BAA0B,CAAA;KACvD;IAED,OAAO,WAAW,CAAA;AACpB,CAAC;AAlBD,wCAkBC;AAED,SAAgB,qBAAqB,CAAC,MAAc;IAClD,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,KAAK,CAAA;KACb;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAEpD,iCAAiC;IACjC,OAAO,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;AACtD,CAAC;AATD,sDASC"}
|
package/lib/src/util/user.js
CHANGED
|
@@ -15,8 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
15
15
|
exports.getPackageUserInfo = exports.getUserInfo = void 0;
|
|
16
16
|
const path_1 = __importDefault(require("path"));
|
|
17
17
|
const xdg_basedir_1 = __importDefault(require("xdg-basedir"));
|
|
18
|
-
|
|
19
|
-
const git_user_info_1 = __importDefault(require("git-user-info"));
|
|
18
|
+
const git_user_info_1 = require("git-user-info");
|
|
20
19
|
const email_validator_1 = require("email-validator");
|
|
21
20
|
const files_1 = require("./files");
|
|
22
21
|
const request_1 = require("./request");
|
|
@@ -92,8 +91,10 @@ function getSanityUserInfo() {
|
|
|
92
91
|
});
|
|
93
92
|
}
|
|
94
93
|
function getGitUserInfo() {
|
|
95
|
-
|
|
96
|
-
|
|
94
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
95
|
+
const user = yield (0, git_user_info_1.getGitUserInfo)();
|
|
96
|
+
return user ? { name: user.name, email: user.email } : undefined;
|
|
97
|
+
});
|
|
97
98
|
}
|
|
98
99
|
function filterString(val) {
|
|
99
100
|
return (val || '').trim();
|
package/lib/src/util/user.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/util/user.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gDAAuB;AACvB,8DAAoC;AACpC,
|
|
1
|
+
{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/util/user.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gDAAuB;AACvB,8DAAoC;AACpC,iDAA+D;AAC/D,qDAAwD;AACxD,mCAAoC;AACpC,uCAAiC;AACjC,qCAA+B;AAS/B,SAAsB,WAAW,CAC/B,EAAC,uBAAuB,EAAE,KAAK,EAAgB,EAC/C,GAAiB;;;QAEjB,MAAM,QAAQ,GACZ,kBAAkB,CAAC,EAAC,MAAM,EAAE,MAAA,KAAK,CAAC,MAAM,mCAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,EAAC,CAAC;YACzD,CAAC,MAAM,iBAAiB,EAAE,CAAC;YAC1B,CAAC,MAAM,cAAc,EAAE,CAAsB,CAAA;QAChD,IAAI,uBAAuB,EAAE;YAC3B,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAA;SAC/B;QAED,OAAO,QAAQ,CAAA;;CAChB;AAbD,kCAaC;AAED,SAAgB,kBAAkB,CAAC,GAOlC;IACC,IAAI,MAAM,GAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,CAAA;IACxB,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,SAAS,CAAA;KACjB;IAED,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QACxC,OAAO,MAAM,CAAA;KACd;SAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAChC,OAAO,EAAC,IAAI,EAAE,MAAM,EAAC,CAAA;KACtB;IAED,MAAM,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAChE,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAClC,MAAM,KAAK,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAClE,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC7C,OAAO,EAAC,IAAI,EAAE,KAAK,EAAC,CAAA;AACtB,CAAC;AAxBD,gDAwBC;AAED,SAAe,aAAa,CAAC,QAAe;;QAC1C,MAAM,IAAI,GAAG,MAAM,IAAA,eAAM,EAAC,aAAa,EAAE;YACvC,MAAM,EAAE,YAAY;YACpB,OAAO,EAAE,QAAQ,IAAI,QAAQ,CAAC,IAAI;YAClC,QAAQ,EAAE,cAAc;SACzB,CAAC,CAAA;QAEF,MAAM,KAAK,GAAG,MAAM,IAAA,eAAM,EAAC,cAAc,EAAE;YACzC,MAAM,EAAE,YAAY;YACpB,OAAO,EAAE,QAAQ,IAAI,QAAQ,CAAC,KAAK;YACnC,QAAQ,EAAE,iBAAiB;SAC5B,CAAC,CAAA;QAEF,OAAO,EAAC,IAAI,EAAE,KAAK,EAAC,CAAA;IACtB,CAAC;CAAA;AAED,SAAe,iBAAiB;;;QAC9B,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,IAAA,oBAAY,EAC7B,cAAI,CAAC,IAAI,CAAC,MAAA,qBAAU,CAAC,MAAM,mCAAI,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,CAC5D,CAAA;YACD,MAAM,KAAK,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAA;YAE7B,IAAI,CAAC,KAAK,EAAE;gBACV,OAAO,SAAS,CAAA;aACjB;YAED,MAAM,IAAI,GAAG,MAAM,IAAA,iBAAO,EAAC;gBACzB,GAAG,EAAE,mCAAmC;gBACxC,OAAO,EAAE,EAAC,aAAa,EAAE,UAAU,KAAK,EAAE,EAAC;aAC5C,CAAC,CAAA;YAEF,IAAI,CAAC,IAAI,EAAE;gBACT,OAAO,SAAS,CAAA;aACjB;YAED,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,IAAI,CAAA;YAC1B,OAAO,EAAC,IAAI,EAAE,KAAK,EAAC,CAAA;SACrB;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,SAAS,CAAA;SACjB;;CACF;AAED,SAAe,cAAc;;QAC3B,MAAM,IAAI,GAAG,MAAM,IAAA,8BAAe,GAAE,CAAA;QACpC,OAAO,IAAI,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAChE,CAAC;CAAA;AAED,SAAS,YAAY,CAAC,GAAW;IAC/B,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;AAC3B,CAAC;AAED,SAAS,cAAc,CAAC,KAAa;IACnC,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAA;AAC7C,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,IAAI,CAAA;KACZ;IAED,OAAO,IAAA,0BAAY,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,uCAAuC,CAAA;AAC7E,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sanity/plugin-kit",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.14",
|
|
4
4
|
"description": "Enhanced Sanity.io plugin development experience",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"sanity-io",
|
|
@@ -65,47 +65,47 @@
|
|
|
65
65
|
"email-validator": "^2.0.4",
|
|
66
66
|
"execa": "^5.1.1",
|
|
67
67
|
"find-babel-config": "^1.2.0",
|
|
68
|
-
"get-it": "^
|
|
68
|
+
"get-it": "^7.0.2",
|
|
69
69
|
"get-latest-version": "^4.0.0",
|
|
70
70
|
"git-remote-origin-url": "^3.1.0",
|
|
71
|
-
"git-user-info": "^
|
|
71
|
+
"git-user-info": "^2.0.3",
|
|
72
72
|
"github-url-to-object": "^4.0.6",
|
|
73
73
|
"inquirer": "^8.2.5",
|
|
74
74
|
"meow": "^9.0.0",
|
|
75
75
|
"nodemon": "^2.0.20",
|
|
76
|
-
"npm-packlist": "^
|
|
76
|
+
"npm-packlist": "^7.0.2",
|
|
77
77
|
"npm-run-path": "^4.0.1",
|
|
78
78
|
"outdent": "^0.8.0",
|
|
79
79
|
"p-any": "^3.0.0",
|
|
80
80
|
"p-props": "^4.0.0",
|
|
81
|
-
"postcss": "^8.4.
|
|
81
|
+
"postcss": "^8.4.19",
|
|
82
82
|
"rimraf": "^3.0.2",
|
|
83
83
|
"semver": "^7.3.8",
|
|
84
84
|
"spdx-license-ids": "^3.0.12",
|
|
85
|
-
"validate-npm-package-name": "^
|
|
85
|
+
"validate-npm-package-name": "^5.0.0",
|
|
86
86
|
"xdg-basedir": "^4.0.0",
|
|
87
87
|
"yalc": "^1.0.0-pre.53"
|
|
88
88
|
},
|
|
89
89
|
"devDependencies": {
|
|
90
90
|
"@commitlint/cli": "^17.2.0",
|
|
91
91
|
"@commitlint/config-conventional": "^17.2.0",
|
|
92
|
-
"@sanity/pkg-utils": "^1.
|
|
92
|
+
"@sanity/pkg-utils": "^1.18.0",
|
|
93
93
|
"@sanity/semantic-release-preset": "^2.0.2",
|
|
94
|
-
"@types/eslint": "^8.4.
|
|
94
|
+
"@types/eslint": "^8.4.10",
|
|
95
95
|
"@types/fs-extra": "^9.0.13",
|
|
96
|
-
"@types/inquirer": "^
|
|
97
|
-
"@types/node": "^
|
|
96
|
+
"@types/inquirer": "^9.0.3",
|
|
97
|
+
"@types/node": "^18.11.9",
|
|
98
98
|
"@types/nodemon": "^1.19.2",
|
|
99
99
|
"@types/tap": "^15.0.7",
|
|
100
|
-
"@typescript-eslint/eslint-plugin": "^5.
|
|
101
|
-
"@typescript-eslint/parser": "^5.
|
|
102
|
-
"eslint": "^8.
|
|
100
|
+
"@typescript-eslint/eslint-plugin": "^5.43.0",
|
|
101
|
+
"@typescript-eslint/parser": "^5.43.0",
|
|
102
|
+
"eslint": "^8.27.0",
|
|
103
103
|
"eslint-config-prettier": "^8.5.0",
|
|
104
104
|
"eslint-config-sanity": "^6.0.0",
|
|
105
105
|
"eslint-plugin-prettier": "^4.2.1",
|
|
106
106
|
"eslint-plugin-react-hooks": "^4.6.0",
|
|
107
107
|
"fs-extra": "^10.1.0",
|
|
108
|
-
"husky": "^8.0.
|
|
108
|
+
"husky": "^8.0.2",
|
|
109
109
|
"json5": "^2.2.1",
|
|
110
110
|
"lint-staged": "^13.0.3",
|
|
111
111
|
"prettier": "^2.7.1",
|
|
@@ -113,8 +113,8 @@
|
|
|
113
113
|
"readdirp": "^3.6.0",
|
|
114
114
|
"rimraf": "^3.0.2",
|
|
115
115
|
"sanity": "3.0.0-rc.2",
|
|
116
|
-
"sinon": "^14.0.
|
|
117
|
-
"tap": "^16.3.
|
|
116
|
+
"sinon": "^14.0.2",
|
|
117
|
+
"tap": "^16.3.1",
|
|
118
118
|
"ts-node": "^10.9.1",
|
|
119
119
|
"typescript": "^4.8.4"
|
|
120
120
|
},
|
|
@@ -72,7 +72,15 @@ export async function linkWatch({basePath}: {basePath: string}) {
|
|
|
72
72
|
outdent`
|
|
73
73
|
Watching ${watch.folder} for changes to files with extensions: ${watch.extensions}
|
|
74
74
|
|
|
75
|
-
To test this package in another
|
|
75
|
+
To test this package in Sanity Studio or another package, in a separate shell run:
|
|
76
|
+
cd /path/to/sanity/studio-or-package
|
|
77
|
+
|
|
78
|
+
Then, run one of the below commands, based on the package manager used in studio-or-package:
|
|
79
|
+
|
|
80
|
+
## yarn
|
|
81
|
+
${chalk.greenBright(`yalc add --link ${pkg.name} && yarn install`)}
|
|
82
|
+
|
|
83
|
+
## npm
|
|
76
84
|
${chalk.greenBright(`npx yalc add ${pkg.name} && npx yalc link ${pkg.name} && npm install`)}
|
|
77
85
|
`.trimStart()
|
|
78
86
|
)
|
|
@@ -15,7 +15,12 @@ import path from 'path'
|
|
|
15
15
|
import {readFile, writeFile} from '../util/files'
|
|
16
16
|
import {errorToUndefined} from '../util/errorToUndefined'
|
|
17
17
|
import {PackageJson} from '../actions/verify/types'
|
|
18
|
-
import {
|
|
18
|
+
import {
|
|
19
|
+
developTestSnippet,
|
|
20
|
+
getLicenseText,
|
|
21
|
+
installationSnippet,
|
|
22
|
+
v3BannerNotice,
|
|
23
|
+
} from '../util/readme'
|
|
19
24
|
import {getUserInfo} from '../util/user'
|
|
20
25
|
|
|
21
26
|
export const semverWorkflowPreset: Preset = {
|
|
@@ -95,14 +100,6 @@ async function readmeSnippets(options: InjectOptions) {
|
|
|
95
100
|
|
|
96
101
|
const bestEffortUrl = readmeBaseurl(pkg)
|
|
97
102
|
|
|
98
|
-
const v3Banner = outdent`
|
|
99
|
-
> **NOTE**
|
|
100
|
-
>
|
|
101
|
-
> This is the **Sanity Studio v3 version** of ${pkg.name}.
|
|
102
|
-
>
|
|
103
|
-
> For the v2 version, please refer to the [v2-branch](${bestEffortUrl}).
|
|
104
|
-
`
|
|
105
|
-
|
|
106
103
|
const install = installationSnippet(pkg.name ?? 'unknown')
|
|
107
104
|
|
|
108
105
|
const usage = outdent`
|
|
@@ -121,7 +118,7 @@ async function readmeSnippets(options: InjectOptions) {
|
|
|
121
118
|
`
|
|
122
119
|
|
|
123
120
|
return {
|
|
124
|
-
v3Banner,
|
|
121
|
+
v3Banner: v3BannerNotice(),
|
|
125
122
|
install,
|
|
126
123
|
usage,
|
|
127
124
|
license,
|
package/src/util/readme.ts
CHANGED
|
@@ -10,6 +10,8 @@ export function generateReadme(data: PackageData) {
|
|
|
10
10
|
return outdent`
|
|
11
11
|
# ${pluginName}
|
|
12
12
|
|
|
13
|
+
${v3BannerNotice()}
|
|
14
|
+
|
|
13
15
|
${installationSnippet(pluginName ?? 'unknown')}
|
|
14
16
|
|
|
15
17
|
## Usage
|
|
@@ -31,6 +33,10 @@ export function generateReadme(data: PackageData) {
|
|
|
31
33
|
`
|
|
32
34
|
}
|
|
33
35
|
|
|
36
|
+
export function v3BannerNotice() {
|
|
37
|
+
return `> This is a **Sanity Studio v3** plugin.`
|
|
38
|
+
}
|
|
39
|
+
|
|
34
40
|
export function installationSnippet(packageName: string) {
|
|
35
41
|
return outdent`
|
|
36
42
|
## Installation
|
package/src/util/user.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import path from 'path'
|
|
2
2
|
import xdgBasedir from 'xdg-basedir'
|
|
3
|
-
|
|
4
|
-
import gitUserInfo from 'git-user-info'
|
|
3
|
+
import {getGitUserInfo as _getGitUserInfo} from 'git-user-info'
|
|
5
4
|
import {validate as isValidEmail} from 'email-validator'
|
|
6
5
|
import {readJsonFile} from './files'
|
|
7
6
|
import {request} from './request'
|
|
@@ -98,8 +97,8 @@ async function getSanityUserInfo(): Promise<User | undefined> {
|
|
|
98
97
|
}
|
|
99
98
|
}
|
|
100
99
|
|
|
101
|
-
function getGitUserInfo(): User | undefined {
|
|
102
|
-
const user =
|
|
100
|
+
async function getGitUserInfo(): Promise<User | undefined> {
|
|
101
|
+
const user = await _getGitUserInfo()
|
|
103
102
|
return user ? {name: user.name, email: user.email} : undefined
|
|
104
103
|
}
|
|
105
104
|
|