@umijs/core 3.5.20 → 4.0.0-beta.12

package/dist/service/plugin.js

@@ -0,0 +1,147 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plugin = void 0;
+const esbuild_1 = __importDefault(require("@umijs/bundler-utils/compiled/esbuild"));
+const utils_1 = require("@umijs/utils");
+const assert_1 = __importDefault(require("assert"));
+const fs_1 = require("fs");
+const path_1 = require("path");
+const types_1 = require("../types");
+const RE = {
+    plugin: /^(@umijs\/|umi-)plugin-/,
+    preset: /^(@umijs\/|umi-)preset-/,
+};
+class Plugin {
+    constructor(opts) {
+        this.config = {};
+        this.enableBy = types_1.EnableBy.register;
+        this.type = opts.type;
+        this.path = (0, utils_1.winPath)(opts.path);
+        this.cwd = opts.cwd;
+        (0, assert_1.default)((0, fs_1.existsSync)(this.path), `Invalid ${this.type} ${this.path}, it's not exists.`);
+        let pkg = null;
+        // path is the package entry
+        let isPkgEntry = false;
+        const pkgJSONPath = utils_1.pkgUp.sync({ cwd: this.path });
+        if (pkgJSONPath) {
+            pkg = require(pkgJSONPath);
+            isPkgEntry =
+                (0, utils_1.winPath)((0, path_1.join)((0, path_1.dirname)(pkgJSONPath), pkg.main || 'index.js')) ===
+                    (0, utils_1.winPath)(this.path);
+        }
+        this.id = this.getId({ pkg, isPkgEntry, pkgJSONPath });
+        this.key = this.getKey({ pkg, isPkgEntry });
+        this.apply = () => {
+            utils_1.register.register({
+                implementor: esbuild_1.default,
+            });
+            utils_1.register.clearFiles();
+            let ret;
+            try {
+                ret = require(this.path);
+            }
+            catch (e) {
+                throw new Error(`Register ${this.type} ${this.path} failed, since ${e.message}`);
+            }
+            for (const file of utils_1.register.getFiles()) {
+                delete require.cache[file];
+            }
+            utils_1.register.restore();
+            // use the default member for es modules
+            return ret.__esModule ? ret.default : ret;
+        };
+    }
+    merge(opts) {
+        if (opts.key)
+            this.key = opts.key;
+        if (opts.config)
+            this.config = opts.config;
+        if (opts.enableBy)
+            this.enableBy = opts.enableBy;
+    }
+    getId(opts) {
+        let id;
+        if (opts.isPkgEntry) {
+            id = opts.pkg.name;
+        }
+        else if ((0, utils_1.winPath)(this.path).startsWith((0, utils_1.winPath)(this.cwd))) {
+            id = `./${(0, utils_1.winPath)((0, path_1.relative)(this.cwd, this.path))}`;
+        }
+        else if (opts.pkgJSONPath) {
+            id = (0, utils_1.winPath)((0, path_1.join)(opts.pkg.name, (0, path_1.relative)((0, path_1.dirname)(opts.pkgJSONPath), this.path)));
+        }
+        else {
+            id = (0, utils_1.winPath)(this.path);
+        }
+        id = id.replace('@umijs/preset-umi/lib/plugins', '@@');
+        id = id.replace(/\.js$/, '');
+        return id;
+    }
+    getKey(opts) {
+        // e.g.
+        // initial-state -> initialState
+        // webpack.css-loader -> webpack.cssLoader
+        function nameToKey(name) {
+            return name
+                .split('.')
+                .map((part) => utils_1.lodash.camelCase(part))
+                .join('.');
+        }
+        return nameToKey(opts.isPkgEntry
+            ? Plugin.stripNoneUmiScope(opts.pkg.name).replace(RE[this.type], '')
+            : (0, path_1.basename)(this.path, (0, path_1.extname)(this.path)));
+    }
+    static isPluginOrPreset(type, name) {
+        return RE[type].test(Plugin.stripNoneUmiScope(name));
+    }
+    static stripNoneUmiScope(name) {
+        if (name.charAt(0) === '@' && !name.startsWith('@umijs/')) {
+            name = name.split('/')[1];
+        }
+        return name;
+    }
+    static getPluginsAndPresets(opts) {
+        function get(type) {
+            const types = `${type}s`;
+            return [
+                // opts
+                ...(opts[types] || []),
+                // env
+                ...(process.env[`${opts.prefix}_${types}`.toUpperCase()] || '')
+                    .split(',')
+                    .filter(Boolean),
+                // dependencies
+                ...Object.keys(opts.pkg.devDependencies || {})
+                    .concat(Object.keys(opts.pkg.dependencies || {}))
+                    .filter(Plugin.isPluginOrPreset.bind(null, type)),
+                // user config
+                ...(opts.userConfig[types] || []),
+            ].map((path) => {
+                (0, assert_1.default)(typeof path === 'string', `Invalid plugin ${path}, it must be string.`);
+                let resolved;
+                try {
+                    resolved = utils_1.resolve.sync(path, {
+                        basedir: opts.cwd,
+                        extensions: ['.tsx', '.ts', '.mjs', '.jsx', '.js'],
+                    });
+                }
+                catch (_e) {
+                    throw new Error(`Invalid plugin ${path}, can not be resolved.`);
+                }
+                return new Plugin({
+                    path: resolved,
+                    type,
+                    cwd: opts.cwd,
+                });
+            });
+        }
+        return {
+            presets: get('preset'),
+            plugins: get('plugin'),
+        };
+    }
+}
+exports.Plugin = Plugin;

