@rsdoctor/types 1.2.3 → 1.2.4-beta.0

package/dist/babel.d.ts

@@ -11,4 +11,3 @@ export interface Error {
         column: number;
     };
 }
-//# sourceMappingURL=babel.d.ts.map

package/dist/client.d.ts

@@ -1,6 +1,7 @@
 export declare enum RsdoctorClientUrlQuery {
     BundleDiffFiles = "__bundle_files__",
-    ManifestFile = "manifest"
+    ManifestFile = "manifest",
+    EnableRoutes = "enableRoutes"
 }
 export declare enum RsdoctorClientRoutes {
     Home = "/",
@@ -107,4 +108,3 @@ export interface RsdoctorClientAssetsSummary {
     };
 }
 export {};
-//# sourceMappingURL=client.d.ts.map

package/dist/client.js

@@ -5,6 +5,7 @@ var RsdoctorClientUrlQuery;
 (function (RsdoctorClientUrlQuery) {
     RsdoctorClientUrlQuery["BundleDiffFiles"] = "__bundle_files__";
     RsdoctorClientUrlQuery["ManifestFile"] = "manifest";
+    RsdoctorClientUrlQuery["EnableRoutes"] = "enableRoutes";
 })(RsdoctorClientUrlQuery || (exports.RsdoctorClientUrlQuery = RsdoctorClientUrlQuery = {}));
 var RsdoctorClientRoutes;
 (function (RsdoctorClientRoutes) {

package/dist/common.d.ts

@@ -24,4 +24,3 @@ export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) ex
 export type LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends () => infer R ? R : never;
 export type Push<T extends any[], V> = [...T, V];
 export type UnionToTuple<T, L = LastOf<T>, N = [T] extends [never] ? true : false> = true extends N ? [] : Push<UnionToTuple<Exclude<T, L>>, L>;
-//# sourceMappingURL=common.d.ts.map

package/dist/config.d.ts

@@ -0,0 +1,74 @@
+export interface BriefConfig {
+    reportHtmlName?: string;
+    writeDataJson: boolean;
+}
+/**
+ * @deprecated This type is deprecated and will be removed in a future version.
+ * Use {@link NewReportCodeType} instead for better type safety and consistency.
+ */
+export type IReportCodeType = {
+    noModuleSource?: boolean;
+    noAssetsAndModuleSource?: boolean;
+    noCode?: boolean;
+};
+export interface NormalModeOptions {
+    type?: never;
+}
+interface JsonSectionOptions {
+    /**
+     * @default: true
+     * */
+    moduleGraph?: boolean;
+    /**
+     * @default: true
+     * */
+    chunkGraph?: boolean;
+    /**
+     * @default: true
+     * */
+    rules?: boolean;
+}
+export interface JsonOptions {
+    sections?: JsonSectionOptions;
+}
+export interface BriefModeOptions {
+    /** Output type, supports HTML and JSON */
+    type?: Array<'html' | 'json'>;
+    /** HTML output related configuration */
+    htmlOptions?: BriefConfig;
+    /** JSON output related configuration */
+    jsonOptions?: JsonOptions;
+}
+interface OutputBaseConfig {
+    /**
+     * The directory where the report files will be output.
+     */
+    reportDir?: string;
+    /**
+     * Control the Rsdoctor reporter codes records.
+     */
+    reportCodeType?: IReportCodeType | undefined | NewReportCodeType;
+    /**
+     * @deprecated
+     * Configure whether to compress data.
+     * @default false
+     *
+     */
+    compressData?: boolean;
+}
+export interface BriefModeConfig extends Omit<OutputBaseConfig, 'reportCodeType' | 'mode'> {
+    mode?: 'brief';
+    reportCodeType?: ReportCodeTypeByMode<'brief'>;
+    options?: BriefModeOptions;
+}
+interface NormalModeConfig extends Omit<OutputBaseConfig, 'reportCodeType' | 'mode'> {
+    mode?: 'normal';
+    reportCodeType?: ReportCodeTypeByMode<'normal'>;
+    options?: NormalModeOptions;
+}
+type ReportCodeTypeByMode<T extends 'brief' | 'normal'> = T extends 'brief' ? undefined | 'noCode' | {
+    noCode?: boolean;
+} : T extends 'normal' ? IReportCodeType | undefined | NewReportCodeType : IReportCodeType | undefined | NewReportCodeType;
+export type IOutput<T extends 'brief' | 'normal'> = T extends 'brief' ? BriefModeConfig : T extends 'normal' ? NormalModeConfig : BriefModeConfig | NormalModeConfig | OutputBaseConfig;
+export type NewReportCodeType = 'noModuleSource' | 'noAssetsAndModuleSource' | 'noCode';
+export {};

package/dist/config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/constants.d.ts

@@ -15,4 +15,3 @@ export declare const RsdoctorMonitorDocBId = "Rsdoctor-Doc";
 export declare const RsdoctorProcessEnvDebugKey = "rsdoctor";
 export declare const RsdoctorClientUrl = "";
 export declare const WINDOW_RSDOCTOR_TAG = "__RSDOCTOR__";
-//# sourceMappingURL=constants.d.ts.map

package/dist/emo.d.ts

@@ -26,4 +26,3 @@ export declare enum EmoCheckSeverity {
     Warn = 1,
     Info = 2
 }
-//# sourceMappingURL=emo.d.ts.map

package/dist/error.d.ts

@@ -73,7 +73,7 @@ export interface ControllerOption {
 export interface FixData {
     /** Modify the starting position of string in the original text. */
     start: number;
-    /** Modify string in the key position of the original text */
+    /** Modify the ending position of string in the original text */
     end: number;
     /**
      * Replaced new text
@@ -87,7 +87,7 @@ export interface FixData {
 export interface DevToolErrorData {
     /** Error number */
     id: number;
-    /** Wrong code */
+    /** Error code */
     code?: string;
     /** Error category */
     category?: string;
@@ -135,4 +135,3 @@ export type DevToolErrorParams = Omit<NonFunctionProperties<DevToolErrorInstance
     controller?: ControllerOption;
     codeFrame?: CodeFrameOption;
 };
-//# sourceMappingURL=error.d.ts.map

package/dist/esbuild.d.ts

@@ -28,4 +28,3 @@ interface Location {
     suggestion: string;
 }
 export {};
-//# sourceMappingURL=esbuild.d.ts.map

package/dist/index.d.ts

@@ -12,4 +12,4 @@ export * as Thirdparty from './thirdparty';
 export * as Client from './client';
 export * as Constants from './constants';
 export * as Plugin from './plugin';
-//# sourceMappingURL=index.d.ts.map
+export * as Config from './config';

package/dist/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Plugin = exports.Constants = exports.Client = exports.Thirdparty = exports.Rule = exports.Linter = exports.Modules = exports.SDK = exports.Logger = exports.Err = exports.Common = exports.Babel = exports.Esbuild = exports.Manifest = void 0;
+exports.Config = exports.Plugin = exports.Constants = exports.Client = exports.Thirdparty = exports.Rule = exports.Linter = exports.Modules = exports.SDK = exports.Logger = exports.Err = exports.Common = exports.Babel = exports.Esbuild = exports.Manifest = void 0;
 exports.Manifest = __importStar(require("./manifest"));
 exports.Esbuild = __importStar(require("./esbuild"));
 exports.Babel = __importStar(require("./babel"));
@@ -48,3 +48,4 @@ exports.Thirdparty = __importStar(require("./thirdparty"));
 exports.Client = __importStar(require("./client"));
 exports.Constants = __importStar(require("./constants"));
 exports.Plugin = __importStar(require("./plugin"));
+exports.Config = __importStar(require("./config"));

package/dist/linter/diagnostic.d.ts

@@ -46,4 +46,3 @@ export interface Diagnostic extends Omit<ReportData, 'severity'>, Pick<RuleMessa
     title: string;
     detail?: RuleStoreDataItem;
 }
-//# sourceMappingURL=diagnostic.d.ts.map

package/dist/linter/index.d.ts

@@ -1,3 +1,2 @@
 export * from './diagnostic';
 export * from './rule';
-//# sourceMappingURL=index.d.ts.map

package/dist/linter/rule.d.ts

@@ -105,4 +105,3 @@ export type InferRulesConfig<T extends (ExtendRuleData | RuleData)[]> = {
     [key: string]: RuleConfigItem;
 };
 export {};
-//# sourceMappingURL=rule.d.ts.map

package/dist/logger.d.ts

@@ -7,4 +7,3 @@ export declare enum LogLevel {
     Verbose = 5
 }
 export type LogLevelName = keyof typeof LogLevel;
-//# sourceMappingURL=logger.d.ts.map

package/dist/manifest.d.ts

@@ -66,4 +66,3 @@ export interface ManifestDataLoader {
         <T extends RsdoctorManifestMappingKeys>(key: T): Promise<void | InferManifestDataValue<T>>;
     };
 }
