@modern-js/utils 1.3.8-canary.0 → 1.6.0

package/dist/types/constants.d.ts

@@ -1,222 +0,0 @@
-/**
- * hmr socket connect path
- */
-export declare const HMR_SOCK_PATH = "/_modern_js_hmr_ws";
-/**
- * route specification file
- */
-export declare const ROUTE_SPEC_FILE = "route.json";
-/**
- * main entry name
- */
-export declare const MAIN_ENTRY_NAME = "main";
-/**
- * open editor request path
- */
-export declare const LAUNCH_EDITOR_ENDPOINT = "/__open-stack-frame-in-editor";
-/**
- * server side bundles directory, which relative to dist.
- */
-export declare const SERVER_BUNDLE_DIRECTORY = "bundles";
-/**
- * entry name pattern used for ajv pattern properties.
- */
-export declare const ENTRY_NAME_PATTERN = "^[a-zA-Z0-9_-]+$";
-/**
- * SSR server render function name
- */
-export declare const SERVER_RENDER_FUNCTION_NAME = "serverRender";
-/**
- * loadbale manifest json file
- */
-export declare const LOADABLE_STATS_FILE = "loadable-stats.json";
-/**
- * internal specified folder
- */
-export declare const API_DIR = "api";
-export declare const SERVER_DIR = "server";
-export declare const SHARED_DIR = "shared";
-/**
- * Modern.config.ts cached dir
- */
-export declare const CONFIG_CACHE_DIR = "./node_modules/.node-bundle-require";
-export declare const CONFIG_FILE_EXTENSIONS: string[];
-/**
- * Serialized config path
- */
-export declare const OUTPUT_CONFIG_FILE = "modern.config.json";
-/**
- * Default server config basename
- */
-export declare const DEFAULT_SERVER_CONFIG = "modern.server.config";
-/**
- * Internal plugins that work as soon as they are installed.
- */
-export declare const INTERNAL_PLUGINS: {
-    [name: string]: {
-        cli?: string;
-        server?: string;
-    };
-};
-/**
- * The schema registered in the plugin.
- */
-export declare const PLUGIN_SCHEMAS: {
-    '@modern-js/runtime': ({
-        target: string;
-        schema: {
-            type: string;
-            additionalProperties: boolean;
-            patternProperties?: undefined;
-        };
-    } | {
-        target: string;
-        schema: {
-            type: string;
-            patternProperties: {
-                "^[a-zA-Z0-9_-]+$": {
-                    type: string;
-                };
-            };
-            additionalProperties: boolean;
-        };
-    })[];
-    '@modern-js/plugin-bff': {
-        target: string;
-        schema: {
-            type: string;
-            properties: {
-                prefix: {
-                    type: string[];
-                    items: {
-                        type: string;
-                    };
-                };
-                fetcher: {
-                    type: string;
-                };
-                proxy: {
-                    type: string;
-                };
-                requestCreator: {
-                    type: string;
-                };
-            };
-        };
-    }[];
-    '@modern-js/plugin-esbuild': {
-        target: string;
-        schema: {
-            typeof: string[];
-        };
-    }[];
-    '@modern-js/plugin-less': {
-        target: string;
-        schema: {
-            typeof: string[];
-        };
-    }[];
-    '@modern-js/plugin-sass': {
-        target: string;
-        schema: {
-            typeof: string[];
-        };
-    }[];
-    '@modern-js/plugin-tailwindcss': {
-        target: string;
-        schema: {
-            typeof: string[];
-        };
-    }[];
-    '@modern-js/plugin-proxy': {
-        target: string;
-        schema: {
-            typeof: string[];
-        };
-    }[];
-    '@modern-js/plugin-unbundle': ({
-        target: string;
-        schema: {
-            type: string;
-            properties?: undefined;
-        };
-    } | {
-        target: string;
-        schema: {
-            type: string;
-            properties: {
-                ignore: {
-                    type: string[];
-                    items: {
-                        type: string;
-                    };
-                };
-                ignoreModuleCache: {
-                    type: string;
-                };
-                clearPdnCache: {
-                    type: string;
-                };
-                pdnHost: {
-                    type: string;
-                };
-            };
-        };
-    })[];
-    '@modern-js/plugin-ssg': {
-        target: string;
-        schema: {
-            oneOf: ({
-                type: string;
-                instanceof?: undefined;
-            } | {
-                instanceof: string;
-                type?: undefined;
-            })[];
-        };
-    }[];
-    '@modern-js/plugin-ssr': {
-        target: string;
-        schema: {
-            type: string[];
-        };
-    }[];
-    '@modern-js/plugin-state': {
-        target: string;
-        schema: {
-            type: string[];
-        };
-    }[];
-    '@modern-js/plugin-design-token': ({
-        target: string;
-        schema: {
-            typeof: string[];
-            type?: undefined;
-        };
-    } | {
-        target: string;
-        schema: {
-            type: string[];
-            typeof?: undefined;
-        };
-    })[];
-    '@modern-js/plugin-router': {
-        target: string;
-        schema: {
-            type: string[];
-        };
-    }[];
-    '@modern-js/plugin-testing': {
-        target: string;
-        schema: {
-            typeof: string[];
-        };
-    }[];
-    '@modern-js/plugin-garfish': {
-        target: string;
-        schema: {
-            type: string[];
-        };
-    }[];
-    '@modern-js/plugin-nocode': never[];
-};