package/dist/service/pluginAPI.d.ts

@@ -0,0 +1,44 @@
+import { logger } from '@umijs/utils';
+import { EnableBy, Env, IPluginConfig } from '../types';
+import { IOpts as ICommandOpts } from './command';
+import { IGeneratorOpts } from './generator';
+import { IOpts as IHookOpts } from './hook';
+import { Plugin } from './plugin';
+import { Service } from './service';
+declare type Logger = typeof logger;
+export declare class PluginAPI {
+    service: Service;
+    plugin: Plugin;
+    logger: Logger;
+    constructor(opts: {
+        service: Service;
+        plugin: Plugin;
+    });
+    describe(opts: {
+        key?: string;
+        config?: IPluginConfig;
+        enableBy?: EnableBy | ((enableByOpts: {
+            config: any;
+            env: Env;
+        }) => boolean);
+    }): void;
+    registerCommand(opts: Omit<ICommandOpts, 'plugin'> & {
+        alias?: string | string[];
+    }): void;
+    registerGenerator(opts: Omit<IGeneratorOpts, 'plugin'>): void;
+    register(opts: Omit<IHookOpts, 'plugin'>): void;
+    registerMethod(opts: {
+        name: string;
+        fn?: Function;
+    }): void;
+    registerPresets(source: Plugin[], presets: any[]): void;
+    registerPlugins(source: Plugin[], plugins: any[]): void;
+    skipPlugins(ids: string[]): void;
+    static proxyPluginAPI(opts: {
+        pluginAPI: PluginAPI;
+        service: Service;
+        serviceProps: string[];
+        staticProps: Record<string, any>;
+    }): PluginAPI;
+}
+export {};

package/dist/service/pluginAPI.js

