@sanity/plugin-kit 0.0.1-studio-v3.1

package/lib/package.json

@@ -0,0 +1,127 @@
+{
+    "name": "@sanity/plugin-kit",
+    "version": "0.0.1-studio-v3.1",
+    "description": "Enhanced Sanity.io plugin development experience",
+    "scripts": {
+        "clean": "rimraf lib",
+        "prebuild": "npm run clean",
+        "build": "tsc",
+        "postbuild": "node executable-index.js",
+        "watch": "tsc --watch",
+        "test": "tap",
+        "prepare": "husky install",
+        "commit": "git-cz",
+        "lint": "eslint .",
+        "compile": "tsc --noEmit",
+        "format": "prettier src -w",
+        "semantic-release": "semantic-release",
+        "prepublishOnly": "npm run build"
+    },
+    "binname": "sanity-plugin",
+    "source": "./src/index.ts",
+    "types": "./lib/src/index.d.ts",
+    "bin": "lib/src/index.js",
+    "main": "./lib/src/index.js",
+    "files": [
+        "v2-incompatible.js",
+        "src",
+        "lib",
+        "assets"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+ssh://git@github.com/rexxars/sanipack.git"
+    },
+    "engines": {
+        "node": ">=14.0.0"
+    },
+    "keywords": [
+        "sanity-io",
+        "sanity",
+        "plugin",
+        "development",
+        "babel",
+        "typescript",
+        "bootstrap"
+    ],
+    "author": "Sanity.io <hello@sanity.io>",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/rexxars/sanipack/issues"
+    },
+    "homepage": "https://github.com/rexxars/sanipack#readme",
+    "dependencies": {
+        "@rexxars/choosealicense-list": "^1.1.2",
+        "chalk": "^4.1.2",
+        "concurrently": "^7.1.0",
+        "discover-path": "^1.0.0",
+        "email-validator": "^2.0.4",
+        "execa": "^5.1.1",
+        "find-babel-config": "^1.2.0",
+        "get-it": "^5.0.5",
+        "get-latest-version": "^2.0.0",
+        "git-remote-origin-url": "^3.1.0",
+        "git-user-info": "^1.0.1",
+        "github-url-to-object": "^4.0.6",
+        "inquirer": "^8.2.0",
+        "meow": "^9.0.0",
+        "nodemon": "^2.0.15",
+        "npm-packlist": "^3.0.0",
+        "npm-run-path": "^4.0.1",
+        "outdent": "^0.8.0",
+        "p-any": "^3.0.0",
+        "p-props": "^4.0.0",
+        "postcss": "^8.3.9",
+        "rimraf": "^3.0.2",
+        "semver": "^7.3.5",
+        "spdx-license-ids": "^3.0.10",
+        "validate-npm-package-name": "^3.0.0",
+        "xdg-basedir": "^4.0.0",
+        "yalc": "^1.0.0-pre.53"
+    },
+    "peerDependencies": {
+        "eslint": ">=8.0.0"
+    },
+    "devDependencies": {
+        "@commitlint/cli": "^16.2.3",
+        "@commitlint/config-conventional": "^16.2.1",
+        "@parcel/packager-ts": "^2.6.0",
+        "@parcel/transformer-typescript-types": "^2.6.0",
+        "@types/eslint": "^8.4.3",
+        "@types/inquirer": "^8.2.1",
+        "@types/node": "^17.0.40",
+        "@types/nodemon": "^1.19.1",
+        "@types/tap": "^15.0.7",
+        "@typescript-eslint/eslint-plugin": "^5.20.0",
+        "@typescript-eslint/parser": "^5.20.0",
+        "eslint": "^8.15.0",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-config-sanity": "^5.1.0",
+        "eslint-plugin-prettier": "^4.0.0",
+        "husky": "^7.0.4",
+        "json5": "^2.2.1",
+        "lint-staged": "^12.4.0",
+        "parcel": "^2.6.0",
+        "prettier": "^2.6.2",
+        "readdirp": "^3.6.0",
+        "rimraf": "^3.0.2",
+        "semantic-release": "^19.0.2",
+        "sanity": "^2.30.1-purple-unicorn.940",
+        "sinon": "^14.0.0",
+        "tap": "^16.2.0",
+        "ts-node": "^10.8.0",
+        "typescript": "^4.7.2"
+    },
+    "tap": {
+        "jobs": 2,
+        "browser": false,
+        "timeout": 120,
+        "reporter": "spec",
+        "check-coverage": false,
+        "coverage-report": [
+            "html"
+        ],
+        "test-ignore": "^lib/.*|.*ignore.*|.*run-test-command.*|.*fixture.utils.*",
+        "ts": true
+    }
+}

