@flatjs/evolve 1.7.2 → 1.8.1-next.17

package/dist/types/types-entry-map.d.ts

@@ -0,0 +1,66 @@
+import { type ModuleFederationOptions } from './types-federation.js';
+import { type MultiHtmlCDNEntryItem } from './types-multi-html.js';
+/**
+ * The configuration options for each entry item.
+ */
+export interface EvolveEntryItemOption extends MultiHtmlCDNEntryItem {
+    /**
+     * The value indicates if we need to Px convert to rem.
+     * @default entryItemOption?.allowPx2rem ?? pluginLoaderOptions?.pixelOptions?.enabled
+     */
+    allowPx2rem?: boolean;
+    /**
+     * Specify dependencies that shouldn't be resolved by webpack, but should become dependencies of the resulting bundle. The kind of the dependency depends on `output.libraryTarget`.
+     * Note It will merged with globall externals configuration and apply for current entry compiler
+     */
+    externals?: Record<string, string>;
+    /**
+     * If all we use `contenthash` bundle name.
+     * @default true
+     */
+    enableBundleHashName?: boolean;
+    /**
+     * Allow customized module `link` on `/pages`
+     * @default undefined
+     */
+    servePageMainLinkFn?: (link: string, options: {
+        entryName: string;
+        hostUri: string;
+        virtualPath: string;
+    }) => string;
+    /**
+     * For `serve`
+     * Customized module template to proxy the modules template.
+     * If providered, it must be an absolute path. path.join(__dirname, `templates/module.html`)
+     * Normally it will find file `${projectCwd}/templates/module.html` automatically
+     */
+    serveModuleTemplate?: string;
+    /**
+     * For `serve`
+     * Attach fixed global data for specificed entry.
+     * Will merged into `window.GLOBAL = {...globalData}`
+     * @default {}
+     */
+    serveGlobalData?: Record<string, unknown>;
+    /**
+     * Multiple separate builds should form a single application.
+     * This is often known as Micro-Frontends, but is not limited to that.
+     */
+    moduleFederation?: ModuleFederationOptions;
+    /**
+     * The value indicates if we need to build relative asset public path?
+     * @default false
+     */
+    useRelativeAssetPath?: boolean;
+}
+export type EvolveEntryMapContent = {
+    entry: [string, ...string[]];
+    options?: EvolveEntryItemOption;
+};
+export interface EvolveEntryMap {
+    /**
+     * <entryChunkName>: {}
+     */
+    [entryName: string]: EvolveEntryMapContent;
+}
+export type EntryMapItem = [string, EvolveEntryMapContent];

package/dist/types/types-entry-map.js

@@ -0,0 +1 @@
+export{};

package/dist/types/types-federation.d.ts

