@atlaspack/reporter-cli 2.15.1-canary.36 → 2.15.1-canary.360

package/lib/bundleReport.js

@@ -0,0 +1,112 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = bundleReport;
+function _utils() {
+  const data = require("@atlaspack/utils");
+  _utils = function () {
+    return data;
+  };
+  return data;
+}
+function _filesize() {
+  const data = _interopRequireDefault(require("filesize"));
+  _filesize = function () {
+    return data;
+  };
+  return data;
+}
+function _chalk() {
+  const data = _interopRequireDefault(require("chalk"));
+  _chalk = function () {
+    return data;
+  };
+  return data;
+}
+function _nullthrows() {
+  const data = _interopRequireDefault(require("nullthrows"));
+  _nullthrows = function () {
+    return data;
+  };
+  return data;
+}
+var emoji = _interopRequireWildcard(require("./emoji"));
+var _render = require("./render");
+var _utils2 = require("./utils");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const LARGE_BUNDLE_SIZE = 1024 * 1024;
+const COLUMNS = [{
+  align: 'left'
+},
+// name
+{
+  align: 'right'
+},
+// size
+{
+  align: 'right'
+} // time
+];
+
+async function bundleReport(bundleGraph, fs, projectRoot, assetCount = 0) {
+  let bundleList = bundleGraph.getBundles();
+
+  // Get a list of bundles sorted by size
+  let {
+    bundles
+  } = assetCount > 0 ? await (0, _utils().generateBuildMetrics)(bundleList, fs, projectRoot) : {
+    bundles: bundleList.map(b => {
+      return {
+        filePath: (0, _nullthrows().default)(b.filePath),
+        size: b.stats.size,
+        time: b.stats.time,
+        assets: []
+      };
+    })
+  };
+  let rows = [];
+  for (let bundle of bundles) {
+    // Add a row for the bundle
+    rows.push([(0, _utils2.formatFilename)(bundle.filePath || '', _chalk().default.cyan.bold), _chalk().default.bold(prettifySize(bundle.size, bundle.size > LARGE_BUNDLE_SIZE)), _chalk().default.green.bold((0, _utils().prettifyTime)(bundle.time))]);
+    if (assetCount > 0) {
+      let largestAssets = bundle.assets.slice(0, assetCount);
+      for (let asset of largestAssets) {
+        let columns = [asset == largestAssets[largestAssets.length - 1] ? '└── ' : '├── ',
+        // @ts-expect-error TS2554
+        _chalk().default.dim(prettifySize(asset.size)), _chalk().default.dim(_chalk().default.green((0, _utils().prettifyTime)(asset.time)))];
+        if (asset.filePath !== '') {
+          columns[0] += (0, _utils2.formatFilename)(asset.filePath, _chalk().default.reset);
+        } else {
+          columns[0] += 'Code from unknown sourcefiles';
+        }
+
+        // Add a row for the asset.
+        rows.push(columns);
+      }
+      if (bundle.assets.length > largestAssets.length) {
+        rows.push(['└── ' + _chalk().default.dim(`+ ${bundle.assets.length - largestAssets.length} more assets`)]);
+      }
+
+      // If this isn't the last bundle, add an empty row before the next one
+      if (bundle !== bundles[bundles.length - 1]) {
+        rows.push([]);
+      }
+    }
+  }
+
+  // Render table
+  (0, _render.writeOut)('');
+  // @ts-expect-error TS2345
+  (0, _render.table)(COLUMNS, rows);
+}
+function prettifySize(size, isLarge) {
+  let res = (0, _filesize().default)(size);
+  if (isLarge) {
+    return _chalk().default.yellow(emoji.warning + '  ' + res);
+  }
+  return _chalk().default.magenta(res);
+}

package/lib/emoji.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.warning = exports.success = exports.progress = exports.info = exports.hint = exports.error = exports.docs = void 0;
+// From https://github.com/sindresorhus/is-unicode-supported/blob/8f123916d5c25a87c4f966dcc248b7ca5df2b4ca/index.js
+// This package is ESM-only so it has to be vendored
+function isUnicodeSupported() {
+  if (process.platform !== 'win32') {
+    return process.env.TERM !== 'linux'; // Linux console (kernel)
+  }
+
+  return Boolean(process.env.CI) || Boolean(process.env.WT_SESSION) ||
+  // Windows Terminal
+  process.env.ConEmuTask === '{cmd::Cmder}' ||
+  // ConEmu and cmder
+  process.env.TERM_PROGRAM === 'vscode' || process.env.TERM === 'xterm-256color' || process.env.TERM === 'alacritty';
+}
+const supportsEmoji = isUnicodeSupported();
+
+// Fallback symbols for Windows from https://en.wikipedia.org/wiki/Code_page_437
+const progress = exports.progress = supportsEmoji ? '⏳' : '∞';
+const success = exports.success = supportsEmoji ? '✨' : '√';
+const error = exports.error = supportsEmoji ? '🚨' : '×';
+const warning = exports.warning = supportsEmoji ? '⚠️' : '‼';
+const info = exports.info = supportsEmoji ? 'ℹ️' : 'ℹ';
+const hint = exports.hint = supportsEmoji ? '💡' : 'ℹ';
+const docs = exports.docs = supportsEmoji ? '📝' : 'ℹ';

