@modern-js/utils 1.2.1 → 1.2.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @modern-js/utils
 
+## 1.2.2
+
+### Patch Changes
+
+- 83166714: change .npmignore
+
 ## 1.2.1
 
 ### Patch Changes

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.2.1",
+  "version": "1.2.2",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",

package/src/FileSizeReporter.ts

@@ -1,181 +0,0 @@
-/* eslint-disable eslint-comments/no-unlimited-disable */
-/* eslint-disable */
-/**
- * Copyright (c) 2015-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file at
- * https://github.com/facebook/create-react-app/blob/master/LICENSE
- */
-
-// Modified by Chao Xu (xuchaobei)
-'use strict';
-
-import fs from 'fs';
-import path from 'path';
-import chalk from 'chalk';
-import filesize from 'filesize';
-import recursive from 'recursive-readdir';
-import stripAnsi from 'strip-ansi';
-import gzipSize from 'gzip-size';
-import { logger } from './logger';
-
-
-function canReadAsset(asset:string) {
-  return (
-    /\.(js|css)$/.test(asset) &&
-    !/service-worker\.js/.test(asset) &&
-    !/precache-manifest\.[0-9a-f]+\.js/.test(asset)
-  );
-}
-
-// Prints a detailed summary of build files.
-function printFileSizesAfterBuild(
-  webpackStats:any,
-  previousSizeMap:{root:string, sizes:Record<string, number[]>},
-  buildFolder:string,
-  maxBundleGzipSize:number,
-  maxChunkGzipSize:number
-) {
-  var root = previousSizeMap.root;
-  var sizes = previousSizeMap.sizes;
-  var assets = (webpackStats.stats || [webpackStats])
-    .map((stats:any) =>
-      stats
-        .toJson({ all: false, assets: true })
-        .assets.filter((asset:any) => canReadAsset(asset.name))
-        .map((asset:any) => {
-          var fileContents = fs.readFileSync(path.join(root, asset.name));
-          var size = fileContents.length;
-          var gzippedSize = gzipSize.sync(fileContents);
-          var [previousSize, previousGzipSize] = sizes[removeFileNameHash(root, asset.name)] || [];
-          var sizeDifference = getDifferenceLabel(size, previousSize);
-          var gzipSizeDifference = getDifferenceLabel(gzippedSize, previousGzipSize);
-          return {
-            folder: path.join(
-              path.basename(buildFolder),
-              path.dirname(asset.name)
-            ),
-            name: path.basename(asset.name),
-            gzippedSize: gzippedSize,
-            sizeLabel: filesize(size) + (sizeDifference ? ' (' + sizeDifference + ')' : ''),
-            gzipSizeLabel: filesize(gzippedSize) + (gzipSizeDifference ? ' (' + gzipSizeDifference + ')' : ''),
-          };
-        })
-    )
-    .reduce((single:any, all:any) => all.concat(single), []);
-  assets.sort((a:any, b:any) => b.size - a.size);
-  var longestSizeLabelLength = Math.max.apply(
-    null,
-    assets.map((a:any) => stripAnsi(a.sizeLabel).length)
-  );
-  var longestFileNameLength = Math.max.apply(
-    null,
-    assets.map((a:any) => stripAnsi(a.folder + path.sep + a.name).length)
-  );
-
-  printFileSizesHeader(longestFileNameLength, longestSizeLabelLength);
-
-  var suggestBundleSplitting = false;
-  assets.forEach((asset:any) => {
-    var {folder, name, sizeLabel, gzipSizeLabel, gzippedSize} = asset;
-    var fileNameLength = stripAnsi(folder + path.sep + name).length;
-    var sizeLength = stripAnsi(sizeLabel).length;
-    if (sizeLength < longestSizeLabelLength) {
-      var rightPadding = ' '.repeat(longestSizeLabelLength - sizeLength);
-      sizeLabel += rightPadding;
-    }
-    var fileNameLabel = chalk.dim(asset.folder + path.sep) + chalk.cyan(asset.name);
-    if (fileNameLength < longestFileNameLength) {
-      var rightPadding = ' '.repeat(longestFileNameLength - fileNameLength);
-      fileNameLabel += rightPadding;
-    }
-    var isMainBundle = asset.name.indexOf('main.') === 0;
-    var maxRecommendedSize = isMainBundle
-      ? maxBundleGzipSize
-      : maxChunkGzipSize;
-    var isLarge = maxRecommendedSize && gzippedSize > maxRecommendedSize;
-    if (isLarge && path.extname(asset.name) === '.js') {
-      suggestBundleSplitting = true;
-    }
-    logger.log(
-      '  ' + fileNameLabel +
-      '    ' + sizeLabel +
-      '    ' + (isLarge ? chalk.yellow(gzipSizeLabel) : gzipSizeLabel)
-    );
-  });
-  if (suggestBundleSplitting) {
-    logger.log();
-    logger.warn(
-      'The bundle size is significantly larger than recommended.'
-    );
-  }
-}
-
-function printFileSizesHeader(longestFileNameLength:number, longestSizeLabelLength:number){
-  const longestLengths = [longestFileNameLength, longestSizeLabelLength]
-  const headerRow = ['File', 'Size', 'Gzipped'].reduce((prev, cur, index) => {
-    const length = longestLengths[index];
-    let curLabel = cur;
-    if(length){
-      curLabel =  cur.length < length ? cur + ' '.repeat(length - cur.length) : cur;
-    }
-    return prev + curLabel + '    ';
-  }, '  ')
-
-  logger.log(chalk.bold(chalk.blue(headerRow)))
-}
-
-function removeFileNameHash(buildFolder:string, fileName:string) {
-  return fileName
-    .replace(buildFolder, '')
-    .replace(/\\/g, '/')
-    .replace(
-      /\/?(.*)(\.[0-9a-f]+)(\.chunk)?(\.js|\.css)/,
-      (match, p1, p2, p3, p4) => p1 + p4
-    );
-}
-
-// Input: 1024, 2048
-// Output: "(+1 KB)"
-function getDifferenceLabel(currentSize:number, previousSize:number) {
-  var FIFTY_KILOBYTES = 1024 * 50;
-  var difference = currentSize - previousSize;
-  var fileSize = !Number.isNaN(difference) ? filesize(difference) : 0;
-  if (difference >= FIFTY_KILOBYTES) {
-    return chalk.red('+' + fileSize);
-  } else if (difference < FIFTY_KILOBYTES && difference > 0) {
-    return chalk.yellow('+' + fileSize);
-  } else if (difference < 0) {
-    return chalk.green(fileSize);
-  } else {
-    return '';
-  }
-}
-
-function measureFileSizesBeforeBuild(buildFolder:string):Promise<{root:string; sizes: Record<string, number[]>}> {
-  return new Promise(resolve => {
-    recursive(buildFolder, (err, fileNames) => {
-      var sizes;
-      if (!err && fileNames) {
-        sizes = fileNames.filter(canReadAsset).reduce<Record<string, [number,number]>>((memo, fileName) => {
-          var contents = fs.readFileSync(fileName);
-          var key = removeFileNameHash(buildFolder, fileName);
-          // save both the original size and gzip size
-          memo[key] = [contents.length, gzipSize.sync(contents)]
-          return memo;
-        }, {});
-      }
-      resolve({
-        root: buildFolder,
-        sizes: sizes || {},
-      });
-    });
-  });
-}
-
-export {
-  measureFileSizesBeforeBuild,
-  printFileSizesAfterBuild,
-};
-/* eslint-enable */