@@ -0,0 +1,120 @@
+import { type LibraryOptions } from 'webpack';
+/**
+ * Advanced configuration for modules that should be shared in the share scope.
+ */
+interface SharedConfig {
+    /**
+     * Include the provided and fallback module directly instead behind an async request. This allows to use this shared module in initial load too. All possible shared modules need to be eager too.
+     */
+    eager?: boolean;
+    /**
+     * Provided module that should be provided to share scope. Also acts as fallback module if no shared module is found in share scope or version isn't valid. Defaults to the property name.
+     */
+    import?: string | false;
+    /**
+     * Package name to determine required version from description file. This is only needed when package name can't be automatically determined from request.
+     */
+    packageName?: string;
+    /**
+     * Version requirement from module in share scope.
+     */
+    requiredVersion?: string | false;
+    /**
+     * Module is looked up under this key from the share scope.
+     */
+    shareKey?: string;
+    /**
+     * Share scope name.
+     */
+    shareScope?: string;
+    /**
+     * Allow only a single version of the shared module in share scope (disabled by default).
+     */
+    singleton?: boolean;
+    /**
+     * Do not accept shared module if version is not valid (defaults to yes, if local fallback module is available and shared module is not a singleton, otherwise no, has no effect if there is no required version specified).
+     */
+    strictVersion?: boolean;
+    /**
+     * Version of the provided module. Will replace lower matching versions, but not higher.
+     */
+    version?: string | false;
+}
+interface SharedObject {
+    [index: string]: string | SharedConfig;
+}
+/**
+ * Advanced configuration for modules that should be exposed by this container.
+ */
+export interface ExposesConfig {
+    /**
+     * Request to a module that should be exposed by this container.
+     * @example `import: './src/home/widget.tsx'`
+     */
+    import: string | string[];
+    /**
+     * Custom chunk name for the exposed module.
+     * Do not include `normalizedEntryName` e.g.(`flatjs/evolve/home`)
+     * @example `exposed-micro-module-home-widget` => `flatjs/evolve/home/exposed-micro-module-home-widget`
+     */
+    name: string;
+}
+/**
+ * Modules that should be exposed by this container. Property names are used as public paths.
+ */
+export interface ExposesObject {
+    /**
+     *  @example `'./Widget': { name, import }`
+     */
+    [index: string]: ExposesConfig;
+}
+export interface ModuleFederationRemote {
+    /**
+     * Normally it can be the entryPath like `${projectVirtualPath}/home`
+     * it will formatted into `evolve_demo_home`
+     * Note: We need to config `declare module 'evolve_demo_home/Widget` in `global.d.ts`;
+     * @example `home`
+     */
+    name: string;
+    /**
+     * The remote app resouce endpoint base path with prefix of `projectVirtualPath`
+     * Normally This is only required when an external project module as remote widget.
+     */
+    endpoint?: (entryName: string, normalizedEntryName: string) => string;
+}
+/**
+ * Multiple separate builds should form a single application.
+ * This is often known as Micro-Frontends, but is not limited to that.
+ */
+export type ModuleFederationOptions = {
+    /**
+     * Container locations and request scopes from which modules should be resolved and loaded at runtime. When provided, property name is used as request scope, otherwise request scope is automatically inferred from container location.
+     * {`${projectVirtualPath}/home`,`${projectVirtualPath}/mine`}
+     */
+    remotes?: Array<ModuleFederationRemote>;
+    /**
+     * Options for library.
+     */
+    library?: LibraryOptions;
+    /**
+     * The external type of the remote containers.
+     */
+    remoteType?: 'import' | 'var' | 'module' | 'assign' | 'this' | 'window' | 'self' | 'global' | 'commonjs' | 'commonjs2' | 'commonjs-module' | 'commonjs-static' | 'amd' | 'amd-require' | 'umd' | 'umd2' | 'jsonp' | 'system' | 'promise' | 'script' | 'node-commonjs';
+    /**
+     * Modules that should be exposed by this container. When provided, property name is used as public name, otherwise public name is automatically inferred from request.
+     */
+    exposes?: ExposesObject[] | ExposesObject;
+    /**
+     * The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
+     */
+    runtime?: string | false;
+    /**
+     * Share scope name used for all shared modules (defaults to 'default').
+     */
+    shareScope?: string;
+    /**
+     * Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
+     */
+    shared?: (string | SharedObject)[] | SharedObject;
+};
+export {};

package/dist/types/types-federation.js

@@ -0,0 +1 @@
+export{};

package/dist/types/types-loader-options.d.ts

@@ -0,0 +1,61 @@
+import { type TransformOptions } from '@babel/core';
+import { type PostcssPluginPixelOptions } from '@flatjs/forge-postcss-plugin-pixel';
+import { type Options } from 'cssnano';
+import { type ModularImportOption } from './types-modular-import.js';
+export type BabelInputOptions = Pick<TransformOptions, 'presets' | 'plugins'>;
+/**
+ * Builtin babel options, provider default `builin` presets.
+ * can be override by customized `presets` & `plugins`
+ */
+export type BuiltinBabelOptions = BabelInputOptions & {
+    /**
+     * extra babel `plugins` or `presets`
+     * @default `react`
+     */
+    usePreset?: 'react' | 'vue';
+};
+/**
+ * The configurations for `builtin` rule set options
+ */
+export interface RuleSetLoaderOptions {
+    /**
+     * Now webpack will automatically choose between resource and inline by following
+     * a default condition: a file with size less than 8kb will be treated as a inline module type and resource module type otherwise.
+     * @default `4 * 1024` (4KB)
+     */
+    assetDataUrlMaxSize?: number;
+    /**
+     * The config for `Less`
+     */
+    lessOptions?: Record<string, unknown>;
+    /**
+     * Modular import plugin for babel, compatible with antd, antd-mobile, lodash, material-ui, and so on.
+     * https://github.com/ant-design/babel-plugin-import
+     * @default []
+     */
+    modularImports?: ModularImportOption[];
+    /**
+     * The value indicates whether runs typescript type checker and linter on separate process.
+     * @default true
+     */
+    runTsChecker?: boolean;
+    /**
+     * The overrided configurations of `cssnano-preset-default`
+     * sometimes we need to disabled some rules for `default cssnano preset`
+     * @example
+     * diable `postcss-minify-font-values` rule  to avoid transitions from `font-weight:bold` to `font-weight:700`
+     * ```json
+     * cssnanoOptions: { minifyFontValues: false }
+     * ```
+     */
+    cssnanoOptions?: Options;
+    /**
+     * The babel options for `babel-loader`
+     */
+    babelOptions?: BuiltinBabelOptions;
+    /**
+     * The config options fro `@flatjs/forge-postcss-plugin-plugin`
+     * If provider it will use default options of `forgePostcssPluginPixel`
+     */
+    pixelOptions?: false | Partial<PostcssPluginPixelOptions>;
+}