package/lib/src/actions/init.d.ts

@@ -0,0 +1,65 @@
+import { TypedFlags } from 'meow';
+export declare const initFlags: {
+    readonly scripts: {
+        readonly type: "boolean";
+        readonly default: true;
+    };
+    readonly eslint: {
+        readonly type: "boolean";
+        readonly default: true;
+    };
+    readonly typescript: {
+        readonly type: "boolean";
+        readonly default: true;
+    };
+    readonly prettier: {
+        readonly type: "boolean";
+        readonly default: true;
+    };
+    readonly license: {
+        readonly type: "string";
+    };
+    readonly editorconfig: {
+        readonly type: "boolean";
+        readonly default: true;
+    };
+    readonly gitignore: {
+        readonly type: "boolean";
+        readonly default: true;
+    };
+    readonly force: {
+        readonly type: "boolean";
+        readonly default: false;
+    };
+    readonly install: {
+        readonly type: "boolean";
+        readonly default: true;
+    };
+    readonly name: {
+        readonly type: "string";
+    };
+    readonly author: {
+        readonly type: "string";
+    };
+    readonly repo: {
+        readonly type: "string";
+    };
+    readonly debug: {
+        readonly default: false;
+        readonly type: "boolean";
+    };
+    readonly silent: {
+        readonly type: "boolean";
+        readonly default: false;
+    };
+    readonly verbose: {
+        readonly type: "boolean";
+        readonly default: false;
+    };
+};
+export declare type InitFlags = TypedFlags<typeof initFlags>;
+export interface InitOptions {
+    basePath: string;
+    flags: InitFlags;
+}
+export declare function init(options: InitOptions): Promise<void>;

package/lib/src/actions/init.js

@@ -0,0 +1,83 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = exports.initFlags = void 0;
+const path_1 = __importDefault(require("path"));
+const splat_1 = require("./splat");
+const files_1 = require("../util/files");
+const resolveLatestVersions_1 = require("../npm/resolveLatestVersions");
+const sharedFlags_1 = __importDefault(require("../sharedFlags"));
+const package_1 = require("../npm/package");
+const default_source_1 = require("../configs/default-source");
+const constants_1 = require("../constants");
+exports.initFlags = Object.assign(Object.assign({}, sharedFlags_1.default), { scripts: {
+        type: 'boolean',
+        default: true,
+    }, eslint: {
+        type: 'boolean',
+        default: true,
+    }, typescript: {
+        type: 'boolean',
+        default: true,
+    }, prettier: {
+        type: 'boolean',
+        default: true,
+    }, license: {
+        type: 'string',
+    }, editorconfig: {
+        type: 'boolean',
+        default: true,
+    }, gitignore: {
+        type: 'boolean',
+        default: true,
+    }, force: {
+        type: 'boolean',
+        default: false,
+    }, install: {
+        type: 'boolean',
+        default: true,
+    }, name: {
+        type: 'string',
+    }, author: {
+        type: 'string',
+    }, repo: {
+        type: 'string',
+    } });
+const defaultDependencies = [constants_1.incompatiblePluginPackage];
+// purple-unicorn as version in devDependencies will install 2.29.5, so must be explicit
+// using ^2.29.5-purple-unicorn.856 is not safe either
+const defaultDevDependencies = { react: '^17.0.0 || ^18.0.0', sanity: '2.29.5-purple-unicorn.856' };
+const defaultPeerDependencies = { react: '^17.0.0 || ^18.0.0', sanity: 'purple-unicorn' };
+function init(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let dependencies = {};
+        let devDependencies = {};
+        let peerDependencies = {};
+        dependencies = Object.assign(Object.assign({}, dependencies), (yield (0, resolveLatestVersions_1.resolveLatestVersions)(defaultDependencies)));
+        devDependencies = Object.assign(Object.assign(Object.assign({}, devDependencies), defaultDevDependencies), (yield (0, resolveLatestVersions_1.resolveLatestVersions)(['rimraf'])));
+        peerDependencies = Object.assign(Object.assign({}, peerDependencies), defaultPeerDependencies);
+        yield (0, splat_1.splat)(Object.assign(Object.assign({}, options), { requireUserConfirmation: !options.flags.force, dependencies,
+            devDependencies,
+            peerDependencies, validate: false }));
+        const packageJson = yield (0, package_1.getPackage)({ basePath: options.basePath, validate: false });
+        const typescript = options.flags.typescript;
+        const source = typescript ? (0, default_source_1.defaultSourceTs)(packageJson) : (0, default_source_1.defaultSourceJs)(packageJson);
+        const filename = typescript ? 'index.ts' : 'index.js';
+        const srcDir = path_1.default.resolve(options.basePath, 'src');
+        yield (0, files_1.ensureDir)(srcDir);
+        yield (0, files_1.writeFile)(path_1.default.join(srcDir, filename), source, { encoding: 'utf8' });
+    });
+}
+exports.init = init;
+//# sourceMappingURL=init.js.map