package/dist/types/debug.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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 declare const createDebugger: (scope: string) => import("../compiled/debug").Debugger;

package/dist/types/emptyDir.d.ts

@@ -1 +0,0 @@
-export declare const emptyDir: (dir: string) => Promise<void>;

package/dist/types/ensureAbsolutePath.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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 declare const ensureAbsolutePath: (base: string, filePath: string) => string;

package/dist/types/findExists.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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 declare const findExists: (files: string[]) => string | false;

package/dist/types/format.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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
- */
-import { StatsCompilation } from 'webpack';
-import type { ProxyDetail, BffProxyOptions } from '@modern-js/types';
-declare function formatWebpackMessages(json: StatsCompilation): {
-    errors: string[];
-    warnings: string[];
-};
-export { formatWebpackMessages };
-declare function formatProxyOptions(proxyOptions: BffProxyOptions): ProxyDetail[];
-export { formatProxyOptions };

package/dist/types/generateMetaTags.d.ts

@@ -1,16 +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 declare type MetaAttributes = {
-    [attributeName: string]: string | boolean;
-};
-export interface MetaOptions {
-    [name: string]: string | false | MetaAttributes;
-}
-export declare const generateMetaTags: (metaOptions?: MetaOptions | undefined) => string;

package/dist/types/getBrowserslist.d.ts

@@ -1,2 +0,0 @@
-export declare const defaults: string[];
-export declare const getBrowserslist: (appDirectory: string) => string[];

package/dist/types/getCacheIdentifier.d.ts

@@ -1,7 +0,0 @@
-/**
- * Generate cache identifier from some packages and config files.
- */
-export declare function getCacheIdentifier(packages: {
-    name: string;
-    version: string;
-}[], _files?: string[]): string;

package/dist/types/getEntryOptions.d.ts

@@ -1 +0,0 @@
-export declare const getEntryOptions: <T>(name: string, baseOptions?: T | undefined, optionsByEntries?: Record<string, T> | undefined, packageName?: string | undefined) => T | undefined;

package/dist/types/getPackageManager.d.ts

@@ -1 +0,0 @@
-export declare function getPackageManager(cwd?: string): Promise<"npm" | "yarn" | "pnpm">;

package/dist/types/getPort.d.ts

@@ -1,7 +0,0 @@
-/**
- * Get available free port.
- * @param port - Current port want to use.
- * @param tryLimits - Maximum number of retries.
- * @returns Available port number.
- */
-export declare const getPort: (port: string | number, tryLimits?: number) => Promise<number>;

package/dist/types/getServerConfig.d.ts

@@ -1 +0,0 @@
-export declare const getServerConfig: (appDirectory: string, configFile: string) => Promise<string | false>;

package/dist/types/import.d.ts

@@ -1,5 +0,0 @@
-declare const lazy: (moduleName: string, requireFn: (id: string) => unknown) => any;
-export { lazy as lazyImport };
-export declare const Import: {
-    lazy: (moduleName: string, requireFn: (id: string) => unknown) => any;
-};

package/dist/types/index.d.ts

