@rsdoctor/webpack-plugin 0.1.0 → 0.1.2

package/README.md

@@ -1,11 +1,38 @@
-# Rsdoctor
+# Rsdoctor plugin
 
-Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
+This Rsdoctor plugin is an analysis plugin for the Webpack builder.
 
-It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
+## features
+
+- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
+- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
+- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
+- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
+
+## Note
+
+This plugin is used by the `Webpack` repo to open Rsdoctor, [Quik Start](https://rsdoctor.dev/guide/start/quick-start).
+
+Initialize the RsdoctorWebpackPlugin plugin in the [plugins](https://webpack.js.org/configuration/plugins/#plugins) section of the `webpack.config.js` file, as shown below:
+
+```js title="webpack.config.js"
+const { RsdoctorWebpackPlugin } = require('@rsdoctor/webpack-plugin');
+
+module.exports = {
+  // ...
+  plugins: [
+    process.env.RSDOCTOR &&
+      new RsdoctorWebpackPlugin({
+        // options
+      }),
+  ].filter(Boolean),
+};
+```
 
 ## Documentation
 
+https://rsdoctor.dev/
+
 ## Contributing
 
 Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

package/dist/constants.d.ts

@@ -3,4 +3,4 @@ export declare const pluginTapName = "RsdoctorWebpackPlugin";
 export declare const pluginTapPostOptions: Tap;
 export declare const pluginTapPreOptions: Tap;
 export declare const internalPluginTapPreOptions: (namespace: string) => Tap;
-export declare const internalPluginTapPostOptions: (namespace: string) => Tap;
+export declare const internalPluginTapPostOptions: (namespace: string) => Tap;

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export * from './plugin';
 export * from './multiple';
-export { defineRule, LinterType } from '@rsdoctor/core/rules';
+export { defineRule, LinterType } from '@rsdoctor/core/rules';

package/dist/multiple.d.ts

@@ -2,6 +2,6 @@ import type { Linter } from '@rsdoctor/types';
 import type { RsdoctorWebpackMultiplePluginOptions } from '@rsdoctor/core';
 import { RsdoctorWebpackPlugin } from './plugin';
 export declare class RsdoctorWebpackMultiplePlugin<Rules extends Linter.ExtendRuleData[]> extends RsdoctorWebpackPlugin<Rules> {
-  private controller;
-  constructor(options?: RsdoctorWebpackMultiplePluginOptions<Rules>);
-}
+    private controller;
+    constructor(options?: RsdoctorWebpackMultiplePluginOptions<Rules>);
+}

package/dist/plugin.d.ts

@@ -4,24 +4,24 @@ import { RsdoctorWebpackSDK } from '@rsdoctor/sdk';
 import { Linter } from '@rsdoctor/types';
 import type { Compiler } from 'webpack';
 export declare class RsdoctorWebpackPlugin<Rules extends Linter.ExtendRuleData[]> implements RsdoctorPluginInstance<Compiler, Rules> {
-  readonly name = "RsdoctorWebpackPlugin";
-  readonly options: RsdoctorPluginOptionsNormalized<Rules>;
-  readonly sdk: RsdoctorWebpackSDK;
-  modulesGraph: ModuleGraph;
-  private outsideInstance;
-  _bootstrapTask: Promise<unknown>;
-  protected browserIsOpened: boolean;
-  chunkGraph: ChunkGraph;
-  constructor(options?: RsdoctorWebpackPluginOptions<Rules>);
-  apply(compiler: unknown): unknown;
-  afterPlugins: (compiler: Compiler) => void;
-  beforeRun: (compiler: Compiler) => Promise<void>;
-  /**
-   * @description Generate ModuleGraph and ChunkGraph from stats and webpack module apis;
-   * @param {Compiler} compiler
-   * @return {*}
-   * @memberof RsdoctorWebpackPlugin
-   */
-  ensureModulesChunksGraphApplied(compiler: Compiler): void;
-  done: () => Promise<void>;
-}
+    readonly name = "RsdoctorWebpackPlugin";
+    readonly options: RsdoctorPluginOptionsNormalized<Rules>;
+    readonly sdk: RsdoctorWebpackSDK;
+    modulesGraph: ModuleGraph;
+    private outsideInstance;
+    _bootstrapTask: Promise<unknown>;
+    protected browserIsOpened: boolean;
+    chunkGraph: ChunkGraph;
+    constructor(options?: RsdoctorWebpackPluginOptions<Rules>);
+    apply(compiler: unknown): unknown;
+    afterPlugins: (compiler: Compiler) => void;
+    beforeRun: (compiler: Compiler) => Promise<void>;
+    /**
+     * @description Generate ModuleGraph and ChunkGraph from stats and webpack module apis;
+     * @param {Compiler} compiler
+     * @return {*}
+     * @memberof RsdoctorWebpackPlugin
+     */
+    ensureModulesChunksGraphApplied(compiler: Compiler): void;
+    done: () => Promise<void>;
+}