package/dist/types/types-loader-options.js

@@ -0,0 +1 @@
+export{};

package/dist/types/types-modular-import.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Buildin plugin `babel-plugin-import` configurations
+ */
+export type ModularImportOption = {
+    /**
+     * @example `antd`, `lodash`, `material-ui`, `@flatjs`, `@dimjs`, `@fabric`, `@wine`
+     */
+    libraryName: string;
+    /**
+     * Set this option to false if your module does not have a default export.
+     * @default false
+     */
+    transformToDefaultImport?: boolean;
+    /**
+     * @default: `esm`
+     */
+    libraryDirectory?: string;
+    /**
+     * The value will append to `${libraryDirectory}/${transformedMethodName}/${fileName}`
+     * e.g. `@scope/app/esm/{moduleName}/index`
+     * @default ""
+     */
+    fileName?: string;
+    /**
+     * We can use customName to customize import file path.
+     * @example `esm/modal`
+     */
+    customName?: (transformedMethodName: string, file: any) => string;
+    /**
+     * @default: true
+     */
+    camel2DashComponentName?: boolean;
+    /**
+     * @default false
+     * @example (name) => `${name}/style/2x` | `boolean` }
+     */
+    style?: true | 'css' | ((name: string, file: Record<string, unknown>) => string | boolean);
+};

package/dist/types/types-modular-import.js

@@ -0,0 +1 @@
+export{};

package/dist/types/types-multi-html.d.ts