@@ -1,32 +0,0 @@
-export * from './compiled';
-export * from './format';
-export * from './FileSizeReporter';
-export * from './printBuildError';
-export * from './debug';
-export * from './findExists';
-export * from './is';
-export * from './compatRequire';
-export * from './logger';
-export * from './constants';
-export * from './ensureAbsolutePath';
-export * from './getCacheIdentifier';
-export * from './clearConsole';
-export * from './applyOptionsChain';
-export * from './getBrowserslist';
-export * from './removeSlash';
-export * from './getEntryOptions';
-export * from './getPort';
-export * from './monorepo';
-export * from './getPackageManager';
-export * from './runtimeExports';
-export * from './readTsConfig';
-export * from './path';
-export * from './generateMetaTags';
-export * from './prettyInstructions';
-export * from './alias';
-export * from './import';
-export * from './watch';
-export * from './nodeEnv';
-export * from './wait';
-export * from './emptyDir';
-export * from './getServerConfig';

package/dist/types/is/index.d.ts

@@ -1,34 +0,0 @@
-/**
- * Check if the package name is in dependencies or devDependencies.
- *
- * @param appDirectory - Project root directory.
- * @param name - Package name.
- * @returns True if the name is in dependencies or devDependencies, false otherwise.
- */
-export declare const isDepExists: (appDirectory: string, name: string) => boolean;
-/**
- * Is typescript project.
- *
- * @param root - App directory.
- * @returns Whether to use typescript.
- */
-export declare const isTypescript: (root: string) => boolean;
-/**
- * Is Empty object
- *
- * @param o - Any object.
- * @returns Whether it is empty object.
- */
-export declare const isEmpty: (o: Record<string, unknown>) => boolean;
-/**
- * Is SSR project
- *
- * @param config - User config.
- * @returns Whether to use server side render.
- */
-export declare const isSSR: (config: any) => boolean;
-export declare const isUseSSRBundle: (config: any) => boolean;
-export declare const isFastRefresh: () => boolean;
-export * from './node-env';
-export * from './platform';
-export * from './type';

package/dist/types/is/node-env.d.ts

@@ -1,4 +0,0 @@
-export declare const isDev: () => boolean;
-export declare const isProd: () => boolean;
-export declare const isTest: () => boolean;
-export declare const isProdProfile: () => boolean;

package/dist/types/is/platform.d.ts

@@ -1,2 +0,0 @@
-export declare const isNodeJS: () => boolean;
-export declare const isBrowser: () => boolean;

package/dist/types/is/type.d.ts

@@ -1,8 +0,0 @@
-export declare function isString(str: any): str is string;
-export declare function isUndefined(obj: any): obj is undefined;
-export declare function isArray(obj: unknown): obj is any[];
-export declare function isFunction(func: any): func is Function;
-export declare function isObject(obj: unknown): obj is Record<string, any>;
-export declare function isPlainObject(obj: unknown): obj is Record<string, any>;
-export declare function isPromise(obj: any): obj is Promise<any>;
-export declare function isRegExp(obj: any): obj is RegExp;

package/dist/types/logger.d.ts

@@ -1,63 +0,0 @@
-import { Color } from '../compiled/chalk';
-declare type LogLevel = 'debug' | 'info' | 'warn' | 'error';
-interface LoggerConfiguration {
-    color?: typeof Color;
-    label?: string;
-    level?: LogLevel;
-}
-interface InstanceConfiguration {
-    displayLabel?: boolean;
-    underlineLabel?: boolean;
-    uppercaseLabel?: boolean;
-}
-interface ConstructorOptions {
-    config?: InstanceConfiguration;
-    types?: Record<string, LoggerConfiguration>;
-}
-declare type LoggerFunction = (message?: number | string | Error, ...args: any[]) => void;
-declare const LOG_TYPES: {
-    error: {
-        color: string;
-        label: string;
-        level: string;
-    };
-    info: {
-        color: string;
-        label: string;
-        level: string;
-    };
-    warn: {
-        color: string;
-        label: string;
-        level: string;
-    };
-    debug: {
-        color: string;
-        label: string;
-        level: string;
-    };
-    log: {
-        level: string;
-    };
-};
-declare class Logger {
-    private readonly logCount;
-    private history;
-    private readonly config;
-    private readonly types;
-    private readonly longestLabel;
-    [key: string]: any;
-    constructor(options?: ConstructorOptions);
-    private retainLog;
-    private _log;
-    private getLongestLabel;
-    private get longestUnderlinedLabel();
-    getRetainedLogs(type: string): string[];
-    clearRetainedLogs(type: string): void;
-}
-declare type LoggerInterface = {
-    [key in keyof typeof LOG_TYPES]: LoggerFunction;
-};
-declare const logger: Logger & LoggerInterface;
-export { logger };
-export type { LoggerInterface };

