package-build-stats 7.3.8 → 8.0.0-beta.1

package/src/utils/common.utils.ts

@@ -3,6 +3,9 @@ import path from 'path'
 import builtInModules from 'builtin-modules'
 import fs from 'fs'
 import os from 'os'
+import memoize from 'memoizee'
+import ThrowableDiagnostic from '@parcel/diagnostic'
+import { codeFrameColumns } from '@babel/code-frame'
 
 const homeDirectory = os.homedir()
 
@@ -146,3 +149,138 @@ export function parsePackageString(packageString: string): ParsePackageResult {
     return parseUnscopedPackageString(normalPackageString)
   }
 }
+
+// Works only when the `path` begins with the package name
+export const parsePackageNameFromPath = (path: string): string => {
+  const fragments = path.split('/')
+  if (path.startsWith('@')) {
+    return [fragments[0], fragments[1]].join('/')
+  } else {
+    return fragments[0]
+  }
+}
+
+export function getPackageFromWebpackPath(filePath: string) {
+  let filePathReal = filePath.includes('!')
+    ? filePath.split('!')[filePath.split('!').length - 1]
+    : filePath
+  let lastNodeModulesIndex =
+    filePathReal.lastIndexOf('node_modules') + 'node_modules'.length + 1
+  return {
+    name: parsePackageNameFromPath(
+      filePathReal.substring(lastNodeModulesIndex)
+    ),
+    cleanPath: filePathReal,
+  }
+}
+
+export const getPackageJSONFromPath = memoize(
+  (filePath: string) => {
+    const { cleanPath, name } = getPackageFromWebpackPath(filePath)
+    const packageRoot = cleanPath.substring(
+      0,
+      cleanPath.lastIndexOf(name) + name.length
+    )
+    try {
+      const packageJSON = require(path.join(packageRoot, 'package.json'))
+      return packageJSON
+    } catch (err) {
+      return null
+    }
+  },
+  { max: 1000 }
+)
+
+export async function updateProjectPeerDependencies(
+  projectPath: string,
+  peerDependencies: {
+    [key: string]: string
+  }
+) {
+  const packageJSONPath = path.join(projectPath, 'package.json')
+  const packageJSONContents = JSON.parse(
+    await fs.promises.readFile(packageJSONPath, 'utf-8')
+  )
+  const updatedJSON = {
+    ...packageJSONContents,
+    peerDependencies: {
+      ...packageJSONContents.peerDependencies,
+      ...peerDependencies,
+    },
+  }
+  await fs.promises.writeFile(
+    packageJSONPath,
+    JSON.stringify(updatedJSON, null, 2),
+    'utf-8'
+  )
+}
+
+export async function updateProjectEntries(
+  projectPath: string,
+  entries: {
+    [key: string]: string
+  }
+) {
+  return
+  const packageJSONPath = path.join(projectPath, 'package.json')
+  const packageJSONContents = JSON.parse(
+    await fs.promises.readFile(packageJSONPath, 'utf-8')
+  )
+  const updatedJSON = {
+    ...packageJSONContents,
+    targets: Object.fromEntries(
+      Object.entries(entries).map(([entryName, entryPath]) => [
+        entryName,
+        {
+          source: entryName + '.html',
+        },
+      ])
+    ),
+  }
+
+  await fs.promises.writeFile(
+    packageJSONPath,
+    JSON.stringify(updatedJSON, null, 2),
+    'utf-8'
+  )
+}
+
+/**
+ * eg.
+ * loader!/private/tmp/tmp-build/packages/build-gulp-ORQ/node_modules/.pnpm/is-data@0.1.4/node_modules/is-data/index.ts =>  is-data/index.ts
+ */
+export function cleanWebpackPath(filePath: string, installPath: string) {
+  // Webpack paths are of the form `loader!path`
+  let filePathReal = filePath.includes('!')
+    ? filePath.split('!')[filePath.split('!').length - 1]
+    : filePath
+  let fragments = filePathReal
+    .substring(filePathReal.indexOf(installPath) + installPath.length + 1)
+    .split(path.sep)
+  // let currentFragment = fragments[0]
+  // while (['node_modules', '.pnpm'].includes(currentFragment)) {
+  //   currentFragment = fragments.shift() || ''
+  // }
+  return filePath //fragments.join(path.sep)
+}
+
+exports.cleanWebpackPath = cleanWebpackPath
+
+export function isReactNativePackage(packageName: string) {
+  return packageName.startsWith('react-native')
+}
+
+export function printDiagnosticError(error: ThrowableDiagnostic) {
+  error.diagnostics.forEach(diagnostic => {
+    console.error(
+      ...[diagnostic.name, diagnostic.origin, diagnostic.message].filter(
+        Boolean
+      )
+    )
+    diagnostic.codeFrames?.forEach(codeFrame => {
+      codeFrame.codeHighlights.forEach(highlight => {
+        if (codeFrame.code) codeFrameColumns(codeFrame.code, highlight)
+      })
+    })
+  })
+}