@@ -0,0 +1,74 @@
+export declare type EvolveMultiCdnEnvType = 'me' | 'dev' | 'uat' | 'inte' | 'inte2' | 'inte3' | 'inte4' | 'rc' | 'prod' | 'ntv';
+export type EvolveMultiCDNConfig = {
+    [key in EvolveMultiCdnEnvType]?: string[];
+};
+/**
+ * Allow us customized to resolve current runtime environment.
+ */
+export type EvolveMultiCDNEnvResolver = (url: string) => EvolveMultiCdnEnvType | undefined;
+/**
+ * The html plugin configuration for each entry item
+ */
+export declare type MultiHtmlCDNEntryItem = {
+    /**
+     * The title to use for the generated HTML document
+     * @default ''
+     */
+    title?: string;
+    /**
+     * The favicon url to use for the generated HTML document
+     */
+    favicon?: string;
+    /**
+     * webpack relative or absolute path to the template.
+     * It must be an absolute path. `path.join(__dirname, `templates/index-{0}.html`)`
+     * @default join(evolveRoot, `/templates/html-plugin/index-{0}.html`)
+     */
+    templatePath?: string;
+    /**
+     * Indicates if we need to minify html.
+     * @default true
+     */
+    htmlMinify?: boolean;
+    /**
+     * Support inject viewport scripts in each modules
+     * It only available while `allowPx2rem` = true
+     * @default ''
+     */
+    viewport?: string;
+    /**
+     * Allow us customized inline scripts into compiled html template.
+     * @default []
+     */
+    inlineScripts?: string[];
+    /**
+     * The customized html tags should be inject to `<header />`
+     */
+    headBeforeHtmlTags?: string[];
+    /**
+     * The ordered styles will be injected start of html head.
+     * @default []
+     */
+    headBeforeStyles?: string[];
+    /**
+     * The ordered scripts will be injected before html head.
+     * @default [
+     * `https://polyfill.io/v3/polyfill.min.js?features=Array.from%2CArray.isArray%2CArray.of%2CArray.prototype.entries%2CArray.prototype.every%2CArray.prototype.fill%2CArray.prototype.filter%2CArray.prototype.find%2CArray.prototype.findIndex%2CArray.prototype.flat%2CArray.prototype.forEach%2CArray.prototype.flatMap%2CArray.prototype.keys%2CArray.prototype.indexOf%2CArray.prototype.includes%2CArray.prototype.lastIndexOf%2CArray.prototype.map%2CArray.prototype.reduce%2CArray.prototype.reduceRight%2CArray.prototype.some%2CArray.prototype.sort%2CArray.prototype.values%2CArrayBuffer%2CBlob%2CDataView%2CDate.now%2CObject.assign%2CObject.create%2CObject.defineProperties%2CObject.defineProperty%2CObject.entries%2CObject.freeze%2CObject.fromEntries%2CObject.getOwnPropertySymbols%2CObject.getOwnPropertyNames%2CObject.getOwnPropertyDescriptors%2CObject.getOwnPropertyDescriptor%2CObject.getPrototypeOf%2CObject.is%2CObject.isExtensible%2CObject.isFrozen%2CObject.isSealed%2CObject.keys%2CObject.values%2CObject.setPrototypeOf%2CPromise%2CPromise.prototype.finally%2CReflect%2CReflect.apply%2CReflect.construct%2CReflect.defineProperty%2CReflect.deleteProperty%2CReflect.getPrototypeOf%2CReflect.getOwnPropertyDescriptor%2CReflect.get%2CReflect.ownKeys%2CReflect.isExtensible%2CReflect.has%2CReflect.preventExtensions%2CReflect.set%2CReflect.setPrototypeOf%2CSet%2CString.prototype.trimStart%2CString.prototype.trimEnd%2CString.prototype.trim%2CString.prototype.startsWith%2CString.prototype.repeat%2CString.prototype.replaceAll%2CString.prototype.padStart%2CString.prototype.padEnd%2CMap%2CObject.seal%2Cconsole.groupEnd%2Cconsole.group`,
+     * `https://unpkg.com/react@17.0.2/umd/react.production.min.js`,
+     * `https://unpkg.com/react-dom@17.0.2/umd/react-dom.production.min.js`,
+     * `https://unpkg.com/react-router-dom@5.2.0/umd/react-router-dom.min.js`
+     * ]
+     */
+    headBeforeScripts?: string[];
+    /**
+     * The ordered scripts will be injected end of html body.
+     * @default []
+     */
+    bodyAfterScripts?: string[];
+    /**
+     * Give `env` list to exclude from `multi-cdn` plugin.
+     * Normally for `me`, `dev`,`uat`, `ntv` env we should use relative assets path instead cdn.
+     * @default ['dev', 'ntv']
+     */
+    excludeCdnEnvs?: EvolveMultiCdnEnvType[];
+};

package/dist/types/types-multi-html.js

@@ -0,0 +1 @@
+export{};

package/dist/types/types-options.d.ts

@@ -0,0 +1,98 @@
+import { type VerifyPackagePattern } from '@armit/package';
+import { type FlatEvolveDevServerOptions } from './types-dev-server.js';
+import { type EvolveEntryMap } from './types-entry-map.js';
+import { type RuleSetLoaderOptions } from './types-loader-options.js';
+import { type EvolveMultiCDNEnvResolver, type EvolveMultiCDNConfig } from './types-multi-html.js';
+import { type FlatEvolveWebpackOptions } from './types-webpack.js';
+/**
+ * Detect locally installed dependencies that have correctly installed from `package.json` declared version `dependencies`
+ */
+export type PackageInstallChecker = {
+    /**
+     * @default false
+     */
+    enabled?: boolean;
+    /**
+     * Stop program if we have detect unexpected error.
+     * @default false
+     */
+    throwError?: boolean;
+    /**
+     * Flat indicates if we need to print all install module graph
+     * @default false
+     */
+    showAllInstalledGraph?: boolean;
+    /**
+     * Package module name, or module expression. [`^babel-`,`@dimjs/*`]
+     * @defalt ['@dimjs/*']
+     */
+    detectModules?: string[];
+};
+export interface FlatEvolveOptions {
+    /**
+     * The project workspace directory.
+     */
+    projectCwd: string;
+    /**
+     * The virtual path for current `project`
+     * e.g. `evolve/test`
+     */
+    projectVirtualPath: string;
+    /**
+     * The configurations of `webpack`
+     */
+    webpack?: FlatEvolveWebpackOptions;
+    /**
+     * The config options of all rule set loaders.
+     */
+    loaderOptions: RuleSetLoaderOptions;
+    /**
+     * The configurations of `dev-server`.
+     */
+    devServer?: FlatEvolveDevServerOptions;
+    /**
+     * The plugin for `@flatjs/evolve-multi-html-cdn-plugin`
+     */
+    multiHtmlCdn: EvolveMultiCDNConfig;
+    /**
+     * Allow us customized to resolve current runtime environment.
+     * ignore resolver if return undefined, otherwise use it to match environment.
+     * NOTE: Don't using arrow function, because we will inject `envResolver` string to html.
+     * @example
+     * ```ts
+     * //
+     *  function envResolver(url) {
+     *    const env = /.*\.(qa|t)\.*\/.exec('//fex.qa.tcshuke.com/')[1];
+     *    switch(env) {
+     *      case 't':
+     *       return 'rc'
+     *      case 'qa':
+     *       return 'inte'
+     *    }
+     *   }
+     * ```
+     */
+    multiHtmlCdnEnvResolver?: EvolveMultiCDNEnvResolver;
+    /**
+     * The regexp patterns to filter dependencies(will be verified) from package.json
+     * @default {}
+     */
+    needVerifyPackages?: false | VerifyPackagePattern;
+    /**
+     * Detect locally installed dependencies that have correctly installed from `package.json`
+     */
+    packageInstallChecker?: false | PackageInstallChecker;
+    /**
+     * All webpack entries configuration
+     */
+    entryMap: EvolveEntryMap;
+    /**
+     * Visualize size of webpack output files with an interactive zoomable treemap.
+     */
+    analyzer?: Record<string, unknown>;
+    /**
+     * For `production` mode, the value indicates if we interrupt compilation process while received "warnings" while evolve `build`
+     * @default false
+     */
+    rejectWarnings?: boolean;
+}

