@sanity/pkg-utils 2.2.17 → 2.3.0

package/dist/index.js

@@ -1,17 +1,20 @@
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8, _templateObject9, _templateObject10, _templateObject11, _templateObject12;
+function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(0); } return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
 import { register } from 'esbuild-register/dist/node';
-import path from 'path';
+import path, { relative, resolve, dirname } from 'path';
 import pkgUp from 'pkg-up';
 import findConfig from 'find-config';
 import fs$1, { statSync } from 'fs';
-import fs, { readFile, writeFile } from 'fs/promises';
+import fs, { writeFile, readFile, readdir, lstat } from 'fs/promises';
 import { z, ZodError } from 'zod';
 import chalk from 'chalk';
+import { mkdirp } from 'mkdirp';
+import prompts from 'prompts';
 import ts from 'typescript';
 import browserslist from 'browserslist';
 import { Observable, from, switchMap } from 'rxjs';
 import { rimraf } from 'rimraf';
 import { ExtractorConfig, Extractor } from '@microsoft/api-extractor';
-import { mkdirp } from 'mkdirp';
 import prettier from 'prettier';
 import { TSDocConfigFile } from '@microsoft/tsdoc-config';
 import { parse } from 'jsonc-parser';
@@ -29,6 +32,10 @@ import esbuild from 'rollup-plugin-esbuild';
 import esbuild$1 from 'esbuild';
 import treeify from 'treeify';
 import prettyBytes from 'pretty-bytes';
+import getLatestVersion from 'get-latest-version';
+import gitUrlParse from 'git-url-parse';
+import { outdent } from 'outdent';
+import parseGitConfig from 'parse-git-config';
 import { scan, startWith, distinctUntilChanged } from 'rxjs/operators';
 import globby from 'globby';
 import chokidar from 'chokidar';
@@ -345,6 +352,62 @@ function getPkgExtMap(options) {
   }
   return ret;
 }
+const promptsTypes = {
+  string: "text"
+};
+async function createFromTemplate(options) {
+  const {
+    cwd,
+    logger,
+    packagePath,
+    template: templateOrResolver
+  } = options;
+  const template = typeof templateOrResolver === "function" ? await templateOrResolver({
+    cwd,
+    logger,
+    packagePath
+  }) : templateOrResolver;
+  logger.log("create new package at", relative(cwd, packagePath));
+  const templateOptions = {};
+  for (const templateOption of template.options) {
+    const templateValidate = templateOption.validate;
+    const res = await prompts({
+      type: promptsTypes[templateOption.type],
+      name: templateOption.name,
+      message: templateOption.description,
+      validate: templateValidate ? prev => templateValidate(prev) : void 0,
+      initial: typeof templateOption.initial === "function" ? templateOption.initial(templateOptions) : templateOption.initial
+    }, {
+      onCancel: () => process.exit(0)
+    });
+    templateOptions[templateOption.name] = templateOption.parse ? templateOption.parse(res[templateOption.name]) : res[templateOption.name];
+  }
+  const features = {};
+  for (const templateFeature of template.features) {
+    const res = templateFeature.optional ? await prompts({
+      type: "confirm",
+      name: "confirm",
+      message: "use ".concat(templateFeature.name, "?"),
+      initial: templateFeature.initial
+    }, {
+      onCancel: () => process.exit(0)
+    }) : void 0;
+    features[templateFeature.name] = (res == null ? void 0 : res.confirm) || !templateFeature.optional;
+  }
+  const files = await template.getFiles(templateOptions, features);
+  files.sort((a, b) => {
+    return a.name.localeCompare(b.name);
+  });
+  for (const file of files) {
+    const filePath = resolve(packagePath, file.name);
+    await mkdirp(dirname(filePath));
+    await writeFile(filePath, file.contents.trim() + "\n");
+    logger.success("wrote ".concat(relative(cwd, filePath)));
+  }
+}
+function defineTemplateOption(option) {
+  return option;
+}
 async function loadTSConfig(options) {
   const {
     cwd,
@@ -1830,6 +1893,384 @@ async function check(options) {
     }
   }
 }
