@luban-cli/cli-plugin-service/dist/main.d.ts

A development runtime environment dependency

import webpack = require("webpack");
import webpackDevServer = require("webpack-dev-server");
import { Request, Response, NextFunction } from "express";
import { Parser, Stringifier, Syntax, Plugin } from "postcss/lib/postcss";
import "less";
import { WebpackConfigName, WebpackRawConfigCallbackConfiguration, UserConfig } from "./definitions";
export declare type CssLoaderOptions = Partial<{
    url: boolean | ((url: string, path: string) => boolean);
    import: boolean | ((url: string, media: string, path: string) => boolean);
    modules: boolean | "global" | "local" | Partial<{
        mode: "global" | "local";
        localIdentName: string;
        context: string;
        hashPrefix: string;
    }>;
    sourceMap: boolean;
    importLoaders: number;
    localsConvention: string;
    onlyLocals: boolean;
    esModule: boolean;
}>;
export declare type PostcssLoaderOptions = Partial<{
    exec: boolean;
    parser: boolean | Parser;
    syntax: boolean | Syntax;
    stringifier: Stringifier;
    config: {
        path?: string;
        context?: {
            env?: string;
            file?: {
                extname?: string;
                dirname?: string;
                basename?: string;
            };
        };
        options: Record<string, unknown>;
    };
    plugins: Plugin<any>[] | ((loader: webpack.loader.LoaderContext) => Plugin<any>[]);
    sourceMap: boolean | string;
}>;
export declare type MiniCSSLoaderOptions = Partial<{
    publicPath: string | ((url: string, path: string) => string);
    emit: boolean;
    esModule: boolean;
}>;
export declare type LessLoaderOptions = Partial<Less.Options & {
    sourceMap?: boolean;
}>;
declare type OptionsOfCssLoader = {
    css: Partial<CssLoaderOptions>;
    less: LessLoaderOptions;
    miniCss: Partial<MiniCSSLoaderOptions>;
};
declare type AssetsDir = {
    scripts: string;
    styles: string;
    images: string;
    fonts: string;
    media: string;
};
declare type CssConfig = {
    /**
     * @description 是否为 CSS/Less 开启 source map
     *
     * @default process.env.NODE_ENV === "development"
     */
    sourceMap: boolean;
    /**
     * @description 一些处理 css 的 loader 的配置项
     * 支持的 loader 有:
     * [css-loader](https://www.npmjs.com/package/css-loader/v/3.4.0)
     * [less-loader](https://www.npmjs.com/package/less-loader/v/5.0.0)
     * [mini-css-extract-plugin](https://www.npmjs.com/package/mini-css-extract-plugin/v/1.4.1#publicPath)
     *
     * postcss-loader 可以配置 postcss.config.js
     */
    loaderOptions: Partial<OptionsOfCssLoader>;
};
export declare type ProjectConfig = {
    /**
     * @description 应用部署时的基本 URL
     *
     * @default "/"
     */
    publicPath: string;
    /**
     * @description 生产环境下应用打包的目录
     *
     * @default "dist"
     */
    outputDir: string;
    /**
     * @description 放置生成的静态资源(js、css、img、fonts)的目录
     *
     * 默认脚本文件放在 `scripts` 目录下
     * 样式文件放在 `styles` 目录下
     * 图片放在 `images` 目录下
     * 字体文件放在 `fonts` 目录下
     * 媒体文件放在 `media` 目录下
     * 以上目录都是相对于 `outputDir`
     */
    assetsDir: Partial<AssetsDir>;
    /**
     * @description 指定生成的 index.html 文件名或者相对路径（路径是相对于 `outputDir` 的）
     * 默认路径为 `${outputDir}/index.html`
     *
     * @default "index.html"
     */
    indexPath: string;
    /**
     * @description 指定模板文件名称或者相对路径（路径是相对于 `template` 的）
     * 默认路径为 `template/index.html`
     *
     * @default "index.html"
     */
    templatePath: string;
    /**
     * @description 是否在生成环境下开启 sourceMap
     *
     * @default false
     */
    productionSourceMap: boolean;
    /**
     * @description webpack 配置
     * 这个值是一个函数，接收被解析的配置和配置名称作为参数。
     * 该函数可以修改配置并不返回任何东西，也可以返回一个被克隆或合并过的配置版本
     * 被解析的配置只包括 ‘module’ 'plugins' 'externals', 同时也只能返回这三个配置项
     *
     * 即通过 `configureWebpack` 只允许修改 ‘module’ 'plugins' 'externals' 这三个配置项
     *
     * **不允许直接返回 `config` 参数**
     *
     * @type {Function | undefined}
     *
     * @default {() => undefined}
     */
    configureWebpack: (config: WebpackRawConfigCallbackConfiguration, id: WebpackConfigName) => WebpackRawConfigCallbackConfiguration | void;
    /**
     * @description 是一个函数，会接收一个基于 `webpack-chain` 的 `Config` 实例
     * 允许对内部的 webpack 配置进行更细粒度的修改
     * 通过 `chainWebpack` 只允许修改 ‘module’ 'plugins' 'externals' 这三个配置项
     *
     * @default {() => undefined}
     */
    chainWebpack: (config: UserConfig, id: WebpackConfigName) => void;
    /**
     * @description 一些解析 css 的配置选项
     */
    css: Partial<CssConfig>;
    /**
     * @description webpack-dev-server 的配置项
     * @deprecated since 2.0
     */
    devServer: webpackDevServer.Configuration;
    /**
     * @description 是否禁用页面上的 error overlay
     * @default true 默认启用
     */
    refreshOverlay: boolean;
    /**
     * @description 图片等文件的最大 size
     * @default 4096
     */
    assetsLimit: number;
    /**
     * @description 项目路径映射别名
     */
    alias: Record<string, string>;
    /**
     * @description 是否开启本地 mock 服务
     * 约定根目录下`mock/index.js` 为默认 mock 配置文件
     */
    mock: boolean;
    /**
     * @description 是否开启 server side rendering
     */
    ssr: boolean;
};
export declare function createProjectConfig(params: Partial<ProjectConfig>): Partial<ProjectConfig>;
export declare type MockFunction = (req: Request, res: Response, next?: NextFunction) => void;
export declare type MockValue = string | {
    [key: string]: unknown;
} | MockFunction;
export declare type MockConfig = {
    [key: string]: MockValue;
};
export {};