package/src/alias.ts

@@ -1,90 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import chalk from 'chalk';
-import { readTsConfigByFile } from './readTsConfig';
-import { applyOptionsChain } from './applyOptionsChain';
-
-type AliasOption =
-  | Record<string, string>
-  | ((aliases: Record<string, string>) => Record<string, unknown>)
-  | Record<string, string>
-  | undefined;
-
-interface NormalizedConfig {
-  source: {
-    alias?: AliasOption | Array<AliasOption>;
-  };
-}
-
-interface IAliasConfig {
-  absoluteBaseUrl: string;
-  paths?: Record<string, string | string[]>;
-  isTsPath?: boolean;
-  isTsProject?: boolean;
-}
-
-export const validAlias = <T extends NormalizedConfig>(
-  modernConfig: T,
-  { tsconfigPath }: { tsconfigPath: string },
-) => {
-  const {
-    source: { alias },
-  } = modernConfig;
-  if (!alias) {
-    return null;
-  }
-
-  const isTsProject = fs.existsSync(tsconfigPath);
-  if (!isTsProject) {
-    return null;
-  }
-
-  const userAlias = getUserAlias(alias as Record<string, string>);
-  if (Object.keys(userAlias).length > 0) {
-    return chalk.red(
-      'Note: Please use `compilerOptions.paths` in "tsconfig.json" file replace `source.alias` config in "modern.config.js/ts" when project is typescript',
-    );
-  }
-
-  return null;
-};
-
-export const getAlias = (
-  aliasOption: AliasOption | Array<AliasOption>,
-  option: { appDirectory: string; tsconfigPath: string },
-) => {
-  const isTsProject = fs.existsSync(option.tsconfigPath);
-  let aliasConfig: IAliasConfig;
-  if (!isTsProject) {
-    aliasConfig = {
-      absoluteBaseUrl: option.appDirectory,
-      paths: applyOptionsChain({ '@': ['./src'] }, aliasOption as any),
-      isTsPath: false,
-      isTsProject,
-    };
-  } else {
-    const tsconfig = readTsConfigByFile(option.tsconfigPath);
-    const baseUrl = tsconfig?.compilerOptions?.baseUrl;
-    aliasConfig = {
-      absoluteBaseUrl: baseUrl
-        ? path.join(option.appDirectory, baseUrl)
-        : option.appDirectory,
-      paths: {
-        ...(aliasOption || {}),
-        ...tsconfig?.compilerOptions?.paths,
-      },
-      isTsPath: true,
-      isTsProject,
-    };
-  }
-  return aliasConfig;
-};
-
-// filter invalid ts paths that are not array
-export const getUserAlias = (alias: Record<string, string | string[]> = {}) =>
-  Object.keys(alias).reduce((o, k) => {
-    if (Array.isArray(alias[k])) {
-      o[k] = alias[k];
-    }
-    return o;
-  }, {} as Record<string, string | string[]>);