@@ -0,0 +1,146 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginAPI = void 0;
+const utils_1 = require("@umijs/utils");
+const assert_1 = __importDefault(require("assert"));
+const types_1 = require("../types");
+const command_1 = require("./command");
+const generator_1 = require("./generator");
+const hook_1 = require("./hook");
+const plugin_1 = require("./plugin");
+const utils_2 = require("./utils");
+class PluginAPI {
+    constructor(opts) {
+        this.service = opts.service;
+        this.plugin = opts.plugin;
+        // logger
+        const loggerKeys = [
+            'wait',
+            'error',
+            'warn',
+            'ready',
+            'info',
+            'event',
+        ];
+        // @ts-ignore
+        this.logger = loggerKeys.reduce((memo, key) => {
+            // @ts-ignore
+            memo[key] = (...message) => {
+                // @ts-ignore
+                utils_1.logger[key](utils_1.chalk.green(`[plugin: ${this.plugin.id}]`), ...message);
+            };
+            return memo;
+        }, {});
+    }
+    describe(opts) {
+        this.plugin.merge(opts);
+    }
+    registerCommand(opts) {
+        const { alias } = opts;
+        delete opts.alias;
+        const registerCommand = (commandOpts) => {
+            var _a;
+            const { name } = commandOpts;
+            (0, assert_1.default)(!this.service.commands[name], `api.registerCommand() failed, the command ${name} is exists from ${(_a = this.service.commands[name]) === null || _a === void 0 ? void 0 : _a.plugin.id}.`);
+            this.service.commands[name] = new command_1.Command(Object.assign(Object.assign({}, commandOpts), { plugin: this.plugin }));
+        };
+        registerCommand(opts);
+        if (alias) {
+            const aliases = (0, utils_2.makeArray)(alias);
+            aliases.forEach((alias) => {
+                registerCommand(Object.assign(Object.assign({}, opts), { name: alias }));
+            });
+        }
+    }
+    registerGenerator(opts) {
+        var _a;
+        const { key } = opts;
+        (0, assert_1.default)(!this.service.generators[key], `api.registerGenerator() failed, the generator ${key} is exists from ${(_a = this.service.generators[key]) === null || _a === void 0 ? void 0 : _a.plugin.id}.`);
+        this.service.generators[key] = new generator_1.Generator(Object.assign(Object.assign({}, opts), { plugin: this.plugin }));
+    }
+    register(opts) {
+        var _a, _b;
+        (_a = this.service.hooks)[_b = opts.key] || (_a[_b] = []);
+        this.service.hooks[opts.key].push(new hook_1.Hook(Object.assign(Object.assign({}, opts), { plugin: this.plugin })));
+    }
+    registerMethod(opts) {
+        (0, assert_1.default)(!this.service.pluginMethods[opts.name], `api.registerMethod() failed, method ${opts.name} is already exist.`);
+        this.service.pluginMethods[opts.name] = {
+            plugin: this.plugin,
+            fn: opts.fn ||
+                // 这里不能用 arrow function，this 需指向执行此方法的 PluginAPI
+                // 否则 pluginId 会不会，导致不能正确 skip plugin
+                function (fn) {
+                    // @ts-ignore
+                    this.register(Object.assign({ key: opts.name }, (utils_1.lodash.isPlainObject(fn) ? fn : { fn })));
+                },
+        };
+    }
+    registerPresets(source, presets) {
+        (0, assert_1.default)(this.service.stage === types_1.ServiceStage.initPresets, `api.registerPresets() failed, it should only used in presets.`);
+        source.splice(0, 0, ...presets.map((preset) => {
+            return new plugin_1.Plugin({
+                path: preset,
+                cwd: this.service.cwd,
+                type: types_1.PluginType.plugin,
+            });
+        }));
+    }
+    registerPlugins(source, plugins) {
+        (0, assert_1.default)(this.service.stage === types_1.ServiceStage.initPresets ||
+            this.service.stage === types_1.ServiceStage.initPlugins, `api.registerPlugins() failed, it should only be used in registering stage.`);
+        const mappedPlugins = plugins.map((plugin) => {
+            if (utils_1.lodash.isPlainObject(plugin)) {
+                (0, assert_1.default)(plugin.id && plugin.key, `Invalid plugin object, id and key must supplied.`);
+                plugin.type = types_1.PluginType.plugin;
+                plugin.enableBy = plugin.enableBy || types_1.EnableBy.register;
+                plugin.apply = plugin.apply || (() => () => { });
+                plugin.config = plugin.config || {};
+                return plugin;
+            }
+            else {
+                return new plugin_1.Plugin({
+                    path: plugin,
+                    cwd: this.service.cwd,
+                    type: types_1.PluginType.plugin,
+                });
+            }
+        });
+        if (this.service.stage === types_1.ServiceStage.initPresets) {
+            source.push(...mappedPlugins);
+        }
+        else {
+            source.splice(0, 0, ...mappedPlugins);
+        }
+    }
+    skipPlugins(ids) {
+        ids.forEach((id) => {
+            this.service.skipPluginIds.add(id);
+        });
+    }
+    static proxyPluginAPI(opts) {
+        return new Proxy(opts.pluginAPI, {
+            get: (target, prop) => {
+                if (opts.service.pluginMethods[prop]) {
+                    return opts.service.pluginMethods[prop].fn;
+                }
+                if (opts.serviceProps.includes(prop)) {
+                    // @ts-ignore
+                    const serviceProp = opts.service[prop];
+                    return typeof serviceProp === 'function'
+                        ? serviceProp.bind(opts.service)
+                        : serviceProp;
+                }
+                if (prop in opts.staticProps) {
+                    return opts.staticProps[prop];
+                }
+                // @ts-ignore
+                return target[prop];
+            },
+        });
+    }
+}
+exports.PluginAPI = PluginAPI;