package/dist/types/types-options.js

@@ -0,0 +1 @@
+export{};

package/dist/types/types-webpack.d.ts

@@ -0,0 +1,70 @@
+import { type RuleSetRule, type Configuration } from 'webpack';
+import { type WebpackPlugin } from '../create-webpack/types.js';
+import { type TerserMinimizerOptions } from '../minimizer/types.js';
+/**
+ * The webpack entry configuration.
+ */
+export interface WebpackEntryObject {
+    [index: string]: string | [string, ...string[]];
+}
+export interface FlatEvolveWebpackOptions extends Pick<Configuration, 'performance' | 'stats' | 'infrastructureLogging' | 'resolve'> {
+    /**
+     * @default
+     * ```json
+     *  {
+     *    vue: 'Vue',
+     *    react: 'React',
+     *    'react-dom': 'ReactDOM',
+     *  }
+     * ```
+     */
+    externals?: Record<string, string>;
+    /**
+     * output.publicPath defaults to 'auto' with web and web-worker targets
+     * @default 'auto'
+     */
+    publicPath?: string;
+    /**
+     *
+     * Note if we build `node` using webpack, in order to ignore built-in modules like path, fs, etc.
+     * maybe we need to use `webpack-node-externals'` to configuration `externals`
+     * Now webpack-dev-server have not follow webpack@5 `browserslist` changes
+     * Environment to build for. An array of environments to build for all of them when possible.
+     * @default  ['web', 'es5'],
+     */
+    target?: string | false | string[];
+    /**
+     * Minimizer(s) to use for minimizing the output. for `serve` mode, `minimize` always `false`.
+     * @default `terser` minimizer has been enabled fro `production`
+     */
+    minimizer?: false | {
+        terserOptions?: TerserMinimizerOptions;
+        /**
+         * @default true
+         */
+        imageMin?: boolean;
+    };
+    /**
+     * A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map).
+     * https://webpack.js.org/configuration/devtool/
+     * Only works on production mode , `source-map` Recommended choice for production builds with high quality SourceMaps.
+     * Note: the `sourceMap` only focus on javascript bundle,invalid for other `loaders` e.g. less-loader, css-loader.
+     * @default `false`
+     */
+    sourceMap?: string | false;
+    /**
+     * The rule sets loaders config options
+     */
+    ruleSets?: Array<Omit<RuleSetRule, 'test'> & {
+        test?: string | RegExp | ((value: string) => boolean);
+    }>;
+    /**
+     * The plugins config options
+     */
+    plugins?: WebpackPlugin[];
+    /**
+     * `contentehash` bundle file name.
+     * @default true
+     */
+    enableBundleHashName?: boolean;
+}

package/dist/types/types-webpack.js

@@ -0,0 +1 @@
+export{};

package/index.js

@@ -1,4 +1 @@
-'use strict';
-
-module.exports = require('./cjs/index.js');
-module.exports.default = module.exports;
+export * from './dist/index.js';