+async function isEmptyDirectory(dirPath) {
+  return (await readdir(dirPath)).length === 0;
+}
+const RE_NAME = /^(?:@(?:[a-z0-9-*~][a-z0-9-*._~]*)\/)?[a-z0-9-~][a-z0-9-._~]*$/i;
+const defaultTemplate = async _ref17 => {
+  let {
+    cwd,
+    logger,
+    packagePath
+  } = _ref17;
+  var _a, _b;
+  const gitConfig = await parseGitConfig({
+    cwd,
+    type: "global"
+  });
+  return {
+    options: [defineTemplateOption({
+      name: "repo",
+      type: "string",
+      description: "git url",
+      validate: v => {
+        if (!v) return true;
+        try {
+          gitUrlParse(v);
+          return true;
+        } catch (err) {
+          return "invalid git url";
+        }
+      },
+      parse: v => {
+        if (!v) return null;
+        const result = gitUrlParse(v);
+        return {
+          source: result.source,
+          owner: result.owner,
+          name: result.name
+        };
+      }
+    }), defineTemplateOption({
+      name: "pkgName",
+      type: "string",
+      description: "package name",
+      initial: options => {
+        var _a2;
+        return ((_a2 = options.repo) == null ? void 0 : _a2.name) || void 0;
+      },
+      validate: v => {
+        if (!v) return "package name is required";
+        const match = RE_NAME.exec(v);
+        if (!match) {
+          return "invalid package name";
+        }
+        return true;
+      },
+      parse: v => {
+        if (!v) {
+          throw new Error("package name is required");
+        }
+        const match = RE_NAME.exec(v);
+        if (!match) {
+          throw new Error("invalid package name");
+        }
+        const [scope, name] = v.split("/");
+        return {
+          scope,
+          name,
+          fullName: v
+        };
+      }
+    }), defineTemplateOption({
+      name: "description",
+      type: "string",
+      description: "package description"
+    }), defineTemplateOption({
+      name: "authorName",
+      type: "string",
+      description: "package author name",
+      initial: (_a = gitConfig == null ? void 0 : gitConfig.user) == null ? void 0 : _a.name
+    }), defineTemplateOption({
+      name: "authorEmail",
+      type: "string",
+      description: "package author email",
+      initial: (_b = gitConfig == null ? void 0 : gitConfig.user) == null ? void 0 : _b.email
+    }), defineTemplateOption({
+      name: "license",
+      type: "string",
+      description: "package license",
+      initial: "MIT",
+      validate: v => {
+        if (!v) return "license is required";
+        return true;
+      }
+    })],
+    features: [{
+      name: "eslint",
+      optional: true,
+      initial: true
+    }, {
+      name: "typescript",
+      optional: true,
+      initial: true
+    }],
+    async getFiles(options, features) {
+      var _filter$join, _options$description;
+      var _a2;
+      const {
+        pkgName,
+        repo
+      } = options;
+      const {
+        fullName: name
+      } = pkgName;
+      const author = (_filter$join = [options.authorName, options.authorEmail && "<".concat(options.authorEmail, ">")].filter(Boolean).join(" ")) !== null && _filter$join !== void 0 ? _filter$join : void 0;
+      const prettierConfig = {
+        bracketSpacing: false,
+        printWidth: 100,
+        semi: false,
+        singleQuote: true,
+        tabWidth: 2,
+        plugins: ["prettier-plugin-packagejson"],
+        overrides: [{
+          files: ["*.yml"],
+          options: {
+            singleQuote: false
+          }
+        }]
+      };
+      const pkgJson = {
+        name,
+        version: "0.0.0",
+        description: (_options$description = options.description) !== null && _options$description !== void 0 ? _options$description : void 0,
+        keywords: [],
+        license: options.license,
+        author,
+        type: "module",
+        exports: {
+          ".": {
+            types: void 0,
+            source: features.typescript ? "./src/index.ts" : "./src/index.js",
+            require: "./dist/index.cjs",
+            import: "./dist/index.js",
+            default: "./dist/index.js"
+          },
+          "./package.json": "./package.json"
+        },
+        main: "./dist/index.cjs",
+        module: "./dist/index.js",
+        source: features.typescript ? "./src/index.ts" : "./src/index.js",
+        files: ["dist", "src"],
+        scripts: {
+          build: "run-s clean pkg:build pkg:check",
+          clean: "rimraf dist",
+          format: "prettier --write --cache --ignore-unknown .",
+          "pkg:build": "pkg build --strict",
+          "pkg:check": "pkg check --strict"
+        },
+        prettier: prettierConfig,
+        "lint-staged": {
+          "*": ["prettier --write --cache --ignore-unknown"]
+        },
+        dependencies: {},
+        devDependencies: {
+          "@sanity/pkg-utils": "*",
+          "lint-staged": "*",
+          "npm-run-all": "*",
+          prettier: "*",
+          "prettier-plugin-packagejson": "*",
+          rimraf: "*"
+        },
+        engines: {
+          node: ">=18.0.0"
+        }
+      };
+      const files = [];
+      files.push({
+        name: ".editorconfig",
+        contents: outdent(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n        root = true\n\n        [*]\n        charset = utf-8\n        indent_style = space\n        indent_size = 2\n        end_of_line = lf\n        insert_final_newline = true\n        trim_trailing_whitespace = true\n        "])))
+      });
+      files.push({
+        name: ".gitignore",
+        contents: outdent(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n        *.local\n        *.log\n\n        .DS_Store\n        etc\n        dist\n        node_modules\n        "])))
+      });
+      files.push({
+        name: ".prettierignore",
+        contents: outdent(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n        /dist\n        /pnpm-lock.yaml\n        "])))
+      });
+      if (repo) {
+        pkgJson.repository = {
+          type: "git",
+          url: "git+ssh://git@".concat(repo.source, "/").concat(repo.owner, "/").concat(repo.name, ".git")
+        };
+        pkgJson.bugs = {
+          url: "https://".concat(repo.source, "/").concat(repo.owner, "/").concat(repo.name, "/issues")
+        };
+        pkgJson.homepage = "https://".concat(repo.source, "/").concat(repo.owner, "/").concat(repo.name, "#readme");
+      }
+      if (features.typescript) {
+        pkgJson.types = "./dist/index.d.ts";
+        const mainExport = (_a2 = pkgJson.exports) == null ? void 0 : _a2["."];
+        if (isRecord(mainExport)) {
+          mainExport.types = "./dist/index.d.ts";
+        }
+        pkgJson.scripts = {
+          ...pkgJson.scripts,
+          ["type:check"]: "tsc --build"
+        };
+        const devDependencies = pkgJson.devDependencies;
+        if (isRecord(devDependencies)) {
+          devDependencies["typescript"] = "*";
+        }
+      }
+      if (features.eslint) {
+        const eslintConfig = {
+          root: true,
+          env: {
+            browser: true,
+            es6: true,
+            node: true
+          },
+          extends: ["eslint:recommended", "plugin:prettier/recommended"],
+          parserOptions: {
+            ecmaVersion: 2020,
+            sourceType: "module"
+          },
+          plugins: ["import", "prettier"],
+          rules: {
+            "no-console": "error",
+            "no-shadow": "error",
+            "no-warning-comments": ["warn", {
+              location: "start",
+              terms: ["todo", "fixme"]
+            }]
+          }
+        };
+        files.push({
+          name: ".eslintignore",
+          contents: outdent(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["\n          /dist\n          "])))
+        });
+        pkgJson.scripts = {
+          ...pkgJson.scripts,
+          lint: features.typescript ? "eslint . --ext .cjs,.js,.ts,.tsx" : "eslint . --ext .cjs,.js"
+        };
+        pkgJson.devDependencies = {
+          ...pkgJson.devDependencies,
+          eslint: "*",
+          "eslint-config-prettier": "*",
+          "eslint-plugin-import": "*",
+          "eslint-plugin-prettier": "*"
+        };
+        if (features.typescript) {
+          pkgJson.devDependencies = {
+            ...pkgJson.devDependencies,
+            "@typescript-eslint/eslint-plugin": "*",
+            "@typescript-eslint/parser": "*"
+          };
+          const eslintConfigOverride = {
+            files: ["**/*.ts", "**/*.tsx"],
+            parser: "@typescript-eslint/parser",
+            parserOptions: {
+              project: ["./tsconfig.json"]
+            },
+            extends: ["eslint:recommended", "plugin:prettier/recommended", "plugin:@typescript-eslint/eslint-recommended", "plugin:@typescript-eslint/recommended"].filter(Boolean),
+            plugins: ["import", "@typescript-eslint", "prettier"].filter(Boolean),
+            rules: {
+              "@typescript-eslint/explicit-module-boundary-types": "error",
+              "@typescript-eslint/interface-name-prefix": "off",
+              "@typescript-eslint/member-delimiter-style": "off",
+              "@typescript-eslint/no-empty-interface": "off"
+            }
+          };
+          eslintConfig.overrides = [eslintConfigOverride];
+        }
+        files.push({
+          name: ".eslintrc.cjs",
+          contents: format(resolve(packagePath, ".eslintrc.cjs"), outdent(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["\n            'use strict'\n\n            /** @type import('eslint').Linter.Config */\n            module.exports = ", "\n            "])), JSON.stringify(eslintConfig, null, 2)), prettierConfig)
+        });
+      }
+      if (features.typescript) {
+        files.push({
+          name: "tsconfig.settings.json",
+          contents: format(resolve(packagePath, "tsconfig.settings.json"), outdent(_templateObject6 || (_templateObject6 = _taggedTemplateLiteral(["\n            {\n              \"compilerOptions\": {\n                \"module\": \"ES2020\",\n                \"target\": \"ES2020\",\n                \"declaration\": true,\n                \"declarationMap\": true,\n                \"sourceMap\": true,\n\n                // Strict type-checking\n                \"strict\": true,\n                \"noImplicitAny\": true,\n                \"strictNullChecks\": true,\n                \"strictFunctionTypes\": true,\n                \"strictPropertyInitialization\": true,\n                \"noImplicitThis\": true,\n                \"alwaysStrict\": true,\n\n                // Additional checks\n                \"noUnusedLocals\": true,\n                \"noUnusedParameters\": true,\n                \"noImplicitReturns\": true,\n                \"noFallthroughCasesInSwitch\": true,\n                \"skipLibCheck\": true,\n\n                // Module resolution\n                \"moduleResolution\": \"node\",\n                \"allowSyntheticDefaultImports\": true,\n                \"esModuleInterop\": true\n              }\n            }\n            "]))), prettierConfig)
+        });
+        files.push({
+          name: "tsconfig.dist.json",
+          contents: format(resolve(packagePath, "tsconfig.dist.json"), outdent(_templateObject7 || (_templateObject7 = _taggedTemplateLiteral(["\n            {\n              \"extends\": \"./tsconfig.settings\",\n              \"include\": [\"./src\"],\n              \"compilerOptions\": {\n                \"rootDir\": \".\",\n                \"outDir\": \"./dist\",\n                \"emitDeclarationOnly\": true,\n                \"resolveJsonModule\": true\n              }\n            }\n            "]))), prettierConfig)
+        });
+        files.push({
+          name: "tsconfig.json",
+          contents: format(resolve(packagePath, "tsconfig.json"), outdent(_templateObject8 || (_templateObject8 = _taggedTemplateLiteral(["\n            {\n              \"extends\": \"./tsconfig.settings\",\n              \"include\": [\"./*.cjs\", \"./*.ts\", \"./package.config.ts\", \"./src\"],\n              \"compilerOptions\": {\n                \"rootDir\": \".\",\n                \"outDir\": \"./dist\",\n                \"noEmit\": true,\n                \"allowJs\": true,\n                \"resolveJsonModule\": true,\n              }\n            }\n            "]))), prettierConfig)
+        });
+      }
+      if (features.typescript) {
+        files.push({
+          name: "package.config.ts",
+          contents: format(resolve(packagePath, "package.config.ts"), outdent(_templateObject9 || (_templateObject9 = _taggedTemplateLiteral(["\n            import {defineConfig} from '@sanity/pkg-utils'\n\n            export default defineConfig({\n              extract: {\n                rules: {\n                  // do not require internal members to be prefixed with `_`\n                  'ae-internal-missing-underscore': 'off',\n                },\n              },\n\n              // the path to the tsconfig file for distributed builds\n              tsconfig: 'tsconfig.dist.json',\n            })\n            "], ["\n            import {defineConfig} from '@sanity/pkg-utils'\n\n            export default defineConfig({\n              extract: {\n                rules: {\n                  // do not require internal members to be prefixed with \\`_\\`\n                  'ae-internal-missing-underscore': 'off',\n                },\n              },\n\n              // the path to the tsconfig file for distributed builds\n              tsconfig: 'tsconfig.dist.json',\n            })\n            "]))), prettierConfig)
+        });
+        files.push({
+          name: "src/index.ts",
+          contents: format(resolve(packagePath, "src/index.ts"), outdent(_templateObject10 || (_templateObject10 = _taggedTemplateLiteral(["\n            /** @public */\n            export function main(): void {\n              //\n            }\n            "]))), prettierConfig)
+        });
+      } else {
+        files.push({
+          name: "package.config.js",
+          contents: format(resolve(packagePath, "package.config.js"), outdent(_templateObject11 || (_templateObject11 = _taggedTemplateLiteral(["\n            import {defineConfig} from '@sanity/pkg-utils'\n\n            export default defineConfig({\n              extract: {\n                rules: {\n                  // do not require internal members to be prefixed with `_`\n                  'ae-internal-missing-underscore': 'off',\n                },\n              },\n            })\n            "], ["\n            import {defineConfig} from '@sanity/pkg-utils'\n\n            export default defineConfig({\n              extract: {\n                rules: {\n                  // do not require internal members to be prefixed with \\`_\\`\n                  'ae-internal-missing-underscore': 'off',\n                },\n              },\n            })\n            "]))), prettierConfig)
+        });
+        files.push({
+          name: "src/index.js",
+          contents: format(resolve(packagePath, "src/index.js"), outdent(_templateObject12 || (_templateObject12 = _taggedTemplateLiteral(["\n            /** @public */\n            export function main() {\n              //\n            }\n            "]))), prettierConfig)
+        });
+      }
+      try {
+        var _pkgJson$dependencies;
+        pkgJson.dependencies = await resolveLatestDeps((_pkgJson$dependencies = pkgJson.dependencies) !== null && _pkgJson$dependencies !== void 0 ? _pkgJson$dependencies : {});
+      } catch (error) {
+        logger.warn(error instanceof Error ? error.message : error);
+      }
+      try {
+        var _pkgJson$devDependenc;
+        pkgJson.devDependencies = await resolveLatestDeps((_pkgJson$devDependenc = pkgJson.devDependencies) !== null && _pkgJson$devDependenc !== void 0 ? _pkgJson$devDependenc : {});
+      } catch (error) {
+        logger.warn(error instanceof Error ? error.message : error);
+      }
+      files.push({
+        name: "package.json",
+        contents: format(resolve(packagePath, "package.json"), JSON.stringify(pkgJson, null, 2), prettierConfig)
+      });
+      return files;
+    }
+  };
+};
+function format(filepath, input, prettierOptions) {
+  return prettier.format(input, {
+    ...prettierOptions,
+    filepath
+  });
+}
+async function resolveLatestDeps(deps) {
+  const depsEntries = Object.entries(deps);
+  const latestDeps = {};
+  for (const entry of depsEntries) {
+    const [name, version] = entry;
+    const latestVersion = await getLatestVersion(name, version);
+    latestDeps[name] = latestVersion ? "^".concat(latestVersion) : version;
+  }
+  return latestDeps;
+}
+async function init(options) {
+  if (!options.cwd) {
+    throw new Error("Missing required option: cwd");
+  }
+  if (!options.path) {
+    throw new Error("Missing required option: path");
+  }
+  const logger = createLogger();
+  const packagePath = resolve(options.cwd, options.path);
+  await ensurePackagePath(packagePath);
+  await createFromTemplate({
+    cwd: options.cwd,
+    logger,
+    template: defaultTemplate,
+    packagePath
+  });
+}
+async function ensurePackagePath(packagePath) {
+  const exists = fileExists(packagePath);
+  if (!exists) {
+    await mkdirp(packagePath);
+    return;
+  }
+  const dir = (await lstat(packagePath)).isDirectory();
+  if (!dir) {
+    throw new Error("the package path is a file, not a directory");
+  }
+  const empty = await isEmptyDirectory(packagePath);
+  if (!empty) {
+    throw new Error("the package directory is not empty");
+  }
+}
 function resolveWatchTasks(ctx) {
   var _a, _b, _c, _d, _e;
   const {
@@ -1839,8 +2280,8 @@ function resolveWatchTasks(ctx) {
     target
   } = ctx;
   const tasks = [];
-  const exports = Object.entries(ctx.exports || {}).map(_ref17 => {
-    let [_path, exp] = _ref17;
+  const exports = Object.entries(ctx.exports || {}).map(_ref18 => {
+    let [_path, exp] = _ref18;
     return {
       _path,
       ...exp
@@ -1985,7 +2426,7 @@ async function watch(options) {
     logger
   });
   const ctx$ = configFiles$.pipe(switchMap(async configFiles => {
-    var _ref18;
+    var _ref19;
     const files = configFiles.map(f => path.relative(cwd, f));
     const packageJsonPath = files.find(f => f === "package.json");
     if (!packageJsonPath) {
@@ -1999,7 +2440,7 @@ async function watch(options) {
       cwd
     });
     const extMap = getPkgExtMap({
-      legacyExports: (_ref18 = config == null ? void 0 : config.legacyExports) !== null && _ref18 !== void 0 ? _ref18 : false
+      legacyExports: (_ref19 = config == null ? void 0 : config.legacyExports) !== null && _ref19 !== void 0 ? _ref19 : false
     });
     const tsconfig = tsconfigOption || (config == null ? void 0 : config.tsconfig) || "tsconfig.json";
     return resolveBuildContext({
@@ -2034,5 +2475,5 @@ async function watch(options) {
     }
   });
 }
-export { DEFAULT_BROWSERSLIST_QUERY, DEFAULT_PKG_EXT_MAP, build, buildTaskHandlers, check, createLogger, defineConfig, dtsTask, dtsWatchTask, getExtractMessagesConfig, getPkgExtMap, isRecord, loadConfig, loadPkg, loadPkgWithReporting, loadTSConfig, parseExports, resolveBuildTasks, resolveConfigProperty, rollupTask, rollupWatchTask, watch, watchTaskHandlers };
+export { DEFAULT_BROWSERSLIST_QUERY, DEFAULT_PKG_EXT_MAP, build, buildTaskHandlers, check, createFromTemplate, createLogger, defineConfig, defineTemplateOption, dtsTask, dtsWatchTask, getExtractMessagesConfig, getPkgExtMap, init, isRecord, loadConfig, loadPkg, loadPkgWithReporting, loadTSConfig, parseExports, resolveBuildTasks, resolveConfigProperty, rollupTask, rollupWatchTask, watch, watchTaskHandlers };
 //# sourceMappingURL=index.js.map