@sanity/pkg-utils 2.0.0-beta.2 → 2.0.0-beta.3

package/dist/index.d.ts

@@ -38,6 +38,7 @@ export declare interface BuildContext {
   distPath: string
   emitDeclarationOnly: boolean
   exports: PkgExports | undefined
+  extMap: PkgExtMap
   external: string[]
   files: BuildFile[]
   logger: Logger
@@ -82,6 +83,9 @@ export declare function createLogger(): Logger
 /** @public */
 export declare const DEFAULT_BROWSERSLIST_QUERY: string[]
 
+/** @internal */
+export declare const DEFAULT_PKG_EXT_MAP: PkgExtMap
+
 /** @public */
 export declare function defineConfig(configOptions: PkgConfigOptions): PkgConfigOptions
 
@@ -128,6 +132,9 @@ export declare function getExtractMessagesConfig(options: {
   rules: NonNullable<PkgConfigOptions['extract']>['rules']
 }): IExtractorMessagesConfig
 
+/** @internal */
+export declare function getPkgExtMap(options: {legacyExports: boolean}): PkgExtMap
+
 /** @internal */
 export declare function isRecord(value: unknown): value is Record<string, unknown>
 
@@ -158,15 +165,6 @@ export declare interface Logger {
   success: (...args: unknown[]) => void
 }
 
-/** @internal */
-export declare const MODULE_EXT: Record<
-  'commonjs' | 'module',
-  {
-    commonjs: string
-    esm: string
-  }
->
-
 /** @internal */
 export declare interface PackageJSON {
   type: 'commonjs' | 'module'
@@ -207,7 +205,11 @@ export declare interface PackageJSON {
 }
 
 /** @internal */
-export declare function parseExports(options: {pkg: PackageJSON; strict: boolean}): (PkgExport & {
+export declare function parseExports(options: {
+  extMap: PkgExtMap
+  pkg: PackageJSON
+  strict: boolean
+}): (PkgExport & {
   _path: string
 })[]
 
@@ -314,6 +316,18 @@ export declare interface PkgExports {
   [path: string]: PkgExport
 }
 
+/** @internal */
+export declare interface PkgExtMap {
+  commonjs: {
+    commonjs: string
+    esm: string
+  }
+  module: {
+    commonjs: string
+    esm: string
+  }
+}
+
 /** @public */
 export declare type PkgFormat = 'commonjs' | 'esm'
 

package/dist/index.js

@@ -41,16 +41,6 @@ import prettyBytes from 'pretty-bytes';
 import { scan, startWith, distinctUntilChanged } from 'rxjs/operators';
 import globby from 'globby';
 import chokidar from 'chokidar';
-const MODULE_EXT = {
-  commonjs: {
-    commonjs: ".js",
-    esm: ".mjs"
-  },
-  module: {
-    commonjs: ".cjs",
-    esm: ".js"
-  }
-};
 const DEFAULT_BROWSERSLIST_QUERY = ["> 0.2% and supports es6-module and supports es6-module-dynamic-import", "not dead", "not IE 11", "maintained node versions"];
 function isRecord(value) {
   return Boolean(value) && !Array.isArray(value) && typeof value === "object";
@@ -203,9 +193,10 @@ function formatPath(segments) {
 }
 function validateExports(_exports, options) {
   const {
+    extMap,
     pkg
   } = options;
-  const ext = MODULE_EXT[pkg.type];
+  const ext = extMap[pkg.type];
   const errors = [];
   for (const exp of _exports) {
     if (exp.require && !exp.require.endsWith(ext.commonjs)) {
@@ -219,6 +210,7 @@ function validateExports(_exports, options) {
 }
 function parseExports(options) {
   const {
+    extMap,
     pkg,
     strict
   } = options;
@@ -278,6 +270,7 @@ function parseExports(options) {
   }
   const _exports = [rootExport, ...extraExports];
   errors.push(...validateExports(_exports, {
+    extMap,
     pkg
   }));
   if (errors.length) {
@@ -285,6 +278,29 @@ function parseExports(options) {
   }
   return _exports;
 }
+const DEFAULT_PKG_EXT_MAP = {
+  commonjs: {
+    commonjs: ".js",
+    esm: ".mjs"
+  },
+  module: {
+    commonjs: ".cjs",
+    esm: ".js"
+  }
+};
+function getPkgExtMap(options) {
+  const {
+    legacyExports
+  } = options;
+  const ret = _objectSpread({}, DEFAULT_PKG_EXT_MAP);
+  if (legacyExports) {
+    ret["commonjs"] = {
+      commonjs: ".js",
+      esm: ".esm.js"
+    };
+  }
+  return ret;
+}
 async function loadTSConfig(options) {
   const {
     cwd,
@@ -435,6 +451,7 @@ async function resolveBuildContext(options) {
     config,
     cwd,
     emitDeclarationOnly = false,
+    extMap,
     logger,
     pkg,
     strict,
@@ -459,6 +476,7 @@ async function resolveBuildContext(options) {
     node: nodeTarget
   };
   const parsedExports = parseExports({
+    extMap,
     pkg,
     strict
   }).reduce((acc, x) => {
@@ -500,6 +518,7 @@ async function resolveBuildContext(options) {
     emitDeclarationOnly,
     exports,
     external,
+    extMap,
     files: [],
     logger,
     pkg,
@@ -670,13 +689,40 @@ function printExtractMessages(ctx, messages) {
     process.exit(1);
   }
 }
-const formatHost = {
-  getCurrentDirectory: () => ts.sys.getCurrentDirectory(),
-  getNewLine: () => ts.sys.newLine,
-  getCanonicalFileName: ts.sys.useCaseSensitiveFileNames ? f => f : f => f.toLowerCase()
-};
+function printDiagnostic(options) {
+  const {
+    cwd,
+    logger,
+    diagnostic
+  } = options;
+  if (diagnostic.file && diagnostic.start) {
+    const {
+      line,
+      character
+    } = ts.getLineAndCharacterOfPosition(diagnostic.file, diagnostic.start);
+    const message = ts.flattenDiagnosticMessageText(diagnostic.messageText, "\n");
+    const file = path.relative(cwd, diagnostic.file.fileName);
+    const output = ["".concat(chalk.yellow(file), ":").concat(chalk.blue(line + 1), ":").concat(chalk.blue(character + 1), " - "), "".concat(chalk.gray("TS".concat(diagnostic.code, ":")), " ").concat(message)].join("");
+    if (diagnostic.category === ts.DiagnosticCategory.Error) {
+      logger.error(output);
+    }
+    if (diagnostic.category === ts.DiagnosticCategory.Warning) {
+      logger.warn(output);
+    }
+    if (diagnostic.category === ts.DiagnosticCategory.Message) {
+      logger.log(output);
+    }
+    if (diagnostic.category === ts.DiagnosticCategory.Suggestion) {
+      logger.log(output);
+    }
+  } else {
+    logger.log(ts.flattenDiagnosticMessageText(diagnostic.messageText, "\n"));
+  }
+}
 async function buildTypes(options) {
   const {
+    cwd,
+    logger,
     outDir,
     tsconfig,
     strict = false
@@ -691,22 +737,16 @@ async function buildTypes(options) {
   const program = ts.createProgram(tsconfig.fileNames, compilerOptions);
   const emitResult = program.emit();
   const allDiagnostics = ts.getPreEmitDiagnostics(program).concat(emitResult.diagnostics);
-  allDiagnostics.forEach(diagnostic => {
-    if (diagnostic.file && diagnostic.start) {
-      const {
-        line,
-        character
-      } = ts.getLineAndCharacterOfPosition(diagnostic.file, diagnostic.start);
-      const message = ts.flattenDiagnosticMessageText(diagnostic.messageText, "\n");
-      console.log("".concat(diagnostic.file.fileName, " ").concat(line + 1, ":").concat(character + 1, "\n").concat(message));
-    } else {
-      console.log(ts.flattenDiagnosticMessageText(diagnostic.messageText, "\n"));
-    }
-  });
+  for (const diagnostic of allDiagnostics) {
+    printDiagnostic({
+      cwd,
+      logger,
+      diagnostic
+    });
+  }
   if (emitResult.emitSkipped) {
     const errors = allDiagnostics.filter(diag => diag.category === ts.DiagnosticCategory.Error);
     if (errors.length) {
-      console.error(ts.formatDiagnostics(errors, formatHost));
       if (strict) {
         throw new Error("failed to compile TypeScript definitions");
       }
@@ -934,6 +974,7 @@ async function doExtract(ctx, task) {
     config,
     cwd,
     files,
+    logger,
     strict,
     ts
   } = ctx;
@@ -954,6 +995,7 @@ async function doExtract(ctx, task) {
   const tmpPath = path.resolve(outDir, "__tmp__");
   await buildTypes({
     cwd,
+    logger,
     outDir: tmpPath,
     strict,
     tsconfig: ts.config
@@ -1050,6 +1092,53 @@ const dtsWatchTask = {
     }
   }
 };
+function createConsoleSpy(options) {
+  const {
+    onRestored
+  } = options;
+  const original = {
+    log: console.log,
+    warn: console.warn,
+    error: console.error
+  };
+  const messages = [];
+  console.log = function () {
+    for (var _len5 = arguments.length, args = new Array(_len5), _key5 = 0; _key5 < _len5; _key5++) {
+      args[_key5] = arguments[_key5];
+    }
+    return messages.push({
+      type: "log",
+      args
+    });
+  };
+  console.warn = function () {
+    for (var _len6 = arguments.length, args = new Array(_len6), _key6 = 0; _key6 < _len6; _key6++) {
+      args[_key6] = arguments[_key6];
+    }
+    return messages.push({
+      type: "warn",
+      args
+    });
+  };
+  console.error = function () {
+    for (var _len7 = arguments.length, args = new Array(_len7), _key7 = 0; _key7 < _len7; _key7++) {
+      args[_key7] = arguments[_key7];
+    }
+    return messages.push({
+      type: "error",
+      args
+    });
+  };
+  return {
+    messages,
+    restore: () => {
+      console.log = original.log;
+      console.warn = original.warn;
+      console.error = original.error;
+      onRestored(messages);
+    }
+  };
+}
 function resolveRollupConfig(ctx, buildTask) {
   var _ref4, _ref7, _ref8, _ref9, _ref10, _ref11;
   var _a, _b, _c;
@@ -1062,13 +1151,14 @@ function resolveRollupConfig(ctx, buildTask) {
     config,
     cwd,
     exports: _exports,
+    extMap,
     external,
     distPath,
     logger,
     pkg,
     ts
   } = ctx;
-  const outputExt = MODULE_EXT[pkg.type][format];
+  const outputExt = extMap[pkg.type][format];
   const minify = (_ref4 = config == null ? void 0 : config.minify) !== null && _ref4 !== void 0 ? _ref4 : true;
   const outDir = path.relative(cwd, distPath);
   const pathAliases = Object.fromEntries(Object.entries(((_a = ts.config) == null ? void 0 : _a.options.paths) || {}).map(_ref5 => {
@@ -1171,10 +1261,22 @@ function resolveRollupConfig(ctx, buildTask) {
       }
     },
     outputOptions: {
-      chunkFileNames: () => "_chunks/[name]-[hash]".concat(outputExt),
+      chunkFileNames: () => {
+        const parts = outputExt.split(".");
+        if (parts.length === 3) {
+          return "_chunks/[name]-[hash].".concat(parts[2]);
+        }
+        return "_chunks/[name]-[hash]".concat(outputExt);
+      },
       compact: minify,
       dir: outDir,
-      entryFileNames: () => "[name]".concat(outputExt),
+      entryFileNames: () => {
+        const parts = outputExt.split(".");
+        if (parts.length === 3) {
+          return "[name].".concat(parts[2]);
+        }
+        return "[name]".concat(outputExt);
+      },
       esModule: true,
       format,
       interop: "compat",
@@ -1195,54 +1297,9 @@ const rollupTask = {
   },
   complete: () => {},
   error: (_ctx, _task, err) => {
-    if (err instanceof Error) {
-      console.log(err);
-    }
+    console.error(err);
   }
 };
-function createSpyConsole() {
-  const original = {
-    log: console.log,
-    warn: console.warn,
-    error: console.error
-  };
-  const messages = [];
-  console.log = function () {
-    for (var _len5 = arguments.length, args = new Array(_len5), _key5 = 0; _key5 < _len5; _key5++) {
-      args[_key5] = arguments[_key5];
-    }
-    return messages.push({
-      type: "log",
-      args
-    });
-  };
-  console.warn = function () {
-    for (var _len6 = arguments.length, args = new Array(_len6), _key6 = 0; _key6 < _len6; _key6++) {
-      args[_key6] = arguments[_key6];
-    }
-    return messages.push({
-      type: "warn",
-      args
-    });
-  };
-  console.error = function () {
-    for (var _len7 = arguments.length, args = new Array(_len7), _key7 = 0; _key7 < _len7; _key7++) {
-      args[_key7] = arguments[_key7];
-    }
-    return messages.push({
-      type: "error",
-      args
-    });
-  };
-  return {
-    messages,
-    restore: () => {
-      console.log = original.log;
-      console.warn = original.warn;
-      console.error = original.error;
-    }
-  };
-}
 async function execPromise(ctx, task) {
   const {
     distPath,
@@ -1250,56 +1307,68 @@ async function execPromise(ctx, task) {
     logger
   } = ctx;
   const outDir = path.relative(ctx.cwd, distPath);
-  const spyConsole = createSpyConsole();
-  const {
-    inputOptions,
-    outputOptions
-  } = resolveRollupConfig(ctx, task);
-  const bundle = await rollup(_objectSpread(_objectSpread({}, inputOptions), {}, {
-    onwarn(warning) {
-      spyConsole.messages.push({
-        type: "warn",
-        args: [warning.message]
-      });
-    }
-  }));
-  const {
-    output
-  } = await bundle.generate(outputOptions);
-  spyConsole.restore();
-  for (const msg of spyConsole.messages) {
-    const text = String(msg.args[0]);
-    if (text.startsWith("Dynamic import can only")) {
-      continue;
-    }
-    if (text.startsWith("Sourcemap is likely to be incorrect")) {
-      continue;
-    }
-    if (msg.type === "log") {
-      logger.info(...msg.args);
-    }
-    if (msg.type === "warn") {
-      logger.warn(...msg.args);
-    }
-    if (msg.type === "error") {
-      logger.error(...msg.args);
+  const consoleSpy = createConsoleSpy({
+    onRestored: messages => {
+      for (const msg of messages) {
+        const text = String(msg.args[0]);
+        if (msg.code === "CIRCULAR_DEPENDENCY") {
+          continue;
+        }
+        if (text.startsWith("Dynamic import can only")) {
+          continue;
+        }
+        if (text.startsWith("Sourcemap is likely to be incorrect")) {
+          continue;
+        }
+        if (msg.type === "log") {
+          logger.info(...msg.args);
+        }
+        if (msg.type === "warn") {
+          logger.warn(...msg.args);
+        }
+        if (msg.type === "error") {
+          logger.error(...msg.args);
+        }
+      }
     }
-  }
-  for (const chunkOrAsset of output) {
-    if (chunkOrAsset.type === "asset") {
-      files.push({
-        type: "asset",
-        path: path.resolve(outDir, chunkOrAsset.fileName)
-      });
-    } else {
-      files.push({
-        type: "chunk",
-        path: path.resolve(outDir, chunkOrAsset.fileName)
-      });
+  });
+  try {
+    const {
+      inputOptions,
+      outputOptions
+    } = resolveRollupConfig(ctx, task);
+    const bundle = await rollup(_objectSpread(_objectSpread({}, inputOptions), {}, {
+      onwarn(warning) {
+        consoleSpy.messages.push({
+          type: "warn",
+          code: warning.code,
+          args: [warning.message]
+        });
+      }
+    }));
+    const {
+      output
+    } = await bundle.generate(outputOptions);
+    for (const chunkOrAsset of output) {
+      if (chunkOrAsset.type === "asset") {
+        files.push({
+          type: "asset",
+          path: path.resolve(outDir, chunkOrAsset.fileName)
+        });
+      } else {
+        files.push({
+          type: "chunk",
+          path: path.resolve(outDir, chunkOrAsset.fileName)
+        });
+      }
     }
+    await bundle.write(outputOptions);
+    await bundle.close();
+    consoleSpy.restore();
+  } catch (err) {
+    consoleSpy.restore();
+    throw err;
   }
-  await bundle.write(outputOptions);
-  await bundle.close();
 }
 const rollupWatchTask = {
   name: (ctx, task) => "build javascript files (target ".concat(task.target.join(" + "), ", format ").concat(task.format, ")\n       ").concat(task.entries.map(e => "".concat(chalk.blue(path.join(ctx.pkg.name, e.path)), ": ").concat(e.source, " -> ").concat(e.output)).join("\n       ")),
@@ -1362,6 +1431,7 @@ const watchTaskHandlers = {
   "watch:js": rollupWatchTask
 };
 async function build(options) {
+  var _ref12;
   const {
     cwd,
     emitDeclarationOnly,
@@ -1376,11 +1446,15 @@ async function build(options) {
   const config = await loadConfig({
     cwd
   });
+  const extMap = getPkgExtMap({
+    legacyExports: (_ref12 = config == null ? void 0 : config.legacyExports) !== null && _ref12 !== void 0 ? _ref12 : false
+  });
   const tsconfig = tsconfigOption || (config == null ? void 0 : config.tsconfig) || "tsconfig.json";
   const ctx = await resolveBuildContext({
     config,
     cwd,
     emitDeclarationOnly,
+    extMap,
     logger,
     pkg,
     strict,
@@ -1442,8 +1516,8 @@ function printPackageTree(ctx) {
     type: chalk.yellow(pkg.type)
   };
   if (pkg.bin) {
-    tree.bin = Object.fromEntries(Object.entries(pkg.bin).map(_ref12 => {
-      let [name, file] = _ref12;
+    tree.bin = Object.fromEntries(Object.entries(pkg.bin).map(_ref13 => {
+      let [name, file] = _ref13;
       return [chalk.cyan(name), fileInfo(file)];
     }));
   }
@@ -1454,11 +1528,11 @@ function printPackageTree(ctx) {
     }
     return "".concat(chalk.yellow(file), " ").concat(chalk.gray(info.size));
   }
-  tree.exports = Object.fromEntries(Object.entries(exports).filter(_ref13 => {
-    let [, entry] = _ref13;
+  tree.exports = Object.fromEntries(Object.entries(exports).filter(_ref14 => {
+    let [, entry] = _ref14;
     return entry._exported;
-  }).map(_ref14 => {
-    let [exportPath, entry] = _ref14;
+  }).map(_ref15 => {
+    let [exportPath, entry] = _ref15;
     const exp = {
       types: void 0,
       source: fileInfo(entry.source),
@@ -1506,6 +1580,7 @@ function printPackageTree(ctx) {
   logger.log(treeify.asTree(tree, true, true));
 }
 async function check(options) {
+  var _ref16;
   const {
     cwd,
     strict = false,
@@ -1519,10 +1594,14 @@ async function check(options) {
   const config = await loadConfig({
     cwd
   });
+  const extMap = getPkgExtMap({
+    legacyExports: (_ref16 = config == null ? void 0 : config.legacyExports) !== null && _ref16 !== void 0 ? _ref16 : false
+  });
   const tsconfig = tsconfigOption || (config == null ? void 0 : config.tsconfig) || "tsconfig.json";
   const ctx = await resolveBuildContext({
     config,
     cwd,
+    extMap,
     logger,
     pkg,
     strict,
@@ -1628,8 +1707,8 @@ function resolveWatchTasks(ctx) {
     target
   } = ctx;
   const tasks = [];
-  const exports = Object.entries(ctx.exports || {}).map(_ref15 => {
-    let [_path, exp] = _ref15;
+  const exports = Object.entries(ctx.exports || {}).map(_ref17 => {
+    let [_path, exp] = _ref17;
     return _objectSpread({
       _path
     }, exp);
@@ -1773,6 +1852,7 @@ async function watch(options) {
     logger
   });
   const ctx$ = configFiles$.pipe(switchMap(async configFiles => {
+    var _ref18;
     const files = configFiles.map(f => path.relative(cwd, f));
     const packageJsonPath = files.find(f => f === "package.json");
     if (!packageJsonPath) {
@@ -1785,10 +1865,14 @@ async function watch(options) {
     const config = await loadConfig({
       cwd
     });
+    const extMap = getPkgExtMap({
+      legacyExports: (_ref18 = config == null ? void 0 : config.legacyExports) !== null && _ref18 !== void 0 ? _ref18 : false
+    });
     const tsconfig = tsconfigOption || (config == null ? void 0 : config.tsconfig) || "tsconfig.json";
     return resolveBuildContext({
       config,
       cwd,
+      extMap,
       logger,
       pkg,
       strict,
@@ -1817,5 +1901,5 @@ async function watch(options) {
     }
   });
 }
-export { DEFAULT_BROWSERSLIST_QUERY, MODULE_EXT, build, buildTaskHandlers, check, createLogger, defineConfig, dtsTask, dtsWatchTask, getExtractMessagesConfig, isRecord, loadConfig, loadPkg, loadPkgWithReporting, loadTSConfig, parseExports, resolveBuildTasks, resolveConfigProperty, rollupTask, rollupWatchTask, watch, watchTaskHandlers };
+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 };
 //# sourceMappingURL=index.js.map