package/src/applyOptionsChain.ts

@@ -1,44 +0,0 @@
-// eslint-disable-next-line import/no-useless-path-segments
-import { isFunction, logger, isPlainObject } from './index';
-
-export const applyOptionsChain = <T, U>(
-  defaults: T,
-  /* eslint-disable @typescript-eslint/no-invalid-void-type */
-  options?:
-    | T
-    | ((config: T, utils?: U) => T | void)
-    | Array<T | ((config: T, utils?: U) => T | void)>,
-  /* eslint-enable @typescript-eslint/no-invalid-void-type */
-  utils?: U,
-  mergeFn = Object.assign,
-): T => {
-  if (!options) {
-    return defaults;
-  }
-
-  if (isPlainObject(options) as any) {
-    return mergeFn(defaults, options);
-  } else if (isFunction(options)) {
-    const ret = options(defaults, utils);
-    if (ret) {
-      if (!isPlainObject(ret)) {
-        logger.warn(
-          `${options.name}: Function should mutate the config and return nothing, Or return a cloned or merged version of config object.`,
-        );
-      }
-      return ret;
-    }
-  } else if (Array.isArray(options)) {
-    return options.reduce<T>(
-      (memo, cur) => applyOptionsChain(memo, cur, utils, mergeFn),
-      defaults,
-    );
-  } else {
-    throw new Error(
-      `applyOptionsChain error:\ndefault options is: ${JSON.stringify(
-        defaults,
-      )}`,
-    );
-  }
-  return defaults;
-};

