@modern-js/utils 1.2.0 → 1.3.1

package/src/constants.ts

@@ -1,262 +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': { 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;
-};

package/src/formatWebpackMessages.ts

@@ -1,131 +0,0 @@
-/* eslint-disable no-param-reassign */
-/* eslint-disable max-statements */
-/**
- * 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)
-
-import webpack, { StatsCompilation } from 'webpack';
-
-const friendlySyntaxErrorLabel = 'Syntax error:';
-
-function isLikelyASyntaxError(message: string) {
-  return message.includes(friendlySyntaxErrorLabel);
-}
-
-// Cleans up webpack error messages.
-function formatMessage(message: webpack.StatsError | string) {
-  let lines: string[] = [];
-
-  // webpack 5 stats error object
-  if (typeof message === 'object') {
-    message = `${(message.moduleName && `${message.moduleName}\n`) as string}${
-      message.details || message.stack || message.message
-    }`;
-  }
-
-  lines = message.split('\n');
-
-  // Strip webpack-added headers off errors/warnings
-  // https://github.com/webpack/webpack/blob/master/lib/ModuleError.js
-  lines = lines.filter(line => !/Module [A-z ]+\(from/.test(line));
-
-  // Transform parsing error into syntax error
-  lines = lines.map(line => {
-    const parsingError = /Line (\d+):(?:(\d+):)?\s*Parsing error: (.+)$/.exec(
-      line,
-    );
-    if (!parsingError) {
-      return line;
-    }
-    const [, errorLine, errorColumn, errorMessage] = parsingError;
-    return `${friendlySyntaxErrorLabel} ${errorMessage} (${errorLine}:${errorColumn})`;
-  });
-
-  message = lines.join('\n');
-
-  // Smoosh syntax errors (commonly found in CSS)
-  message = message.replace(
-    /SyntaxError\s+\((\d+):(\d+)\)\s*(.+?)\n/g,
-    `${friendlySyntaxErrorLabel} $3 ($1:$2)\n`,
-  );
-
-  lines = message.split('\n');
-
-  // Remove leading newline
-  if (lines.length > 2 && lines[1].trim() === '') {
-    lines.splice(1, 1);
-  }
-  // Clean up file name
-  lines[0] = lines[0].replace(/^(.*) \d+:\d+-\d+$/, '$1');
-
-  // Cleans up verbose "module not found" messages for files and packages.
-  if (lines[1]?.startsWith('Module not found: ')) {
-    lines = [
-      lines[0],
-      lines[1]
-        .replace('Error: ', '')
-        .replace('Module not found: Cannot find file:', 'Cannot find file:')
-        .replace('[CaseSensitivePathsPlugin] ', '')
-        .replace("Cannot resolve 'file' or 'directory' ", ''),
-    ];
-  }
-
-  message = lines.join('\n');
-  // Internal stacks are generally useless so we strip them... with the
-  // exception of stacks containing `webpack:` because they're normally
-  // from user code generated by webpack. For more information see
-  // https://github.com/facebook/create-react-app/pull/1050
-  message = message.replace(
-    /^\s*at\s((?!webpack:).)*:\d+:\d+[\s)]*(\n|$)/gm,
-    '',
-  ); // at ... ...:x:y
-  message = message.replace(/^\s*at\s<anonymous>(\n|$)/gm, ''); // at <anonymous>
-  lines = message.split('\n');
-
-  // Remove duplicated newlines
-  lines = lines.filter(
-    (line, index, arr) =>
-      index === 0 ||
-      line.trim() !== '' ||
-      line.trim() !== arr[index - 1].trim(),
-  );
-
-  // Reassemble the message
-  message = lines.join('\n');
-  return message.trim();
-}
-
-function formatWebpackMessages(json: StatsCompilation): {
-  errors: string[];
-  warnings: string[];
-} {
-  const formattedErrors = json.errors?.map(formatMessage);
-  const formattedWarnings = json.warnings?.map(formatMessage);
-
-  const result = {
-    errors: formattedErrors || [],
-    warnings: formattedWarnings || [],
-  };
-
-  if (result.errors?.some(isLikelyASyntaxError)) {
-    // If there are any syntax errors, show just them.
-    result.errors = result.errors.filter(isLikelyASyntaxError);
-  }
-
-  // First error is usually it.
-  if (result.errors.length > 1) {
-    result.errors.length = 1;
-  }
-
-  return result;
-}
-
-export { formatWebpackMessages };
-/* eslint-enable max-statements */
-/* eslint-enable no-param-reassign */

