source-map-explorer 2.3.1 → 2.5.0

package/lib/output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../src/lib/output.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,4CAAoB;AAEpB,iCAAsC;AACtC,2CAAuC;AAIvC,SAAgB,YAAY,CAC1B,OAA8B,EAC9B,OAAuB;IAEvB,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,OAAO;KACR;IAED,QAAQ,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE;QAC7B,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAEjD,KAAK,KAAK;YACR,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;QAE9B,KAAK,MAAM;YACT,OAAO,mBAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;KACzC;AACH,CAAC;AAlBD,oCAkBC;AAED,SAAS,WAAW,CAAC,OAA8B;IACjD,MAAM,KAAK,GAAG,CAAC,cAAc,CAAC,CAAC;IAE/B,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAChC,IAAI,KAAK,GAAG,CAAC,EAAE;YAEb,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SAChB;QAED,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;aACzB,GAAG,CAAmB,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;aAC9D,IAAI,CAAC,eAAe,CAAC;aACrB,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YAC1B,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,KAAK,IAAI,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC,IAAI,CAAC,YAAE,CAAC,GAAG,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,eAAe,CAAC,CAAC,EAAE,KAAK,CAAmB,EAAE,CAAC,EAAE,KAAK,CAAmB;IAC/E,OAAO,KAAK,GAAG,KAAK,CAAC;AACvB,CAAC;AAED,SAAgB,gBAAgB,CAAC,MAAqB,EAAE,OAAuB;IAC7E,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,OAAO;KACR;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;IAEzC,IAAI,MAAM,IAAI,QAAQ,EAAE;QACtB,IAAI;YACF,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAEnC,YAAE,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvC,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACpC;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,oBAAQ,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,EAAE,KAAK,CAAC,CAAC;SACvD;KACF;AACH,CAAC;AAlBD,4CAkBC","sourcesContent":["import os from 'os';\nimport path from 'path';\nimport fs from 'fs';\n\nimport { generateHtml } from './html';\nimport { AppError } from './app-error';\n\nimport type { ExploreBundleResult, ExploreOptions, ExploreResult } from './types';\n\nexport function formatOutput(\n  results: ExploreBundleResult[],\n  options: ExploreOptions\n): string | undefined {\n  if (!options.output) {\n    return;\n  }\n\n  switch (options.output.format) {\n    case 'json':\n      return JSON.stringify({ results }, null, '  ');\n\n    case 'tsv':\n      return outputAsTsv(results);\n\n    case 'html':\n      return generateHtml(results, options);\n  }\n}\n\nfunction outputAsTsv(results: ExploreBundleResult[]): string {\n  const lines = ['Source\\tSize'];\n\n  results.forEach((bundle, index) => {\n    if (index > 0) {\n      // Separate bundles by empty line\n      lines.push('');\n    }\n\n    Object.entries(bundle.files)\n      .map<[string, number]>(([source, data]) => [source, data.size])\n      .sort(sortFilesBySize)\n      .forEach(([source, size]) => {\n        lines.push(`${source}\\t${size}`);\n      });\n  });\n\n  return lines.join(os.EOL);\n}\n\nfunction sortFilesBySize([, aSize]: [string, number], [, bSize]: [string, number]): number {\n  return bSize - aSize;\n}\n\nexport function saveOutputToFile(result: ExploreResult, options: ExploreOptions): void {\n  if (!options.output) {\n    return;\n  }\n\n  const output = result.output;\n  const filename = options.output.filename;\n\n  if (output && filename) {\n    try {\n      const dir = path.dirname(filename);\n\n      fs.mkdirSync(dir, { recursive: true });\n      fs.writeFileSync(filename, output);\n    } catch (error) {\n      throw new AppError({ code: 'CannotSaveFile' }, error);\n    }\n  }\n}\n"]}

package/lib/types.d.ts

@@ -0,0 +1,121 @@
+export interface FileData {
+  size: number;
+  coveredSize?: number;
+}
+
+export type FileDataMap = Record<string, FileData>;
+
+export interface FileSizes {
+  files: FileDataMap;
+  mappedBytes: number;
+  unmappedBytes?: number;
+  eolBytes: number;
+  sourceMapCommentBytes: number;
+  totalBytes: number;
+}
+
+export type ErrorCode =
+  | 'Unknown'
+  | 'NoBundles'
+  | 'NoSourceMap'
+  | 'OneSourceSourceMap'
+  | 'UnmappedBytes'
+  | 'InvalidMappingLine'
+  | 'InvalidMappingColumn'
+  | 'CannotSaveFile'
+  | 'CannotCreateTempFile'
+  | 'CannotOpenTempFile'
+  | 'CannotOpenCoverageFile'
+  | 'NoCoverageMatches';
+
+export type File = string | Buffer;
+
+export type ReplaceMap = Record<string, string>;
+
+type OutputFormat = 'json' | 'tsv' | 'html';
+
+/** Represents single bundle */
+export interface Bundle {
+  code: File;
+  map?: File;
+  coverageRanges?: ColumnsRange[][];
+}
+
+export interface ExploreOptions {
+  /** Exclude "unmapped" bytes from the output */
+  onlyMapped?: boolean;
+  /** Exclude source map comment size from output */
+  excludeSourceMapComment?: boolean;
+  /** Output result as a string */
+  output?: {
+    format: OutputFormat;
+    /** Filename to save output to */
+    filename?: string;
+  };
+  /** Disable removing prefix shared by all sources */
+  noRoot?: boolean;
+  /** Disable invalid mapping column/line checks. */
+  noBorderChecks?: boolean;
+  /** Replace "this" by "that" map */
+  replaceMap?: ReplaceMap;
+  coverage?: string;
+  /** Calculate gzip size. Setting it to `true` will also set `onlyMapped` to `true` */
+  gzip?: boolean;
+  /** Sort filenames */
+  sort?: boolean;
+}
+
+export interface ExploreResult {
+  bundles: ExploreBundleResult[];
+  /** Result as a string - either JSON, TSV or HTML */
+  output?: string;
+  errors: ExploreErrorResult[];
+}
+
+export interface ExploreBundleResult extends FileSizes {
+  bundleName: string;
+}
+
+export interface ExploreErrorResult {
+  bundleName: string;
+  code: string;
+  message: string;
+  error?: NodeJS.ErrnoException;
+  isWarning?: boolean;
+}
+
+export type BundlesAndFileTokens = (Bundle | string)[] | Bundle | string;
+
+/** Represents inclusive range (e.g. [0,5] six columns) */
+export interface ColumnsRange {
+  /** Fist column index */
+  start: number;
+  /** Last column index */
+  end: number;
+}
+
+export interface MappingRange extends ColumnsRange {
+  source: string;
+}
+
+/** Represents exclusive range (e.g. [0,5) - four columns) */
+export interface Coverage {
+  url: string;
+  ranges: CoverageRange[];
+  /** File content as one line */
+  text: string;
+}
+
+export interface CoverageRange {
+  /** First column index */
+  start: number;
+  /** Column index next after last column index */
+  end: number;
+}
+
+// TODO: Remove when https://github.com/mozilla/source-map/pull/374 is published
+declare module 'source-map' {
+  export interface MappingItem {
+    lastGeneratedColumn: number | null;
+  }
+}

package/package.json

@@ -1,24 +1,32 @@
 {
   "name": "source-map-explorer",
-  "version": "2.3.1",
+  "version": "2.5.0",
   "description": "Analyze and debug space usage through source maps",
-  "main": "dist/index.js",
+  "main": "lib/index.js",
   "bin": {
-    "source-map-explorer": "dist/cli.js"
+    "source-map-explorer": "bin/cli.js",
+    "sme": "bin/cli.js"
+  },
+  "engines": {
+    "node": ">=10"
   },
   "scripts": {
-    "pretest": "npm run build",
-    "test": "cross-env NODE_ENV=test mocha",
-    "test:update-snapshots": "cross-env SNAPSHOT_UPDATE=1 npm run test",
-    "coverage": "nyc --reporter=lcov --reporter=text npm test",
-    "lint": "eslint src/**/*.* tests/*.* --fix",
-    "build:clean": "rimraf dist/**/*",
-    "build:compile": "babel src --out-dir dist --extensions \".ts\" --ignore src/*.d.ts",
-    "build:copy": "copyfiles -u 1 src/vendor/*.* src/tree-viz.ejs dist",
-    "build:format": "prettier dist/*.js --write",
-    "build:types": "tsc -p tsconfig.build.json",
     "build": "npm-run-all build:*",
-    "watch": "chokidar src/*.* -c \"npm run build\" --silent --initial --debounce=700",
+    "watch": "chokidar src/**/*.* -c \"npm run build\" --silent --initial --debounce=700",
+    "test:unit": "mocha --config tests/.mocharc.unit.js",
+    "test:e2e": "mocha --config tests/.mocharc.e2e.js",
+    "test:perf": "mocha --config tests/.mocharc.perf.js",
+    "test": "npm-run-all test:unit test:e2e test:perf",
+    "coverage": "nyc --reporter=lcov --reporter=text npm run test:unit",
+    "test:update-snapshots": "cross-env SNAPSHOT_UPDATE=1 npm run test",
+    "test:generate-data": "ts-node --dir tests generate-data/index.ts",
+    "build:clean": "rimraf lib/**/* bin/**/*",
+    "build:compile": "tsc --build",
+    "build:copy": "copyfiles -u 2 src/lib/vendor/*.* src/lib/tree-viz.ejs src/lib/types.d.ts lib",
+    "build:format": "prettier lib/*.js bin/*.js --write",
+    "pretest:e2e": "npm run build",
+    "coverage:ci": "nyc npm run test:unit && nyc report --reporter=text-lcov | coveralls",
+    "lint": "eslint src/**/*.* tests/**/*.* --fix",
     "update-dependencies": "npx npm-check-updates -u && npm i",
     "prepublishOnly": "npm run build"
   },
@@ -37,21 +45,6 @@
     "useRelativePath": true,
     "extension": ".snap"
   },
-  "nyc": {
-    "require": [
-      "@babel/register"
-    ],
-    "extension": [
-      ".ts"
-    ],
-    "include": "src",
-    "exclude": [
-      "src/cli.ts",
-      "src/index.ts"
-    ],
-    "sourceMap": false,
-    "instrument": false
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/danvk/source-map-explorer.git"
@@ -62,76 +55,83 @@
     "minification"
   ],
   "author": "Dan Vanderkam (danvdk@gmail.com)",
+  "maintainers": [
+    "Nikolay Borzov <nikolay.n.borzov@gmail.com>"
+  ],
   "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/danvk/source-map-explorer/issues"
   },
   "homepage": "https://github.com/danvk/source-map-explorer#readme",
   "files": [
-    "dist",
-    "LICENSE",
-    "README.md"
+    "bin",
+    "lib",
+    "!*.tsbuildinfo"
   ],
   "dependencies": {
     "btoa": "^1.2.1",
-    "chalk": "^3.0.0",
+    "chalk": "^4.1.0",
     "convert-source-map": "^1.7.0",
-    "ejs": "^3.0.1",
+    "ejs": "^3.1.5",
     "escape-html": "^1.0.3",
     "glob": "^7.1.6",
     "gzip-size": "^5.1.1",
-    "lodash": "^4.17.15",
-    "open": "^7.0.2",
+    "lodash": "^4.17.20",
+    "open": "^7.1.0",
     "source-map": "^0.7.3",
     "temp": "^0.9.1",
-    "yargs": "^15.1.0"
+    "yargs": "^15.4.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.8.4",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-proposal-object-rest-spread": "^7.8.3",
-    "@babel/preset-env": "^7.8.4",
-    "@babel/preset-typescript": "^7.8.3",
-    "@babel/register": "^7.8.3",
+    "@babel/core": "^7.11.1",
+    "@babel/preset-env": "^7.11.0",
+    "@istanbuljs/nyc-config-typescript": "^1.0.1",
     "@smpx/snap-shot-it": "^6.6.1",
+    "@types/browserify": "^12.0.36",
     "@types/btoa": "^1.2.3",
-    "@types/chai": "^4.2.9",
-    "@types/chai-as-promised": "^7.1.2",
+    "@types/chai": "^4.2.12",
+    "@types/chai-as-promised": "^7.1.3",
     "@types/concat-stream": "^1.6.0",
     "@types/convert-source-map": "^1.5.1",
-    "@types/cross-spawn": "^6.0.1",
-    "@types/ejs": "^3.0.1",
-    "@types/escape-html": "0.0.20",
-    "@types/glob": "^7.1.1",
-    "@types/lodash": "^4.14.149",
-    "@types/mocha": "^7.0.1",
-    "@types/node": "^13.x",
-    "@types/rimraf": "^2.0.3",
+    "@types/cross-spawn": "^6.0.2",
+    "@types/ejs": "^3.0.4",
+    "@types/escape-html": "1.0.0",
+    "@types/glob": "^7.1.3",
+    "@types/lodash": "^4.14.159",
+    "@types/mocha": "^8.0.3",
+    "@types/node": "^14.x",
+    "@types/rimraf": "^3.0.0",
     "@types/temp": "^0.8.34",
-    "@types/yargs": "^15.0.3",
-    "@typescript-eslint/eslint-plugin": "^2.20.0",
-    "@typescript-eslint/parser": "^2.20.0",
-    "babel-plugin-istanbul": "^6.0.0",
+    "@types/yargs": "^15.0.5",
+    "@typescript-eslint/eslint-plugin": "^3.9.1",
+    "@typescript-eslint/parser": "^3.9.1",
+    "babelify": "^10.0.0",
+    "browserify": "^16.5.2",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "chokidar-cli": "^2.1.0",
     "concat-stream": "^2.0.0",
-    "copyfiles": "^2.2.0",
-    "coveralls": "^3.0.9",
-    "cross-env": "^7.0.0",
-    "cross-spawn": "^7.0.1",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.10.0",
-    "eslint-plugin-prettier": "^3.1.2",
-    "husky": "^4.2.3",
-    "lint-staged": "^10.0.7",
-    "mocha": "^7.0.1",
+    "copyfiles": "^2.3.0",
+    "coveralls": "^3.1.0",
+    "cross-env": "^7.0.2",
+    "cross-spawn": "^7.0.3",
+    "eslint": "^7.7.0",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-prettier": "^3.1.4",
+    "generate-source-map": "0.0.5",
+    "husky": "^4.2.5",
+    "lint-staged": "^10.2.11",
+    "mocha": "^8.1.1",
     "npm-run-all": "^4.1.5",
-    "nyc": "^15.0.0",
-    "prettier": "^1.19.1",
-    "rewiremock": "^3.13.9",
+    "nyc": "^15.1.0",
+    "prettier": "^2.0.5",
+    "rewiremock": "^3.14.3",
     "rimraf": "^3.0.2",
-    "typescript": "^3.7.5"
+    "source-map-support": "^0.5.19",
+    "terser": "^5.2.1",
+    "terser-webpack-plugin": "^4.1.0",
+    "ts-node": "^8.10.2",
+    "typescript": "^3.9.7",
+    "webpack": "^4.44.1"
   }
 }

package/dist/api.js

@@ -1,168 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', {
-  value: true,
-});
-exports.explore = explore;
-exports.getBundles = getBundles;
-exports.getBundleName = getBundleName;
-
-var _glob = _interopRequireDefault(require('glob'));
-
-var _lodash = require('lodash');
-
-var _explore = require('./explore');
-
-var _appError = require('./app-error');
-
-var _output = require('./output');
-
-var _coverage = require('./coverage');
-
-function _interopRequireDefault(obj) {
-  return obj && obj.__esModule ? obj : { default: obj };
-}
-
-function adjustOptions(options) {
-  /* Unmapped bytes cannot be calculate because it's impossible to get total size by summing files'
-     sizes when calculating gzip size for a file. */
-  if (options.gzip) {
-    options.onlyMapped = true;
-  }
-
-  return options;
-}
-/**
- * Analyze bundle(s)
- */
-
-async function explore(bundlesAndFileTokens, options = {}) {
-  bundlesAndFileTokens = Array.isArray(bundlesAndFileTokens)
-    ? bundlesAndFileTokens
-    : [bundlesAndFileTokens];
-
-  if (bundlesAndFileTokens.length === 0) {
-    throw new _appError.AppError({
-      code: 'NoBundles',
-    });
-  }
-
-  adjustOptions(options); // Separate bundles from file tokens
-
-  const [fileTokens, bundles] = (0, _lodash.partition)(bundlesAndFileTokens, _lodash.isString); // Get bundles from file tokens
-
-  bundles.push(...getBundles(fileTokens));
-  (0, _coverage.addCoverageRanges)(bundles, options.coverage);
-  const results = await Promise.all(
-    bundles.map(bundle =>
-      (0, _explore.exploreBundle)(bundle, options).catch(error => onExploreError(bundle, error))
-    )
-  );
-  const exploreResult = getExploreResult(results, options); // Reject if none of results is successful
-
-  if (exploreResult.bundles.length === 0) {
-    return Promise.reject(exploreResult);
-  }
-
-  (0, _output.saveOutputToFile)(exploreResult, options);
-  return exploreResult;
-}
-/**
- * Expand list of file tokens into a list of bundles
- */
-
-function getBundles(fileTokens) {
-  const filenames = (0, _lodash.flatMap)(fileTokens, filePath =>
-    _glob.default.hasMagic(filePath) ? expandGlob(filePath) : filePath
-  );
-  const [mapFilenames, codeFilenames] = (0, _lodash.partition)(filenames, filename =>
-    filename.endsWith('.map')
-  );
-  return codeFilenames.map(code => ({
-    code,
-    map: mapFilenames.find(filename => filename === `${code}.map`),
-  }));
-}
-
-function expandGlob(pattern) {
-  // Make sure pattern match `.map` files as well
-  if (pattern.endsWith('.js')) {
-    pattern = `${pattern}?(.map)`;
-  }
-
-  return _glob.default.sync(pattern);
-}
-
-function getBundleName(bundle) {
-  return Buffer.isBuffer(bundle.code) ? 'Buffer' : bundle.code;
-}
-/**
- * Handle error during bundle processing
- */
-
-function onExploreError(bundle, error) {
-  return {
-    bundleName: getBundleName(bundle),
-    code: error.code || 'Unknown',
-    message: error.message,
-    error,
-  };
-}
-
-function getExploreResult(results, options) {
-  const [bundles, errors] = (0, _lodash.partition)(results, result => 'files' in result);
-  errors.push(...getPostExploreErrors(bundles));
-  return {
-    bundles,
-    errors,
-    ...(bundles.length > 0 && {
-      output: (0, _output.formatOutput)(bundles, options),
-    }),
-  };
-}
-
-function getPostExploreErrors(exploreBundleResults) {
-  const errors = [];
-  const isSingleBundle = exploreBundleResults.length === 1;
-
-  for (const result of exploreBundleResults) {
-    const { bundleName, files, totalBytes } = result; // Check if source map contains only one file - this make result useless when exploring single bundle
-
-    if (isSingleBundle) {
-      const filenames = Object.keys(files).filter(
-        filename => !_explore.SPECIAL_FILENAMES.includes(filename)
-      );
-
-      if (filenames.length === 1) {
-        errors.push({
-          bundleName,
-          isWarning: true,
-          code: 'OneSourceSourceMap',
-          message: (0, _appError.getErrorMessage)({
-            code: 'OneSourceSourceMap',
-            filename: filenames[0],
-          }),
-        });
-      }
-    }
-
-    if (files[_explore.UNMAPPED_KEY] !== undefined) {
-      const { size: unmappedBytes } = files[_explore.UNMAPPED_KEY];
-
-      if (unmappedBytes) {
-        errors.push({
-          bundleName,
-          isWarning: true,
-          code: 'UnmappedBytes',
-          message: (0, _appError.getErrorMessage)({
-            code: 'UnmappedBytes',
-            unmappedBytes,
-            totalBytes,
-          }),
-        });
-      }
-    }
-  }
-
-  return errors;
-}