package/lib/src/actions/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/actions/init.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gDAAuB;AACvB,mCAA6B;AAC7B,yCAAkD;AAClD,wEAAkE;AAClE,iEAAwC;AAExC,4CAAyC;AACzC,8DAA0E;AAC1E,4CAAsD;AAEzC,QAAA,SAAS,GAAG,gCACpB,qBAAW,KACd,OAAO,EAAE;QACP,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd,EACD,MAAM,EAAE;QACN,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd,EACD,UAAU,EAAE;QACV,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd,EACD,QAAQ,EAAE;QACR,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd,EACD,OAAO,EAAE;QACP,IAAI,EAAE,QAAQ;KACf,EACD,YAAY,EAAE;QACZ,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd,EACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd,EACD,KAAK,EAAE;QACL,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;KACf,EACD,OAAO,EAAE;QACP,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd,EACD,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;KACf,EACD,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;KACf,EACD,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;KACf,GACO,CAAA;AAIV,MAAM,mBAAmB,GAAG,CAAC,qCAAyB,CAAC,CAAA;AACvD,wFAAwF;AACxF,sDAAsD;AACtD,MAAM,sBAAsB,GAAG,EAAC,KAAK,EAAE,oBAAoB,EAAE,MAAM,EAAE,2BAA2B,EAAC,CAAA;AACjG,MAAM,uBAAuB,GAAG,EAAC,KAAK,EAAE,oBAAoB,EAAE,MAAM,EAAE,gBAAgB,EAAC,CAAA;AAOvF,SAAsB,IAAI,CAAC,OAAoB;;QAC7C,IAAI,YAAY,GAAG,EAAE,CAAA;QACrB,IAAI,eAAe,GAAG,EAAE,CAAA;QACxB,IAAI,gBAAgB,GAAG,EAAE,CAAA;QAEzB,YAAY,mCAAO,YAAY,GAAK,CAAC,MAAM,IAAA,6CAAqB,EAAC,mBAAmB,CAAC,CAAC,CAAC,CAAA;QACvF,eAAe,iDACV,eAAe,GACf,sBAAsB,GACtB,CAAC,MAAM,IAAA,6CAAqB,EAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAC7C,CAAA;QACD,gBAAgB,mCACX,gBAAgB,GAChB,uBAAuB,CAC3B,CAAA;QAED,MAAM,IAAA,aAAK,kCACN,OAAO,KACV,uBAAuB,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAC7C,YAAY;YACZ,eAAe;YACf,gBAAgB,EAChB,QAAQ,EAAE,KAAK,IACf,CAAA;QAEF,MAAM,WAAW,GAAG,MAAM,IAAA,oBAAU,EAAC,EAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAA;QACnF,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAA;QAC3C,MAAM,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,IAAA,gCAAe,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAA,gCAAe,EAAC,WAAW,CAAC,CAAA;QACvF,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAA;QACrD,MAAM,MAAM,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;QACpD,MAAM,IAAA,iBAAS,EAAC,MAAM,CAAC,CAAA;QACvB,MAAM,IAAA,iBAAS,EAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;IAC1E,CAAC;CAAA;AAhCD,oBAgCC"}