package/dist/types/monorepo.d.ts

@@ -1,11 +0,0 @@
-import path from 'path';
-export declare const isLerna: (root: string) => boolean;
-export declare const isYarnWorkspaces: (root: string) => boolean;
-export declare const isPnpmWorkspaces: (root: string) => boolean;
-export declare const isMonorepo: (root: string) => boolean;
-export declare const isModernjsMonorepo: (root: string) => boolean;
-export declare const findMonorepoRoot: (appDirectory: string, maxDepth?: number) => string | undefined;
-export declare const getMonorepoPackages: (root: string) => {
-    name: string;
-    path: string;
-}[];

package/dist/types/nodeEnv.d.ts

@@ -1,3 +0,0 @@
-export declare function canUseNpm(): Promise<boolean>;
-export declare function canUseYarn(): Promise<boolean>;
-export declare function canUsePnpm(): Promise<boolean>;

package/dist/types/path.d.ts

@@ -1,3 +0,0 @@
-export declare const isRelativePath: (test: string) => boolean;
-export declare const normalizeOutputPath: (s: string) => string;
-export declare const normalizeToPosixPath: (p: string) => string;

package/dist/types/prettyInstructions.d.ts

@@ -1,6 +0,0 @@
-interface EntryPoint {
-    entryName: string;
-}
-export declare const isSingleEntry: (entrypoints: EntryPoint[]) => boolean;
-export declare const prettyInstructions: (appContext: any, config: any) => string;
-export {};

package/dist/types/printBuildError.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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
- */
-export declare function printBuildError(err: Error): void;

package/dist/types/readTsConfig.d.ts

@@ -1,2 +0,0 @@
-export declare const readTsConfig: (root: string) => any;
-export declare const readTsConfigByFile: (filename: string) => any;

package/dist/types/removeSlash.d.ts

@@ -1,3 +0,0 @@
-export declare const removeLeadingSlash: (s: string) => string;
-export declare const removeTailSlash: (s: string) => string;
-export declare const removeSlash: (s: string) => string;

package/dist/types/runtimeExports.d.ts

@@ -1,4 +0,0 @@
-export declare const createRuntimeExportsUtils: (pwd: any, namespace: string, ts?: any) => {
-    addExport: (statement: string) => void;
-    getPath: () => string;
-};

package/dist/types/wait.d.ts

@@ -1,2 +0,0 @@
-declare const wait: (time?: number) => Promise<unknown>;
-export { wait };

package/dist/types/watch.d.ts

@@ -1,8 +0,0 @@
-export declare type WatchChangeTypeValueT = 'add' | 'unlink' | 'change';
-export declare const WatchChangeType: Record<'ADD' | 'UNLINK' | 'CHANGE', WatchChangeTypeValueT>;
-declare type RunTaskType = (option: {
-    changedFilePath: string;
-    changeType: WatchChangeTypeValueT;
-}) => void | Promise<void>;
-export declare const watch: (watchDir: string | string[], runTask: RunTaskType, ignored?: string[]) => import("./compiled").FSWatcher;
-export {};

package/modern.config.js

@@ -1,6 +0,0 @@
-/** @type {import('@modern-js/module-tools').UserConfig} */
-module.exports = {
-  output: {
-    disableSourceMap: true,
-  },
-};

package/tests/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-  extends: ['@modern-js'],
-  parserOptions: {
-    project: require.resolve('./tsconfig.json'),
-  },
-};

package/tests/__snapshots__/prettyInstructions.test.ts.snap

@@ -1,19 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`prettyInstructions The src directory does not exist 1`] = `
-"App running at:
-
-  > Network:  http://127.0.0.1:8080/api
-  > Network:  http://11.11.111.11:8080/api
-  > Network:  http://10.100.100.100:8080/api
-"
-`;
-
-exports[`prettyInstructions basic usage 1`] = `
-"App running at:
-
-  > Network:  http://127.0.0.1:8080/
-  > Network:  http://11.11.111.11:8080/
-  > Network:  http://10.100.100.100:8080/
-"
-`;