package/dist/plugins/resolver.d.ts

@@ -2,36 +2,37 @@ import { InternalBasePlugin } from '@rsdoctor/core/plugins';
 import { RsdoctorWebpackSDK } from '@rsdoctor/sdk';
 import { SDK } from '@rsdoctor/types';
 import type { Compiler, ResolvePluginInstance, Resolver } from 'webpack';
-interface RsdoctorResolverPluginOptions {}
+interface RsdoctorResolverPluginOptions {
+}
 interface ResolveRequestContext {
-  issuer: string;
+    issuer: string;
 }
 interface ResolveRequestWithContext {
-  [key: string]: unknown;
-  context: ResolveRequestContext;
+    [key: string]: unknown;
+    context: ResolveRequestContext;
 }
 export declare class RsdoctorResolverPlugin implements ResolvePluginInstance {
-  protected options: RsdoctorResolverPluginOptions;
-  protected sdk: RsdoctorWebpackSDK;
-  protected tapOptions: {
-    name: string;
-  };
-  protected contextMap: Map<string, [number, [number, number]]>;
-  constructor(options: RsdoctorResolverPluginOptions, sdk: RsdoctorWebpackSDK);
-  protected getResolverData(context: ResolveRequestContext, params: {
-    request: string;
-    query?: string;
-    result?: string;
-    error?: Error;
-    stacks?: SDK.ResolveStackData[];
-  }): SDK.PathResolverData | undefined;
-  protected getResolveStackData(request: ResolveRequestWithContext, path: string, name?: string): SDK.ResolveStackData;
-  protected getResolveRequest(request: string | undefined, ctx?: Parameters<Resolver['resolve']>[3]): string;
-  apply(resolver: Resolver): void;
+    protected options: RsdoctorResolverPluginOptions;
+    protected sdk: RsdoctorWebpackSDK;
+    protected tapOptions: {
+        name: string;
+    };
+    protected contextMap: Map<string, [number, [number, number]]>;
+    constructor(options: RsdoctorResolverPluginOptions, sdk: RsdoctorWebpackSDK);
+    protected getResolverData(context: ResolveRequestContext, params: {
+        request: string;
+        query?: string;
+        result?: string;
+        error?: Error;
+        stacks?: SDK.ResolveStackData[];
+    }): SDK.PathResolverData | undefined;
+    protected getResolveStackData(request: ResolveRequestWithContext, path: string, name?: string): SDK.ResolveStackData;
+    protected getResolveRequest(request: string | undefined, ctx?: Parameters<Resolver['resolve']>[3]): string;
+    apply(resolver: Resolver): void;
 }
 export declare class InternalResolverPlugin extends InternalBasePlugin<Compiler> {
-  readonly name = "resolver";
-  apply(compiler: Compiler): void;
-  afterPlugins: (compiler: Compiler) => void;
+    readonly name = "resolver";
+    apply(compiler: Compiler): void;
+    afterPlugins: (compiler: Compiler) => void;
 }
-export {};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdoctor/webpack-plugin",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/web-infra-dev/rsdoctor",
@@ -16,10 +16,10 @@
     "fs-extra": "^11.1.1",
     "lodash": "^4.17.21",
     "webpack": "^5.89.0",
-    "@rsdoctor/core": "0.1.0",
-    "@rsdoctor/utils": "0.1.0",
-    "@rsdoctor/graph": "0.1.0",
-    "@rsdoctor/sdk": "0.1.0"
+    "@rsdoctor/core": "0.1.2",
+    "@rsdoctor/sdk": "0.1.2",
+    "@rsdoctor/graph": "0.1.2",
+    "@rsdoctor/utils": "0.1.2"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.2",
@@ -29,7 +29,7 @@
     "@types/webpack": "5.28.0",
     "tslib": "2.4.1",
     "typescript": "^5.2.2",
-    "@rsdoctor/types": "0.1.0"
+    "@rsdoctor/types": "0.1.2"
   },
   "publishConfig": {
     "access": "public",