package/lib/src/actions/link-watch.d.ts

@@ -0,0 +1,3 @@
+export declare function linkWatch({ basePath }: {
+    basePath: string;
+}): Promise<void>;

package/lib/src/actions/link-watch.js

@@ -0,0 +1,69 @@
+"use strict";
+/*
+ISC License (ISC)
+Copyright 2019 Johan Otterud
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
+provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH
+THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.linkWatch = void 0;
+/*
+This code is a modified version of https://github.com/johot/yalc-watch,
+and the ISC License has been added for this file only, in accordance with the package.json license field in that package
+*/
+const nodemon_1 = __importDefault(require("nodemon"));
+const concurrently_1 = __importDefault(require("concurrently"));
+const chalk_1 = __importDefault(require("chalk"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const log_1 = __importDefault(require("../util/log"));
+const package_1 = require("../npm/package");
+function linkWatch({ basePath }) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const packageJson = JSON.parse(fs_1.default.readFileSync(path_1.default.join(process.cwd(), 'package.json'), 'utf8'));
+        const watch = Object.assign({ folder: 'lib', command: 'npm run watch', extensions: 'js,png,svg,gif,jpeg,css' }, (_a = packageJson.sanityPlugin) === null || _a === void 0 ? void 0 : _a.linkWatch);
+        (0, nodemon_1.default)({
+            watch: [watch.folder],
+            ext: watch.extensions,
+            exec: 'yalc push --changed',
+            //delay: 1000
+        });
+        const pkg = yield (0, package_1.getPackage)({ basePath, validate: false });
+        nodemon_1.default
+            .on('start', function () {
+            log_1.default.info(`Watching ${watch.folder} for changes to files with extensions: ${watch.extensions}`);
+            log_1.default.info(`\nTo test this package in another repository directory run:`);
+            log_1.default.success(`yalc add --link \n${pkg.name} && yarn install`);
+        })
+            .on('quit', function () {
+            process.exit();
+        })
+            .on('restart', function (files) {
+            log_1.default.info('Found changes in files:', chalk_1.default.magentaBright(files));
+            log_1.default.info('Pushing new yalc package...');
+        });
+        (0, concurrently_1.default)([watch.command]);
+    });
+}
+exports.linkWatch = linkWatch;
+//# sourceMappingURL=link-watch.js.map

package/lib/src/actions/link-watch.js.map

@@ -0,0 +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;AAYzC,SAAsB,SAAS,CAAC,EAAC,QAAQ,EAAqB;;;QAC5D,MAAM,WAAW,GAAgB,IAAI,CAAC,KAAK,CACzC,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAClE,CAAA;QAED,MAAM,KAAK,mBACT,MAAM,EAAE,KAAK,EACb,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,yBAAyB,IAClC,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,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,EAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAA;QAEzD,iBAAO;aACJ,EAAE,CAAC,OAAO,EAAE;YACX,aAAG,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,MAAM,0CAA0C,KAAK,CAAC,UAAU,EAAE,CAAC,CAAA;YAC9F,aAAG,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAA;YACvE,aAAG,CAAC,OAAO,CAAC,qBAAqB,GAAG,CAAC,IAAI,kBAAkB,CAAC,CAAA;QAC9D,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;QAEJ,IAAA,sBAAY,EAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;;CAC9B;AApCD,8BAoCC"}

package/lib/src/actions/splat.d.ts

@@ -0,0 +1,26 @@
+import { InitFlags } from './init';
+import { PackageJson } from './verify/types';
+export interface SplatOptions {
+    basePath: string;
+    requireUserConfirmation?: boolean;
+    flags: InitFlags;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+    peerDependencies?: Record<string, string>;
+    validate?: boolean;
+}
+export interface PackageData {
+    user?: {
+        name?: string;
+        email?: string;
+    };
+    pluginName?: string;
+    license?: {
+        id: string;
+        text: string;
+    };
+    description?: string;
+    pkg?: PackageJson;
+    gitOrigin?: string;
+}
+export declare function splat(options: SplatOptions): Promise<void>;