package/lib/logLevels.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+const logLevels = {
+  none: 0,
+  error: 1,
+  warn: 2,
+  info: 3,
+  progress: 3,
+  success: 3,
+  verbose: 4
+};
+var _default = exports.default = logLevels;

package/lib/phaseReport.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = phaseReport;
+function _utils() {
+  const data = require("@atlaspack/utils");
+  _utils = function () {
+    return data;
+  };
+  return data;
+}
+function _chalk() {
+  const data = _interopRequireDefault(require("chalk"));
+  _chalk = function () {
+    return data;
+  };
+  return data;
+}
+var _render = require("./render");
+function _assert() {
+  const data = _interopRequireDefault(require("assert"));
+  _assert = function () {
+    return data;
+  };
+  return data;
+}
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function phaseReport(phaseStartTimes) {
+  let phaseTimes = {};
+  if (phaseStartTimes['transforming'] && phaseStartTimes['bundling']) {
+    phaseTimes['Transforming'] = phaseStartTimes['bundling'] - phaseStartTimes['transforming'];
+  }
+  let packagingAndOptimizing = phaseStartTimes['packaging'] && phaseStartTimes['optimizing'] ? Math.min(phaseStartTimes['packaging'], phaseStartTimes['optimizing']) : phaseStartTimes['packaging'] || phaseStartTimes['optimizing'];
+  if (phaseStartTimes['bundling'] && packagingAndOptimizing) {
+    phaseTimes['Bundling'] = packagingAndOptimizing - phaseStartTimes['bundling'];
+  }
+  if (packagingAndOptimizing && phaseStartTimes['buildSuccess']) {
+    phaseTimes['Packaging & Optimizing'] = phaseStartTimes['buildSuccess'] - packagingAndOptimizing;
+  }
+  for (let [phase, time] of Object.entries(phaseTimes)) {
+    (0, _assert().default)(typeof time === 'number');
+    (0, _render.writeOut)(_chalk().default.green.bold(`${phase} finished in ${(0, _utils().prettifyTime)(time)}`));
+  }
+}

package/lib/render.js