package/src/generateMetaTags.ts

@@ -1,75 +0,0 @@
-/**
- * Copyright JS Foundation and other contributors.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file at
- * https://github.com/jantimon/html-webpack-plugin/blob/main/LICENSE
- *
- * Modified from https://github.com/jantimon/html-webpack-plugin/blob/2f5de7ab9e8bca60e9e200f2e4b4cfab90db28d4/index.js#L800
- */
-export type MetaAttributes = { [attributeName: string]: string | boolean };
-
-export interface MetaOptions {
-  [name: string]:
-    | string
-    | false // name content pair e.g. {viewport: 'width=device-width, initial-scale=1, shrink-to-fit=no'}`
-    | MetaAttributes; // custom properties e.g. { name:"viewport" content:"width=500, initial-scale=1" }
-}
-
-const tagObjectToString = (tagDefinition: {
-  tagName: string;
-  voidTag: boolean;
-  attributes: MetaAttributes;
-  innerHTML?: string;
-}) => {
-  const attributes = Object.keys(tagDefinition.attributes || {})
-    .filter(attributeName => tagDefinition.attributes[attributeName] !== false)
-    .map(attributeName => {
-      if (tagDefinition.attributes[attributeName] === true) {
-        return attributeName;
-      }
-      return `${attributeName}="${
-        tagDefinition.attributes[attributeName] as string
-      }"`;
-    });
-  return `<${[tagDefinition.tagName].concat(attributes).join(' ')}>${
-    tagDefinition.innerHTML || ''
-  }${tagDefinition.voidTag ? '' : `</${tagDefinition.tagName}>`}`;
-};
-
-export const generateMetaTags = (metaOptions?: MetaOptions): string => {
-  if (!metaOptions) {
-    return '';
-  }
-  // Make tags self-closing in case of xhtml
-  // Turn { "viewport" : "width=500, initial-scale=1" } into
-  // [{ name:"viewport" content:"width=500, initial-scale=1" }]
-  const metaTagAttributeObjects = Object.keys(metaOptions)
-    .map(metaName => {
-      const metaTagContent = metaOptions[metaName];
-      return typeof metaTagContent === 'string'
-        ? {
-            name: metaName,
-            content: metaTagContent,
-          }
-        : metaTagContent;
-    })
-    .filter(attribute => attribute !== false);
-  // Turn [{ name:"viewport" content:"width=500, initial-scale=1" }] into
-  // the html-webpack-plugin tag structure
-  return metaTagAttributeObjects
-    .map(metaTagAttributes => {
-      if (metaTagAttributes === false) {
-        throw new Error('Invalid meta tag');
-      }
-      return {
-        tagName: 'meta',
-        voidTag: true,
-        attributes: metaTagAttributes,
-      };
-    })
-    .reduce(
-      (memo, tagObject) => `${memo}\n${tagObjectToString(tagObject)}`,
-      '',
-    );
-};

package/src/getBrowserslist.ts

@@ -1,6 +0,0 @@
-import { loadConfig } from 'browserslist';
-
-export const defaults = ['> 0.01%', 'not dead', 'not op_mini all'];
-
-export const getBrowserslist = (appDirectory: string) =>
-  loadConfig({ path: appDirectory }) || defaults;

package/src/getCacheIdentifier.ts

@@ -1,30 +0,0 @@
-import { isProd, isDev, isTest } from './is';
-
-/**
- * Generate cache identifier from some packages and config files.
- */
-export function getCacheIdentifier(
-  packages: {
-    name: string;
-    version: string;
-  }[],
-  _files?: string[],
-) {
-  /* eslint-disable no-nested-ternary */
-  let cacheIdentifier = isProd()
-    ? 'production'
-    : isDev()
-    ? 'development'
-    : isTest()
-    ? 'test'
-    : '';
-  /* eslint-enable no-nested-ternary */
-
-  for (const { name, version } of packages) {
-    cacheIdentifier += `:${name}@${version}`;
-  }
-
-  // TODO: config file hash
-
-  return cacheIdentifier;
-}

package/src/getEntryOptions.ts