package/src/utils/exports.utils.ts

@@ -3,7 +3,6 @@ import traverse from '@babel/traverse'
 import path from 'path'
 import { promises as fs } from 'fs'
 import enhancedResolve from 'enhanced-resolve'
-import makeWebpackConfig from '../config/makeWebpackConfig'
 import {
   ArrayPattern,
   AssignmentPattern,
@@ -47,8 +46,8 @@ export function getExportsDetails(code: string) {
             result.push(property.value.name)
           }
           break
-        // default:
-        //   assertUnreachable(property.type)
+        default:
+          assertUnreachable(property)
       }
     })
   }
@@ -73,8 +72,8 @@ export function getExportsDetails(code: string) {
       case 'MemberExpression':
         // unhandled
         break
-      // default:
-      //   assertUnreachable(element.left.type)
+      default:
+        assertUnreachable(element.left)
     }
   }
 
@@ -109,13 +108,14 @@ export function getExportsDetails(code: string) {
             processAssignmentPattern(element, result)
             break
 
-          // default:
-          //   assertUnreachable(element.type)
+          default:
+            assertUnreachable(element)
         }
       }
     })
   }
 
+  // @ts-ignore
   traverse(ast, {
     ExportNamedDeclaration(path) {
       const { specifiers, declaration } = path.node
@@ -148,8 +148,8 @@ export function getExportsDetails(code: string) {
                 case 'TSParameterProperty':
                   // unhandled
                   break
-                // default:
-                //   assertUnreachable(dec.id.type)
+                default:
+                  assertUnreachable(dec.id)
               }
             })
             break
@@ -191,7 +191,16 @@ export function getExportsDetails(code: string) {
         }
       } else {
         specifiers.forEach(specifier => {
-          exportsList.push(specifier.exported.name)
+          switch (specifier.exported.type) {
+            case 'Identifier':
+              exportsList.push(specifier.exported.name)
+              break
+
+            // The below case not be verified !!
+            case 'StringLiteral':
+              exportsList.push(specifier.exported.value)
+              break
+          }
         })
       }
     },
@@ -211,18 +220,21 @@ export function getExportsDetails(code: string) {
   }
 }
 
-const webpackConfig = makeWebpackConfig({
-  packageName: '',
-  entry: '',
-  externals: { externalPackages: [], externalBuiltIns: [] },
-  minifier: 'terser',
-})
-
 const resolver = enhancedResolve.create({
-  extensions: webpackConfig?.resolve?.extensions,
-  modules: webpackConfig?.resolve?.modules,
-  // @ts-ignore Error due to unsynced types for enhanced resolve and webpack
-  mainFields: webpackConfig?.resolve?.mainFields,
+  modules: ['node_modules'],
+  extensions: [
+    '.web.mjs',
+    '.mjs',
+    '.web.js',
+    '.js',
+    '.mjs',
+    '.json',
+    '.css',
+    '.sass',
+    '.scss',
+  ],
+  mainFields: ['browser', 'module', 'main', 'style'],
+  conditionNames: ['module', 'import', 'style', 'default'],
 })
 
 const resolve = async (context: string, path: string): Promise<string> =>
@@ -239,6 +251,7 @@ const resolve = async (context: string, path: string): Promise<string> =>
 type ResolvedExports = {
   [key: string]: string
 }