package/dist/service/service.d.ts

@@ -0,0 +1,99 @@
+import { yParser } from '@umijs/utils';
+import { Config } from '../config/config';
+import { ApplyPluginsType, ConfigChangeType, EnableBy, Env, IEvent, IModify, ServiceStage } from '../types';
+import { Command } from './command';
+import { Generator } from './generator';
+import { Hook } from './hook';
+import { Plugin } from './plugin';
+interface IOpts {
+    cwd: string;
+    env: Env;
+    plugins?: string[];
+    presets?: string[];
+    frameworkName?: string;
+    defaultConfigFiles?: string[];
+}
+export declare class Service {
+    private opts;
+    appData: {
+        deps?: Record<string, string>;
+        [key: string]: any;
+    };
+    args: yParser.Arguments;
+    commands: Record<string, Command>;
+    generators: Record<string, Generator>;
+    config: Record<string, any>;
+    configSchemas: Record<string, any>;
+    configDefaults: Record<string, any>;
+    configOnChanges: Record<string, any>;
+    cwd: string;
+    env: Env;
+    hooks: Record<string, Hook[]>;
+    name: string;
+    paths: {
+        cwd?: string;
+        absSrcPath?: string;
+        absPagesPath?: string;
+        absTmpPath?: string;
+        absNodeModulesPath?: string;
+        absOutputPath?: string;
+    };
+    plugins: Record<string, Plugin>;
+    pluginMethods: Record<string, {
+        plugin: Plugin;
+        fn: Function;
+    }>;
+    skipPluginIds: Set<string>;
+    stage: ServiceStage;
+    userConfig: Record<string, any>;
+    configManager: Config | null;
+    pkg: Record<string, string | Record<string, any>>;
+    constructor(opts: IOpts);
+    applyPlugins<T>(opts: {
+        key: string;
+        type?: ApplyPluginsType;
+        initialValue?: any;
+        args?: any;
+    }): Promise<typeof opts.initialValue | T>;
+    run(opts: {
+        name: string;
+        args?: any;
+    }): Promise<void>;
+    initPreset(opts: {
+        preset: Plugin;
+        presets: Plugin[];
+        plugins: Plugin[];
+    }): Promise<void>;
+    initPlugin(opts: {
+        plugin: Plugin;
+        presets?: Plugin[];
+        plugins: Plugin[];
+    }): Promise<any>;
+    isPluginEnable(hook: Hook): boolean;
+}
+export interface IServicePluginAPI {
+    appData: typeof Service.prototype.appData;
+    applyPlugins: typeof Service.prototype.applyPlugins;
+    args: typeof Service.prototype.args;
+    config: typeof Service.prototype.config;
+    cwd: typeof Service.prototype.cwd;
+    generators: typeof Service.prototype.generators;
+    pkg: typeof Service.prototype.pkg;
+    name: typeof Service.prototype.name;
+    paths: Required<typeof Service.prototype.paths>;
+    userConfig: typeof Service.prototype.userConfig;
+    onCheck: IEvent<null>;
+    onStart: IEvent<null>;
+    modifyAppData: IModify<typeof Service.prototype.appData, null>;
+    modifyConfig: IModify<typeof Service.prototype.config, {
+        paths: Record<string, string>;
+    }>;
+    modifyDefaultConfig: IModify<typeof Service.prototype.config, null>;
+    modifyPaths: IModify<typeof Service.prototype.paths, null>;
+    ApplyPluginsType: typeof ApplyPluginsType;
+    ConfigChangeType: typeof ConfigChangeType;
+    EnableBy: typeof EnableBy;
+    ServiceStage: typeof ServiceStage;
+    registerPlugins: (plugins: (Plugin | {})[]) => void;
+}
+export {};