-//# sourceMappingURL=manifest.d.ts.map

package/dist/modules.d.ts

@@ -5,4 +5,3 @@ export type ChunkModuleMap = {
     modules: StatsModule[];
 };
 export type Modules = Record<string | number, ChunkModuleMap>;
-//# sourceMappingURL=modules.d.ts.map

package/dist/plugin/baseCompiler.d.ts

@@ -31,4 +31,3 @@ export type BuildWarning = JsStatsWarning | StatsError;
 export type BuildRuleSetRules = (false | '' | 0 | RuleSetRule | '...' | null | undefined)[];
 export type BuildRuleSetRule = RuleSetRule | RspackRuleSetRuleWrapper;
 export {};
-//# sourceMappingURL=baseCompiler.d.ts.map

package/dist/plugin/baseLoader.d.ts

@@ -76,4 +76,3 @@ export type LoaderDefinition<T, R> = LoaderDefinitionFunction<T, R> & {
     pitch?: PitchLoaderDefinitionFunction<T> | RspackPitchLoaderDefinitionFunction<T>;
 };
 export {};
-//# sourceMappingURL=baseLoader.d.ts.map

package/dist/plugin/baseStats.d.ts

@@ -11,6 +11,9 @@ interface StatsOptionsObj {
     errors?: boolean;
     errorsCount?: boolean;
     colors?: boolean;
+    chunkModules?: boolean;
+    hash?: boolean;
+    ids?: boolean;
     /** Rspack not support below opts */
     cachedAssets?: boolean;
     groupAssetsByInfo?: boolean;
@@ -123,4 +126,3 @@ export declare class Stats {
     toString(opts?: StatsOptions): string;
 }
 export {};
-//# sourceMappingURL=baseStats.d.ts.map

package/dist/plugin/index.d.ts

@@ -3,4 +3,5 @@ export * from './baseStats';
 export * from './plugin';
 export * from './baseLoader';
 export * from './rspack';
-//# sourceMappingURL=index.d.ts.map
+export * from './internal-rules';
+export * from './webpack';

package/dist/plugin/index.js

@@ -19,3 +19,5 @@ __exportStar(require("./baseStats"), exports);
 __exportStar(require("./plugin"), exports);
 __exportStar(require("./baseLoader"), exports);
 __exportStar(require("./rspack"), exports);
+__exportStar(require("./internal-rules"), exports);
+__exportStar(require("./webpack"), exports);

package/dist/plugin/internal-rules.d.ts

@@ -0,0 +1,4 @@
+import { Linter } from '../index';
+export type InternalRules = Linter.RuleData[];
+export type InternalRuleId = 'E1001' | 'E1002' | 'E1003' | 'E1004' | 'E1005';
+export type InternalRuleName = 'duplicate-package' | 'cross-chunks-package' | 'default-import-check' | 'ecma-version-check' | 'loader-performance-optimization';

package/dist/plugin/internal-rules.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/plugin/plugin.d.ts

@@ -1,3 +1,5 @@
+import { Common, Config, Linter as LinterType, SDK } from '..';
+import { InternalRules } from './internal-rules';
 export interface RsdoctorWebpackPluginFeatures {
     /**
      * turn off it if you need not to analyze the executions of webpack loaders.
@@ -30,4 +32,128 @@ export interface RsdoctorWebpackPluginFeatures {
      */
     lite?: boolean;
 }
-//# sourceMappingURL=plugin.d.ts.map
+export interface RsdoctorPluginOptionsNormalized<Rules extends LinterType.ExtendRuleData[] = []> extends Common.DeepRequired<Omit<RsdoctorWebpackPluginOptions<Rules>, 'sdkInstance' | 'linter' | 'output' | 'supports' | 'port' | 'brief' | 'mode'>> {
+    features: Common.DeepRequired<RsdoctorWebpackPluginFeatures>;
+    linter: Required<LinterType.Options<Rules, InternalRules>>;
+    sdkInstance?: SDK.RsdoctorBuilderSDKInstance;
+    output: {
+        mode: keyof typeof SDK.IMode;
+        reportCodeType: SDK.ToDataType;
+        reportDir: string;
+        options: Config.BriefModeOptions | Config.NormalModeOptions;
+    };
+    port?: number;
+    supports: ISupport;
+}
+interface ISupport {
+    banner?: boolean;
+    parseBundle?: boolean;
+    generateTileGraph?: boolean;
+    gzip?: boolean;
+}
+interface OutputBaseConfig {
+    /**
+     * The directory where the report files will be output.
+     */
+    reportDir?: string;
+    /**
+     * Control the Rsdoctor reporter codes records.
+     */
+    reportCodeType?: IReportCodeType | undefined | NewReportCodeType;
+    /**
+     * @deprecated
+     * Configure whether to compress data.
+     * @default false
+     *
+     */
+    compressData?: boolean;
+}
+export type IReportCodeType = {
+    noModuleSource?: boolean;
+    noAssetsAndModuleSource?: boolean;
+    noCode?: boolean;
+};
+export type NewReportCodeType = 'noModuleSource' | 'noAssetsAndModuleSource' | 'noCode';
+export interface RsdoctorWebpackPluginOptions<Rules extends LinterType.ExtendRuleData[]> {
+    /** Checker configuration */
+    linter?: LinterType.Options<Rules, InternalRules>;
+    /**
+     * the switch for the Rsdoctor features.
+     */
+    features?: RsdoctorWebpackPluginFeatures | Array<keyof RsdoctorWebpackPluginFeatures>;
+    /**
+     * @deprecated  Use `output.mode` instead, if you're using `lite` mode, please use `output.reportCodeType: 'noCode' or 'noAssetsAndModuleSource'` instead.
+     * Rsdoctor mode option:
+     * - normal: Refers to the normal mode.
+     * - brief: Refers to the brief mode, which only displays the results of the duration analysis and build artifact analysis
+     *    and does not display any part of the code.
+     */
+    mode?: 'brief' | 'normal' | 'lite';
+    /**
+     * configuration of the interceptor for webpack loaders. TODO: delete this options.
+     * @description worked when the `features.loader === true`.
+     */
+    loaderInterceptorOptions?: {
+        /**
+         * loaders which you want to skip it (will not report the target loader data when webpack compile).
+         */
+        skipLoaders?: string[];
+    };
+    /**
+     * turn on it if you don't need to see profile in browser.
+     * @default false
+     */
+    disableClientServer?: boolean;
+    /**
+     * sdk instance of outside.
+     */
+    sdkInstance?: SDK.RsdoctorBuilderSDKInstance;
+    /**
+     * Whether to turn on some characteristic analysis capabilities, such as: the support for the BannerPlugin.
+     */
+    supports?: ISupport;
+    /**
+     * The port of the Rsdoctor server.
+     */
+    port?: number;
+    /**
+     * Options to control the log printing.
+     */
+    printLog?: SDK.IPrintLog;
+    /**
+     * @deprecated  Use `output.options.htmlOptions` instead.
+     * Please use the output.options to set the brief options, BriefModeOptions.
+     * Options to control brief mode reports.
+     */
+    brief?: Config.BriefConfig;
+    /**
+     * The name of inner rsdoctor's client package, used by inner-rsdoctor.
+     * @default false
+     */
+    innerClientPath?: string;
+    output?: Config.IOutput<'brief' | 'normal'>;
+}
+type ReportCodeTypeByMode<T extends 'brief' | 'normal'> = T extends 'brief' ? undefined | 'noCode' | {
+    noCode?: boolean;
+} : T extends 'normal' ? IReportCodeType | undefined | NewReportCodeType : IReportCodeType | undefined | NewReportCodeType;
+export interface NormalModeOptions {
+    type?: never;
+}
+interface NormalModeConfig extends Omit<OutputBaseConfig, 'reportCodeType' | 'mode'> {
+    mode?: 'normal';
+    reportCodeType?: ReportCodeTypeByMode<'normal'>;
+    options?: NormalModeOptions;
+}
+export interface BriefModeOptions {
+    /** Output type, supports HTML and JSON */
+    type?: Array<'html'>;
+    /** HTML output related configuration */
+    htmlOptions?: Config.BriefConfig;
+}
+export interface BriefModeConfig extends Omit<OutputBaseConfig, 'reportCodeType' | 'mode'> {
+    mode?: 'brief';
+    reportCodeType?: ReportCodeTypeByMode<'brief'>;
+    options?: BriefModeOptions;
+}
+export type IOutput<T extends 'brief' | 'normal' | undefined = undefined> = T extends 'brief' ? BriefModeConfig : T extends 'normal' ? NormalModeConfig : BriefModeConfig | NormalModeConfig | OutputBaseConfig;
+export {};

package/dist/plugin/rspack.d.ts

@@ -20,4 +20,3 @@ export type RspackNativeModuleOriginalSource = RsdoctorPluginData.RsdoctorModule
 export type RspackNativeModuleSourcePatch = RsdoctorPluginData.RsdoctorModuleSourcesPatch;
 import rspack from '@rspack/core';
 export type RspackExportsExperiments = typeof rspack.experiments;
-//# sourceMappingURL=rspack.d.ts.map

package/dist/plugin/webpack.d.ts

@@ -0,0 +1,13 @@
+import { Compiler, Compilation, LoaderDefinitionFunction, ModuleGraph, Dependency } from 'webpack';
+type GetMapValue<M extends Map<any, any>> = M extends Map<string, infer V> ? V : never;
+export type NormalModuleFactory = ReturnType<Compiler['createNormalModuleFactory']>;
+export type SourceMapInput = Parameters<LoaderDefinitionFunction>[1];
+export type EntryPoint = GetMapValue<Compilation['entrypoints']>;
+export type ExportInfo = ReturnType<ModuleGraph['getExportInfo']>;
+export type ExportsInfo = ReturnType<ModuleGraph['getExportsInfo']>;
+export interface HarmonyImportSpecifierDependency extends Dependency {
+    getIds(graph: ModuleGraph): string[];
+    name: string;
+    userRequest: string;
+}
+export {};

package/dist/plugin/webpack.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/rule/code/E1001.d.ts

@@ -1,4 +1,3 @@
 import { RuleMessage } from './type';
 export declare const code = "E1001";
 export declare const message: RuleMessage;
-//# sourceMappingURL=E1001.d.ts.map

package/dist/rule/code/E1002.d.ts

@@ -1,4 +1,3 @@
 import { RuleMessage } from './type';
 export declare const code = "E1002";
 export declare const message: RuleMessage;
-//# sourceMappingURL=E1002.d.ts.map

package/dist/rule/code/E1003.d.ts

@@ -1,4 +1,3 @@
 import { RuleMessage } from './type';
 export declare const code = "E1003";
 export declare const message: RuleMessage;
-//# sourceMappingURL=E1003.d.ts.map

package/dist/rule/code/E1004.d.ts

@@ -1,4 +1,3 @@
 import { RuleMessage } from './type';
 export declare const code = "E1004";
 export declare const message: RuleMessage;
-//# sourceMappingURL=E1004.d.ts.map

package/dist/rule/code/E1005.d.ts

@@ -1,4 +1,3 @@
 import { RuleMessage } from './type';
 export declare const code = "E1005";
 export declare const message: RuleMessage;
-//# sourceMappingURL=E1005.d.ts.map

package/dist/rule/code/index.d.ts

@@ -23,4 +23,3 @@ export declare enum RsdoctorRuleClientConstant {
     UrlQueryForErrorCode = "code"
 }
 export * from './type';
-//# sourceMappingURL=index.d.ts.map

package/dist/rule/code/type.d.ts

@@ -25,4 +25,3 @@ export interface RuleMessage {
     category: `${RuleMessageCategory}` | RuleMessageCategory;
     description: string;
 }
-//# sourceMappingURL=type.d.ts.map

package/dist/rule/data.d.ts

@@ -132,4 +132,3 @@ export interface OverlayRuleStoreData extends BaseRuleStoreData {
 }
 export type RuleStoreDataItem = LinkRuleStoreData | FileRelationRuleStoreData | CodeChangeRuleStoreData | PackageRelationDiffRuleStoreData | CodeViewRuleStoreData | CrossChunksPackageRuleStoreData;
 export type RuleStoreData = RuleStoreDataItem[];
-//# sourceMappingURL=data.d.ts.map

package/dist/rule/index.d.ts

@@ -1,3 +1,2 @@
 export * from './code';
 export * from './data';
-//# sourceMappingURL=index.d.ts.map

package/dist/sdk/chunk.d.ts

@@ -140,4 +140,3 @@ export interface EntryPointData extends NonFunctionProperties<EntryPointInstance
      */
     size: number;
 }