+
 /**
  * Recursively get all exports starting
  * from a given path

package/src/utils/installation.utils.ts

@@ -1,13 +1,14 @@
-import shortId from 'shortid'
 import rimraf from 'rimraf'
+import shortId from 'shortid'
 import path from 'path'
 import { promises as fs } from 'fs'
 import sanitize from 'sanitize-filename'
+import semver from 'semver'
 
 const debug = require('debug')('bp:worker')
 import { InstallError, PackageNotFoundError } from '../errors/CustomError'
-import { exec } from './common.utils'
-import config from '../config/config'
+import { exec, parsePackageString } from './common.utils'
+import config from '../config'
 import { InstallPackageOptions } from '../common.types'
 import Telemetry from './telemetry.utils'
 import { performance } from 'perf_hooks'
@@ -23,6 +24,7 @@ const InstallationUtils = {
     return path.join(
       config.tmp,
       'packages',
+
       sanitize(`build-${packageName}-${id}`)
     )
   },
@@ -32,6 +34,10 @@ const InstallationUtils = {
 
     await fs.mkdir(config.tmp, { recursive: true })
     await fs.mkdir(installPath, { recursive: true })
+    await fs.mkdir(path.join(installPath, '.git'), {
+      recursive: true,
+    })
+    await fs.writeFile(path.join(installPath, 'yarn.lock'), '')
 
     await fs.writeFile(
       path.join(installPath, 'package.json'),
@@ -56,6 +62,7 @@ const InstallationUtils = {
   ) {
     let flags, command
     let installStartTime = performance.now()
+    const { version } = parsePackageString(packageString)
 
     const {
       client = 'npm',
@@ -104,6 +111,7 @@ const InstallationUtils = {
         'ignore-scripts',
         'save-exact',
         'production',
+        'legacy-peer-deps',
         'json',
       ]
 
@@ -111,11 +119,26 @@ const InstallationUtils = {
         isLocal ? wrapPackCommand(packageString) : packageString
       } ${additionalPackages.join(' ')} --${flags.join(' --')}`
     } else if (client === 'pnpm') {
-      flags = ['no-optional', 'loglevel error', 'ignore-scripts', 'save-exact']
+      flags = [
+        'no-optional',
+        'loglevel error',
+        'ignore-scripts',
+        'save-exact',
+        `store-dir=${path.join(config.tmp, 'cache', 'pnpm-cache')}`,
+        `virtual-store-dir=${path.join(
+          config.tmp,
+          'cache',
+          'pnpm-cache-virtual'
+        )}`,
+      ]
+
+      if (semver.valid(version)) {
+        flags.push(`prefer-offline`)
+      }
 
       command = `pnpm add ${packageString} ${additionalPackages.join(
         ' '
-      )} --${[].join(' --')}`
+      )} --${flags.join(' --')}`
     } else {
       console.error('No valid client specified')
       process.exit(1)

package/src/utils/telemetry.utils.ts

@@ -107,20 +107,6 @@ export default class Telemetry {
     })
   }
 
-  static parseWebpackStats(
-    packageName: string,
-    isSuccessful: boolean,
-    startTime: number,
-    error: any = null
-  ) {
-    emitter.emit('TASK_PACKAGE_PARSE_WEBPACK_STATS', {
-      package: { name: packageName },
-      isSuccessful,
-      duration: performance.now() - startTime,
-      error: errorToObject(error),
-    })
-  }
-
   static dependencySizes(
     packageName: string,
     startTime: number,
@@ -137,13 +123,6 @@ export default class Telemetry {
     })
   }
 
-  static assetsGZIPParseTime(packageName: string, startTime: number) {
-    emitter.emit('TASK_PACKAGE_ASSETS_GZIP_PARSE_TIME', {
-      package: { name: packageName },
-      duration: performance.now() - startTime,
-    })
-  }
-
   static walkPackageExportsTree(
     packageString: string,
     startTime: number,

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017 Shubham Kanodia
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,67 +0,0 @@
-<img src="https://img.shields.io/npm/v/package-build-stats.svg" /> <img src="https://img.shields.io/npm/l/package-build-stats.svg" /> <img src="https://img.shields.io/github/workflow/status/pastelsky/package-build-stats/CI/master"/>
-
-This is the function that powers the core of building, minifying and gzipping of packages in bundlephobia.
-
-## Usage
-
-```js
-const { getPackageStats } = require('package-build-stats')
-```
-
-#### Building packages from npm
-
-##### Building the latest stable version
-
-```js
-const results = await getPackageStats('moment')
-```
-
-##### Building a specific version / tag
-
-```js
-const results = await getPackageStats('moment@2.24.0')
-```
-
-##### Building local packages (beta)
-
-```js
-const results = await getPackageStats('~/dev/my-npm-package') // must have a package.json
-```
-
-#### Passing options to the build
-
-```js
-const results = await getBuiltPackageStats('moment', options)
-```
-
-##### Options
-
-| Option             | Values                | Default  | Description                                                                                                                                                     |
-| ------------------ | --------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| client             | `npm` or `yarn`       | `npm`    | Which client to use to install package for building                                                                                                             |
-| limitConcurrency   | `true` or `false`     | `false`  | When using `yarn` as the client, use the network mutex to limit concurrency                                                                                     |
-| networkConcurrency | `number`              | `false`  | When using `yarn` as client, limit simultaneous installs to this number.                                                                                        |
-| customImports      | `Array<string>`       | `null`   | By default, the default export is used for calculating sizes. Setting this option allows calculation of package stats based on more granular top-level exports. |
-| minifier           | `terser` or `esbuild` | `terser` | ESbuild is faster, albeit with marginally larger file sizes                                                                                                     |
-| installTimeout     | number (ms)           | 30000    | Timeout for package install                                                                                                                                     |
-
-## Listening to events
-
-`package-build-stats` emits various lifecycle events when building a package.
-You can listen to these events by subscribing to the event emitter (based on [mitt](https://github.com/developit/mitt)).
-
-```js
-import { eventQueue } from 'package-build-stats'
-
-// Listen to all events
-eventQueue.on('*', callback)
-
-// Listen to specific events
-eventQueue.on('TASK_PACKAGE_BUILD', callback)
-```
-
-For a list of all events, see [this](src/utils/telemetry.utils.ts).
-
-## Contributing
-
-See [contributing guide.](CONTRIBUTING.md)

package/build/common.types.d.ts

@@ -1,34 +0,0 @@
-declare type Minifier = 'esbuild' | 'terser';
-declare type AllOptions = {
-    customImports?: Array<string>;
-    splitCustomImports?: boolean;
-    debug?: boolean;
-    calcParse?: boolean;
-    esm?: boolean;
-    entryFilename?: string;
-    client?: 'npm' | 'yarn';
-    limitConcurrency?: boolean;
-    networkConcurrency?: number;
-    additionalPackages?: Array<string>;
-    isLocal?: boolean;
-    installTimeout?: number;
-};
-export declare type BuildPackageOptions = Pick<AllOptions, 'customImports' | 'splitCustomImports' | 'debug' | 'calcParse'> & {
-    includeDependencySizes: boolean;
-    minifier: Minifier;
-};
-export declare type CreateEntryPointOptions = Pick<AllOptions, 'esm' | 'customImports' | 'entryFilename'>;
-export declare type InstallPackageOptions = Pick<AllOptions, 'client' | 'limitConcurrency' | 'networkConcurrency' | 'additionalPackages' | 'isLocal' | 'installTimeout'>;
-export declare type GetPackageStatsOptions = Pick<AllOptions, 'client' | 'limitConcurrency' | 'networkConcurrency' | 'debug' | 'customImports' | 'installTimeout'> & {
-    minifier?: Minifier;
-};
-export declare type Externals = {
-    externalPackages: Array<string>;
-    externalBuiltIns: Array<string>;
-};
-export declare type WebpackError = {
-    name: 'ModuleNotFoundError';
-    details?: string;
-    error: Error;
-};
-export {};

package/build/common.types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/config/config.d.ts

@@ -1,4 +0,0 @@
-declare const _default: {
-    tmp: string;
-};
-export default _default;

package/build/config/config.js

@@ -1,10 +0,0 @@
-"use strict";
-// Use ES6 supported by Node v6.10 only!
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-exports.default = {
-    tmp: path_1.default.join('/tmp', 'tmp-build'),
-};

package/build/config/makeWebpackConfig.d.ts

@@ -1,11 +0,0 @@
-import webpack, { Entry } from 'webpack';
-import { Externals } from '../common.types';
-declare type MakeWebpackConfigOptions = {
-    packageName: string;
-    externals: Externals;
-    debug?: boolean;
-    entry: string | string[] | Entry;
-    minifier: 'esbuild' | 'terser';
-};
-export default function makeWebpackConfig({ packageName, entry, externals, debug, minifier, }: MakeWebpackConfigOptions): webpack.Configuration;
-export {};