@@ -1,37 +0,0 @@
-import { isPlainObject } from './is';
-import { MAIN_ENTRY_NAME } from './constants';
-
-export const getEntryOptions = <T>(
-  name: string,
-  baseOptions?: T,
-  optionsByEntries?: Record<string, T>,
-  packageName?: string,
-) => {
-  if (optionsByEntries) {
-    let optionsByEntry = getOptionsByEntryName(name, optionsByEntries);
-
-    // compatible with main entry using packageName as the key
-    if (
-      optionsByEntry === undefined &&
-      name === MAIN_ENTRY_NAME &&
-      packageName
-    ) {
-      optionsByEntry = getOptionsByEntryName(packageName, optionsByEntries);
-    }
-
-    // eslint-disable-next-line no-nested-ternary
-    return optionsByEntry !== undefined
-      ? isPlainObject(optionsByEntry) && isPlainObject(baseOptions)
-        ? { ...baseOptions, ...optionsByEntry }
-        : optionsByEntry
-      : baseOptions;
-  } else {
-    return baseOptions;
-  }
-};
-
-const getOptionsByEntryName = <T>(
-  name: string,
-  optionsByEntries: Record<string, T>,
-) =>
-  optionsByEntries.hasOwnProperty(name) ? optionsByEntries[name] : undefined;

package/src/getPackageManager.ts

@@ -1,30 +0,0 @@
-import os from 'os';
-import path from 'path';
-import fs from 'fs-extra';
-import { canUsePnpm, canUseYarn } from './nodeEnv';
-
-const MAX_TIMES = 5;
-export async function getPackageManager(cwd: string = process.cwd()) {
-  let appDirectory = cwd;
-  let times = 0;
-  while (os.homedir() !== appDirectory && times < MAX_TIMES) {
-    times++;
-    if (fs.existsSync(path.resolve(appDirectory, 'pnpm-lock.yaml'))) {
-      return 'pnpm';
-    }
-    if (fs.existsSync(path.resolve(appDirectory, 'yarn.lock'))) {
-      return 'yarn';
-    }
-    if (fs.existsSync(path.resolve(appDirectory, 'package-lock.json'))) {
-      return 'npm';
-    }
-    appDirectory = path.join(appDirectory, '..');
-  }
-  if (await canUsePnpm()) {
-    return 'pnpm';
-  }
-  if (await canUseYarn()) {
-    return 'yarn';
-  }
-  return 'npm';
-}

package/src/getPort.ts

@@ -1,62 +0,0 @@
-import net from 'net';
-import { chalk } from './chalk';
-import { logger } from './logger';
-
-/**
- * Get available free port.
- * @param port - Current port want to use.
- * @param tryLimits - Maximum number of retries.
- * @returns Available port number.
- */
-/* eslint-disable no-param-reassign, @typescript-eslint/no-loop-func */
-export const getPort = async (
-  port: string | number,
-  tryLimits = 20,
-): Promise<number> => {
-  if (typeof port === 'string') {
-    port = parseInt(port, 10);
-  }
-
-  const original = port;
-
-  let found = false;
-  let attempts = 0;
-  while (!found && attempts <= tryLimits) {
-    try {
-      await new Promise((resolve, reject) => {
-        const server = net.createServer();
-        server.unref();
-        server.on('error', reject);
-        server.listen(
-          {
-            port,
-            host: '0.0.0.0',
-          },
-          () => {
-            found = true;
-            server.close(resolve);
-          },
-        );
-      });
-    } catch (e: any) {
-      if (e.code !== 'EADDRINUSE') {
-        throw e;
-      }
-      port++;
-      attempts++;
-    }
-  }
-
-  if (port !== original) {
-    logger.info(
-      chalk.red(
-        `Something is already running on port ${original}. ${chalk.yellow(
-          `Use port ${port} instead.`,
-        )}`,
-      ),
-    );
-  }
-
-  return port;
-};
-/* eslint-enable no-param-reassign, @typescript-eslint/no-loop-func */

package/src/import.ts

@@ -1,10 +0,0 @@
-// cover: https://rushstack.io/pages/api/node-core-library.import.lazy/
-const lazy = (moduleName: string, requireFn: (id: string) => unknown): any => {
-  const importLazyLocal: (moduleName: string) => unknown =
-    require('import-lazy')(requireFn);
-  return importLazyLocal(moduleName);
-};
-
-export { lazy as lazyImport };
-
-export const Import = { lazy };