@@ -0,0 +1,157 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports._setStdio = _setStdio;
+exports.isTTY = void 0;
+exports.persistMessage = persistMessage;
+exports.persistSpinner = persistSpinner;
+exports.resetWindow = resetWindow;
+exports.table = table;
+exports.updateSpinner = updateSpinner;
+exports.writeOut = writeOut;
+function _readline() {
+  const data = _interopRequireDefault(require("readline"));
+  _readline = function () {
+    return data;
+  };
+  return data;
+}
+function _ora() {
+  const data = _interopRequireDefault(require("ora"));
+  _ora = function () {
+    return data;
+  };
+  return data;
+}
+function _stringWidth() {
+  const data = _interopRequireDefault(require("string-width"));
+  _stringWidth = function () {
+    return data;
+  };
+  return data;
+}
+var _utils = require("./utils");
+var emoji = _interopRequireWildcard(require("./emoji"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const isTTY = exports.isTTY = process.env.NODE_ENV !== 'test' && process.stdout.isTTY;
+let stdout = process.stdout;
+let stderr = process.stderr;
+
+// We pipe worker output to the process. If you
+// have more than 10 threads then Nodejs will
+// print warnings indicating you exceed the max
+// listener count.
+stdout.setMaxListeners(100);
+stderr.setMaxListeners(100);
+
+// Some state so we clear the output properly
+let lineCount = 0;
+let errorLineCount = 0;
+let statusPersisted = false;
+function _setStdio(stdoutLike, stderrLike) {
+  // @ts-expect-error TS2322
+  stdout = stdoutLike;
+  // @ts-expect-error TS2322
+  stderr = stderrLike;
+}
+let spinner = (0, _ora().default)({
+  color: 'green',
+  stream: stdout,
+  discardStdin: false
+});
+let persistedMessages = [];
+function writeOut(message, isError = false) {
+  let processedMessage = message + '\n';
+  let hasSpinner = spinner.isSpinning;
+
+  // Stop spinner so we don't duplicate it
+  if (hasSpinner) {
+    spinner.stop();
+  }
+  let lines = (0, _utils.countLines)(message);
+  if (isError) {
+    stderr.write(processedMessage);
+    errorLineCount += lines;
+  } else {
+    stdout.write(processedMessage);
+    lineCount += lines;
+  }
+
+  // Restart the spinner
+  if (hasSpinner) {
+    spinner.start();
+  }
+}
+function persistMessage(message) {
+  if (persistedMessages.includes(message)) return;
+  persistedMessages.push(message);
+  writeOut(message);
+}
+function updateSpinner(message) {
+  // This helps the spinner play well with the tests
+  if (!isTTY) {
+    writeOut(message);
+    return;
+  }
+  spinner.text = message + '\n';
+  if (!spinner.isSpinning) {
+    spinner.start();
+  }
+}
+function persistSpinner(name, status, message) {
+  spinner.stopAndPersist({
+    symbol: emoji[status],
+    text: message
+  });
+  statusPersisted = true;
+}
+function clearStream(stream, lines) {
+  if (!isTTY) return;
+  _readline().default.moveCursor(stream, 0, -lines);
+  _readline().default.clearScreenDown(stream);
+}
+
+// Reset the window's state
+function resetWindow() {
+  if (!isTTY) return;
+
+  // If status has been persisted we add a line
+  // Otherwise final states would remain in the terminal for rebuilds
+  if (statusPersisted) {
+    lineCount++;
+    statusPersisted = false;
+  }
+  clearStream(stderr, errorLineCount);
+  errorLineCount = 0;
+  clearStream(stdout, lineCount);
+  lineCount = 0;
+  for (let m of persistedMessages) {
+    writeOut(m);
+  }
+}
+function table(columns, table) {
+  // Measure column widths
+  let colWidths = [];
+  for (let row of table) {
+    let i = 0;
+    for (let item of row) {
+      colWidths[i] = Math.max(colWidths[i] || 0, (0, _stringWidth().default)(item));
+      i++;
+    }
+  }
+
+  // Render rows
+  for (let row of table) {
+    let items = row.map((item, i) => {
+      // Add padding between columns unless the alignment is the opposite to the
+      // next column and pad to the column width.
+      let padding = !columns[i + 1] || columns[i + 1].align === columns[i].align ? 4 : 0;
+      return (0, _utils.pad)(item, colWidths[i] + padding, columns[i].align);
+    });
+    writeOut(items.join(''));
+  }
+}

package/lib/types/CLIReporter.d.ts

@@ -0,0 +1,5 @@
+import type { ReporterEvent, PluginOptions, PluginLogger } from '@atlaspack/types';
+import { Reporter } from '@atlaspack/plugin';
+export declare function _report(event: ReporterEvent, options: PluginOptions, logger: PluginLogger): Promise<void>;
+declare const _default: Reporter;
+export default _default;

package/lib/types/bundleReport.d.ts

@@ -0,0 +1,3 @@
+import type { BundleGraph, FilePath, PackagedBundle } from '@atlaspack/types';
+import type { FileSystem } from '@atlaspack/fs';
+export default function bundleReport(bundleGraph: BundleGraph<PackagedBundle>, fs: FileSystem, projectRoot: FilePath, assetCount?: number): Promise<void>;

package/lib/types/emoji.d.ts

@@ -0,0 +1,7 @@
+export declare const progress: string;
+export declare const success: string;
+export declare const error: string;
+export declare const warning: string;
+export declare const info: string;
+export declare const hint: string;
+export declare const docs: string;

package/lib/types/logLevels.d.ts

@@ -0,0 +1,10 @@
+declare const logLevels: {
+    readonly none: 0;
+    readonly error: 1;
+    readonly warn: 2;
+    readonly info: 3;
+    readonly progress: 3;
+    readonly success: 3;
+    readonly verbose: 4;
+};
+export default logLevels;

package/lib/types/phaseReport.d.ts

@@ -0,0 +1,3 @@
+export default function phaseReport(phaseStartTimes: {
+    [key: string]: number;
+}): void;

package/lib/types/render.d.ts

@@ -0,0 +1,14 @@
+import type { Writable } from 'stream';
+import type { PadAlign } from './utils';
+type ColumnType = {
+    align: PadAlign;
+};
+export declare const isTTY: any | boolean | true;
+export declare function _setStdio(stdoutLike: Writable, stderrLike: Writable): void;
+export declare function writeOut(message: string, isError?: boolean): void;
+export declare function persistMessage(message: string): void;
+export declare function updateSpinner(message: string): void;
+export declare function persistSpinner(name: string, status: 'success' | 'error', message: string): void;
+export declare function resetWindow(): void;
+export declare function table(columns: Array<ColumnType>, table: Array<Array<string>>): void;
+export {};

package/lib/types/utils.d.ts

@@ -0,0 +1,5 @@
+export type PadAlign = 'left' | 'right';
+export declare function getTerminalWidth(): any;
+export declare function pad(text: string, length: number, align?: PadAlign): string;
+export declare function formatFilename(filename: string, color?: (s: string) => string): string;
+export declare function countLines(message: string): number;

package/lib/utils.js

@@ -0,0 +1,71 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.countLines = countLines;
+exports.formatFilename = formatFilename;
+exports.getTerminalWidth = getTerminalWidth;
+exports.pad = pad;
+function _path() {
+  const data = _interopRequireDefault(require("path"));
+  _path = function () {
+    return data;
+  };
+  return data;
+}
+function _chalk() {
+  const data = _interopRequireDefault(require("chalk"));
+  _chalk = function () {
+    return data;
+  };
+  return data;
+}
+function _stringWidth() {
+  const data = _interopRequireDefault(require("string-width"));
+  _stringWidth = function () {
+    return data;
+  };
+  return data;
+}
+function _termSize() {
+  const data = _interopRequireDefault(require("term-size"));
+  _termSize = function () {
+    return data;
+  };
+  return data;
+}
+function _utils() {
+  const data = require("@atlaspack/utils");
+  _utils = function () {
+    return data;
+  };
+  return data;
+}
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+let terminalSize = (0, _termSize().default)();
+process.stdout.on('resize', function () {
+  terminalSize = (0, _termSize().default)();
+});
+function getTerminalWidth() {
+  return terminalSize;
+}
+
+// Pad a string with spaces on either side
+function pad(text, length, align = 'left') {
+  let pad = ' '.repeat(length - (0, _stringWidth().default)(text));
+  if (align === 'right') {
+    return pad + text;
+  }
+  return text + pad;
+}
+function formatFilename(filename, color = _chalk().default.reset) {
+  let dir = _path().default.relative(process.cwd(), _path().default.dirname(filename));
+  return _chalk().default.dim(dir + (dir ? _path().default.sep : '')) + color(_path().default.basename(filename));
+}
+function countLines(message) {
+  let {
+    columns
+  } = terminalSize;
+  return (0, _utils().stripAnsi)(message).split('\n').reduce((p, line) => p + Math.ceil(((0, _stringWidth().default)(line) || 1) / columns), 0);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/reporter-cli",
-  "version": "2.15.1-canary.36+2d10c6656",
+  "version": "2.15.1-canary.360+fc3adc098",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
     "access": "public"
@@ -9,8 +9,9 @@
     "type": "git",
     "url": "https://github.com/atlassian-labs/atlaspack.git"
   },
-  "main": "lib/CLIReporter.js",
-  "source": "src/CLIReporter.js",
+  "main": "./lib/CLIReporter.js",
+  "source": "./src/CLIReporter.ts",
+  "types": "./lib/types/CLIReporter.d.ts",
   "engines": {
     "node": ">= 16.0.0"
   },
@@ -26,20 +27,23 @@
     }
   },
   "dependencies": {
-    "@atlaspack/plugin": "2.14.5-canary.36+2d10c6656",
-    "@atlaspack/types": "2.14.5-canary.36+2d10c6656",
-    "@atlaspack/utils": "2.14.5-canary.36+2d10c6656",
+    "@atlaspack/plugin": "2.14.5-canary.360+fc3adc098",
+    "@atlaspack/types": "2.14.5-canary.360+fc3adc098",
+    "@atlaspack/utils": "2.14.5-canary.360+fc3adc098",
     "chalk": "^4.1.0",
-    "term-size": "^2.2.1"
-  },
-  "devDependencies": {
-    "@atlaspack/feature-flags": "2.14.1-canary.104+2d10c6656",
     "filesize": "^6.1.0",
     "nullthrows": "^1.1.1",
     "ora": "^5.2.0",
     "string-width": "^4.2.0",
+    "term-size": "^2.2.1",
     "wrap-ansi": "^7.0.0"
   },
+  "devDependencies": {
+    "@atlaspack/feature-flags": "2.14.1-canary.428+fc3adc098"
+  },
   "type": "commonjs",
-  "gitHead": "2d10c6656fc58743c5dbed1d2b6c5666887f9fe4"
-}
+  "scripts": {
+    "build:lib": "gulp build --gulpfile ../../../gulpfile.js --cwd ."
+  },
+  "gitHead": "fc3adc098f583e40d6d7687412cac6dde7cbb3f3"
+}