package/src/chalk.ts

@@ -1,3 +0,0 @@
-import chalk from 'chalk';
-
-export { chalk };

package/src/clearConsole.ts

@@ -1,5 +0,0 @@
-export const clearConsole = () => {
-  if (process.stdout.isTTY) {
-    process.stdout.write('\x1B[H\x1B[2J');
-  }
-};

package/src/compatRequire.ts

@@ -1,25 +0,0 @@
-import { findExists } from './findExists';
-
-/**
- * Require function compatible with esm and cjs module.
- * @param filePath - File to required.
- * @returns module export object.
- */
-export const compatRequire = (filePath: string) => {
-  const mod = require(filePath);
-
-  return mod?.__esModule ? mod.default : mod;
-};
-
-export const requireExistModule = (
-  filename: string,
-  extensions = ['.ts', '.js'],
-) => {
-  const exist = findExists(extensions.map(ext => `${filename}${ext}`));
-
-  if (!exist) {
-    return null;
-  }
-
-  return compatRequire(exist);
-};

package/src/constants.ts

@@ -1,265 +0,0 @@
-/**
- * alias to src directory
- */
-export const INTERNAL_SRC_ALIAS = '@_modern_js_src';
-
-/**
- * alias to node_modules/.modern-js
- */
-export const INTERNAL_DIR_ALAIS = '@_modern_js_internal';
-
-/**
- * hmr socket connect path
- */
-export const HMR_SOCK_PATH = '/_modern_js_hmr_ws';
-
-/**
- * route specification file
- */
-export const ROUTE_SPEC_FILE = 'route.json';
-
-/**
- * main entry name
- */
-export const MAIN_ENTRY_NAME = 'main';
-
-/**
- * open editor request path
- */
-export const LAUNCH_EDITOR_ENDPOINT = '/__open-stack-frame-in-editor';
-
-/**
- * server side bundles directory, which relative to dist.
- */
-export const SERVER_BUNDLE_DIRECTORY = 'bundles';
-
-/**
- * entry name pattern used for ajv pattern properties.
- */
-export const ENTRY_NAME_PATTERN = '^[a-zA-Z0-9_-]+$';
-
-/**
- * SSR server render function name
- */
-export const SERVER_RENDER_FUNCTION_NAME = 'serverRender';
-
-/**
- * loadbale manifest json file
- */
-export const LOADABLE_STATS_FILE = 'loadable-stats.json';
-
-/**
- * real entry generate by modern.js
- */
-export const HIDE_MODERN_JS_DIR = './node_modules/.modern-js';
-
-/**
- * internal specified folder
- */
-export const API_DIR = 'api';
-
-export const SERVER_DIR = 'server';
-
-export const SHARED_DIR = 'shared';
-
-/**
- * Internal plugins that work as soon as they are installed.
- */
-export const INTERNAL_PLUGINS: {
-  [name: string]: { cli?: string; server?: string };
-} = {
-  '@modern-js/app-tools': { cli: '@modern-js/app-tools/cli' },
-  '@modern-js/monorepo-tools': { cli: '@modern-js/monorepo-tools/cli' },
-  '@modern-js/module-tools': { cli: '@modern-js/module-tools/cli' },
-  '@modern-js/runtime': { cli: '@modern-js/runtime/cli' },
-  '@modern-js/plugin-less': { cli: '@modern-js/plugin-less/cli' },
-  '@modern-js/plugin-sass': { cli: '@modern-js/plugin-sass/cli' },
-  '@modern-js/plugin-esbuild': { cli: '@modern-js/plugin-esbuild/cli' },
-  '@modern-js/plugin-proxy': { cli: '@modern-js/plugin-proxy/cli' },
-  '@modern-js/plugin-ssg': { cli: '@modern-js/plugin-ssg/cli' },
-  '@modern-js/plugin-bff': {
-    cli: '@modern-js/plugin-bff/cli',
-    server: '@modern-js/plugin-bff/server',
-  },
-  '@modern-js/plugin-electron': { cli: '@modern-js/plugin-electron/cli' },
-  '@modern-js/plugin-testing': { cli: '@modern-js/plugin-testing/cli' },
-  '@modern-js/plugin-storybook': { cli: '@modern-js/plugin-storybook/cli' },
-  '@modern-js/plugin-docsite': { cli: '@modern-js/plugin-docsite/cli' },
-  '@modern-js/plugin-express': {
-    cli: '@modern-js/plugin-express/cli',
-    server: '@modern-js/plugin-express',
-  },
-  '@modern-js/plugin-egg': {
-    cli: '@modern-js/plugin-egg/cli',
-    server: '@modern-js/plugin-egg',
-  },
-  '@modern-js/plugin-koa': {
-    cli: '@modern-js/plugin-koa/cli',
-    server: '@modern-js/plugin-koa',
-  },
-  '@modern-js/plugin-nest': {
-    cli: '@modern-js/plugin-nest/cli',
-    server: '@modern-js/plugin-nest/server',
-  },
-  '@modern-js/plugin-unbundle': { cli: '@modern-js/plugin-unbundle' },
-  '@modern-js/plugin-server-build': { cli: '@modern-js/plugin-server-build' },
-  '@modern-js/plugin-server': {
-    cli: '@modern-js/plugin-server/cli',
-    server: '@modern-js/plugin-server/server',
-  },
-  '@modern-js/plugin-micro-frontend': {
-    cli: '@modern-js/plugin-micro-frontend/cli',
-  },
-  '@modern-js/plugin-jarvis': { cli: '@modern-js/plugin-jarvis/cli' },
-  '@modern-js/plugin-tailwindcss': { cli: '@modern-js/plugin-tailwindcss/cli' },
-  '@modern-js/plugin-lambda-fc': { cli: '@modern-js/plugin-lambda-fc/cli' },
-  '@modern-js/plugin-lambda-scf': { cli: '@modern-js/plugin-lambda-scf/cli' },
-  '@modern-js/plugin-cdn-oss': { cli: '@modern-js/plugin-cdn-oss/cli' },
-  '@modern-js/plugin-cdn-cos': { cli: '@modern-js/plugin-cdn-cos/cli' },
-  '@modern-js/plugin-static-hosting': {
-    cli: '@modern-js/plugin-static-hosting/cli',
-  },
-  '@modern-js/plugin-polyfill': {
-    cli: '@modern-js/plugin-polyfill/cli',
-    server: '@modern-js/plugin-polyfill',
-  },
-  '@modern-js/plugin-multiprocess': {
-    cli: '@modern-js/plugin-multiprocess/cli',
-  },
-  '@modern-js/plugin-nocode': { cli: '@modern-js/plugin-nocode/cli' },
-};
-
-/**
- * The schema registered in the plugin.
- */
-export const PLUGIN_SCHEMAS = {
-  '@modern-js/runtime': [
-    {
-      target: 'runtime',
-      schema: {
-        type: 'object',
-        additionalProperties: false,
-      },
-    },
-    {
-      target: 'runtimeByEntries',
-      schema: {
-        type: 'object',
-        patternProperties: { [ENTRY_NAME_PATTERN]: { type: 'object' } },
-        additionalProperties: false,
-      },
-    },
-  ],
-  '@modern-js/plugin-bff': [
-    {
-      target: 'bff',
-      schema: {
-        type: 'object',
-        properties: {
-          prefix: {
-            type: ['string', 'array'],
-            items: { type: 'string' },
-          },
-          fetcher: { type: 'string' },
-          proxy: { type: 'object' },
-          requestCreator: { type: 'string' },
-        },
-      },
-    },
-  ],
-  '@modern-js/plugin-esbuild': [
-    {
-      target: 'tools.esbuild',
-      schema: { typeof: ['object'] },
-    },
-  ],
-  '@modern-js/plugin-less': [
-    {
-      target: 'tools.less',
-      schema: { typeof: ['object', 'function'] },
-    },
-  ],
-  '@modern-js/plugin-sass': [
-    {
-      target: 'tools.sass',
-      schema: { typeof: ['object', 'function'] },
-    },
-  ],
-  '@modern-js/plugin-tailwindcss': [
-    {
-      target: 'tools.tailwindcss',
-      schema: { typeof: ['object', 'function'] },
-    },
-    {
-      target: 'source.designSystem',
-      schema: { typeof: ['object'] },
-    },
-  ],
-  '@modern-js/plugin-proxy': [
-    {
-      target: 'dev.proxy',
-      schema: { typeof: ['string', 'object'] },
-    },
-  ],
-  '@modern-js/plugin-unbundle': [
-    {
-      target: 'source.disableAutoImportStyle',
-      schema: { type: 'boolean' },
-    },
-    {
-      target: 'server.https',
-      schema: { type: 'boolean' },
-    },
-  ],
-  '@modern-js/plugin-ssg': [
-    {
-      target: 'output.ssg',
-      schema: {
-        oneOf: [
-          { type: 'boolean' },
-          { type: 'object' },
-          { instanceof: 'Function' },
-        ],
-      },
-    },
-  ],
-  '@modern-js/plugin-ssr': [
-    {
-      target: 'runtime.ssr',
-      schema: { type: ['boolean', 'object'] },
-    },
-  ],
-  '@modern-js/plugin-state': [
-    {
-      target: 'runtime.state',
-      schema: { type: ['boolean', 'object'] },
-    },
-  ],
-  '@modern-js/plugin-router': [
-    {
-      target: 'runtime.router',
-      schema: { type: ['boolean', 'object'] },
-    },
-  ],
-  '@modern-js/plugin-testing': [
-    {
-      target: 'testing',
-      schema: { typeof: ['object'] },
-    },
-    {
-      target: 'tools.jest',
-      schema: { typeof: ['object', 'function'] },
-    },
-  ],
-  '@modern-js/plugin-micro-frontend': [
-    {
-      target: 'runtime.masterApp',
-      schema: { type: ['object'] },
-    },
-    {
-      target: 'dev.withMasterApp',
-      schema: { type: ['object'] },
-    },
-  ],
-  '@modern-js/plugin-nocode': [],
-};

package/src/debug.ts

@@ -1,8 +0,0 @@
-import debug from 'debug';
-
-/**
- * Create debug function with unified namespace prefix.
- * @param scope - Custom module name of your debug function.
- * @returns Debug function which namespace start with modern-js:.
- */
-export const createDebugger = (scope: string) => debug(`modern-js:${scope}`);

package/src/ensureAbsolutePath.ts

@@ -1,10 +0,0 @@
-import path from 'path';
-
-/**
- * ensure absolute file path.
- * @param base - Base path to resolve relative from.
- * @param filePath - Aboluste or relative file path.
- * @returns Resolved absolute file path.
- */
-export const ensureAbsolutePath = (base: string, filePath: string): string =>
-  path.isAbsolute(filePath) ? filePath : path.resolve(base, filePath);

package/src/findExists.ts

@@ -1,15 +0,0 @@
-import fs from 'fs';
-
-/**
- * Find first already exists file.
- * @param files - Asbolute file paths with extension.
- * @returns The file path if exists, or false if no file exists.
- */
-export const findExists = (files: string[]): string | false => {
-  for (const file of files) {
-    if (fs.existsSync(file) && fs.statSync(file).isFile()) {
-      return file;
-    }
-  }
-  return false;
-};