-//# sourceMappingURL=chunk.d.ts.map

package/dist/sdk/config.d.ts

@@ -2,7 +2,7 @@ import type { Configuration } from 'webpack';
 import type { Configuration as RspackConfiguration } from '@rspack/core';
 type RspackConfigurationWrapper = any extends RspackConfiguration ? never : RspackConfiguration;
 export interface WebpackConfigData {
-    name: 'webpack' | 'rspack';
+    name: string;
     version: string | number;
     bin?: string;
     config: Configuration | RspackConfigurationWrapper;
@@ -10,4 +10,3 @@ export interface WebpackConfigData {
 }
 export type ConfigData = WebpackConfigData[];
 export {};
-//# sourceMappingURL=config.d.ts.map

package/dist/sdk/context.d.ts

@@ -21,4 +21,3 @@ export interface RuntimeContext {
 }
 export interface RuntimeContextOptions {
 }
-//# sourceMappingURL=context.d.ts.map

package/dist/sdk/envinfo.d.ts

@@ -17,4 +17,3 @@ export interface EnvInfo {
     pnpmVersion: string;
     [key: string]: string;
 }
-//# sourceMappingURL=envinfo.d.ts.map

package/dist/sdk/hooks.d.ts

@@ -12,4 +12,3 @@ export interface Hooks {
         }
     ]>;
 }
-//# sourceMappingURL=hooks.d.ts.map

package/dist/sdk/index.d.ts

@@ -14,4 +14,3 @@ export * from './treeShaking';
 export * from './envinfo';
 export * from './instance';
 export * from './hooks';
-//# sourceMappingURL=index.d.ts.map