@zk-tech/rrt-plugin-rspack 0.0.2

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/config.ts","../src/utilities/scripts.ts","../src/index.ts"],"sourcesContent":["export const coreSrc = 'perf-monitor-core.bundle.js';\nexport const clientSrc = 'perf-monitor-client.bundle.js';\n","import type { BackendEnv } from '@zk-tech/rrt-shared';\nimport type { PluginOptions } from '..';\n\nexport const getPluginScripts = (options?: PluginOptions) => {\n  const { rendererId, diffMode = 'lite', updateTrace = true, commitTrace = true } = options || {};\n\n  const env: BackendEnv = {\n    clientHost: 'inpage',\n    bundler: 'rspack',\n    bundlerVersion: __PLUGIN_VERSION__,\n    diffMode,\n    updateTrace,\n    commitTrace,\n  };\n\n  let settingScript = `window.__PERF_MONITOR_DEVTOOLS_ENV__ = ${JSON.stringify(env)};`;\n\n  if (rendererId) {\n    settingScript += `window.__PERF_MONITOR_DEVTOOLS_CONTEXT__ = { rendererId: ${rendererId} };`;\n  }\n\n  const coreScript = __CORE_SCRIPT__;\n  const clientScript = __CLIENT_SCRIPT__;\n\n  return {\n    settingScript,\n    coreScript,\n    clientScript,\n  };\n};\n","import type { BackendEnv } from '@zk-tech/rrt-shared';\n\nimport { clientSrc, coreSrc } from './config';\nimport { getPluginScripts } from './utilities/scripts';\n\ninterface PluginOptions {\n  /**\n   * Specifies whether the devtools should be disabled.\n   */\n  disabled?: boolean;\n  /**\n   * Sets the rendererId to inspect, only if you know what it is used for.\n   *\n   * It is recommended to use the plugin's rendererId selection feature before manually configuring the rendererId when using the plugin for the first time.\n   */\n  rendererId?: number;\n  /**\n   * The diff mode to use. Defaults to lite diff mode. Full diff mode is not supported yet.\n   * - \"off\": No diffs (Performance will be slightly improved).\n   * - \"lite\": Only simple diffs (Performance will be slightly impacted).\n   * - \"full\": All nested diffs (Performance will be significantly impacted).\n   * @default \"lite\"\n   */\n  diffMode?: BackendEnv['diffMode'];\n  /**\n   * Whether to record update related events.\n   * @default true\n   */\n  updateTrace?: boolean;\n  /**\n   * Whether to record commit.\n   * @default true\n   */\n  commitTrace?: boolean;\n}\n\ninterface HtmlTag {\n  attributes: Record<string, string | boolean>;\n  tagName: string;\n  voidTag: boolean;\n  innerHTML?: string;\n  meta: Record<string, unknown>;\n}\n\ninterface HtmlTagGroupsData {\n  headTags: HtmlTag[];\n}\n\ninterface HtmlTagGroupsHook {\n  tapPromise: (\n    name: string,\n    fn: (data: HtmlTagGroupsData) => Promise<HtmlTagGroupsData | void> | HtmlTagGroupsData | void,\n  ) => void;\n}\n\ninterface HtmlRspackPluginLike {\n  getCompilationHooks: (compilation: CompilationLike) => {\n    alterAssetTagGroups: HtmlTagGroupsHook;\n  };\n}\n\ninterface RawSourceConstructor {\n  new (source: string): unknown;\n}\n\ninterface CompilationLike {\n  assets?: Record<string, unknown>;\n  emitAsset?: (name: string, source: unknown) => void;\n}\n\ninterface CompilerLike {\n  hooks: {\n    compilation: {\n      tap: (name: string, fn: (compilation: CompilationLike) => void) => void;\n    };\n  };\n  webpack?: {\n    sources?: {\n      RawSource?: RawSourceConstructor;\n    };\n  };\n  rspack?: {\n    HtmlRspackPlugin?: HtmlRspackPluginLike;\n  };\n}\n\nconst pluginName = 'PerfMonitorRspackPlugin';\n\nfunction emitAsset(compilation: CompilationLike, filename: string, source: unknown) {\n  if (typeof compilation.emitAsset === 'function') {\n    compilation.emitAsset(filename, source);\n    return;\n  }\n\n  if (!compilation.assets) {\n    compilation.assets = {};\n  }\n  compilation.assets[filename] = source;\n}\n\nclass PerfMonitorRspackPlugin {\n  options: PluginOptions;\n\n  constructor(pluginOptions?: PluginOptions) {\n    this.options = pluginOptions || {\n      disabled: false,\n    };\n  }\n\n  apply(compiler: CompilerLike) {\n    if (this.options.disabled) {\n      return;\n    }\n\n    const HtmlRspackPlugin = compiler.rspack?.HtmlRspackPlugin;\n    if (!HtmlRspackPlugin?.getCompilationHooks) {\n      throw new Error(\n        `${pluginName} requires rspack.HtmlRspackPlugin. Add \"new rspack.HtmlRspackPlugin()\" before this plugin.`,\n      );\n    }\n\n    compiler.hooks.compilation.tap(pluginName, (compilation) => {\n      const RawSource = compiler.webpack?.sources?.RawSource;\n      if (!RawSource) {\n        throw new Error(`${pluginName} requires compiler.webpack.sources.RawSource.`);\n      }\n\n      const { coreScript, clientScript, settingScript } = getPluginScripts(this.options);\n      emitAsset(compilation, coreSrc, new RawSource(coreScript));\n      emitAsset(compilation, clientSrc, new RawSource(clientScript));\n\n      HtmlRspackPlugin.getCompilationHooks(compilation).alterAssetTagGroups.tapPromise(\n        pluginName,\n        async (data) => {\n          data.headTags.unshift(\n            {\n              attributes: { defer: true, src: `/${clientSrc}` },\n              tagName: 'script',\n              voidTag: false,\n              meta: {},\n            },\n            {\n              attributes: { defer: true, src: `/${coreSrc}` },\n              tagName: 'script',\n              voidTag: false,\n              meta: {},\n            },\n          );\n\n          data.headTags.unshift({\n            attributes: {},\n            tagName: 'script',\n            voidTag: false,\n            innerHTML: settingScript,\n            meta: {},\n          });\n\n          return data;\n        },\n      );\n    });\n  }\n}\n\nexport { PerfMonitorRspackPlugin, type PluginOptions };\n"],"names":["coreSrc","clientSrc","getPluginScripts","options","rendererId","diffMode","updateTrace","commitTrace","settingScript","pluginName","emitAsset","compilation","filename","source","PerfMonitorRspackPlugin","pluginOptions","compiler","HtmlRspackPlugin","_a","RawSource","_b","coreScript","clientScript","data"],"mappings":"gFAAO,MAAMA,EAAU,8BACVC,EAAY,gCCEZC,EAAoBC,GAA4B,CAC3D,KAAM,CAAE,WAAAC,EAAY,SAAAC,EAAW,OAAQ,YAAAC,EAAc,GAAM,YAAAC,EAAc,IAASJ,GAAW,CAAA,EAW7F,IAAIK,EAAgB,0CAA0C,KAAK,UAT3C,CACtB,WAAY,SACZ,QAAS,SACT,eAAgB,QAChB,SAAAH,EACA,YAAAC,EACA,YAAAC,CAAA,CAG8E,CAAC,IAEjF,OAAIH,IACFI,GAAiB,4DAA4DJ,CAAU,OAMlF,CACL,cAAAI,EACA,WALiB,675KAMjB,aALmB,oll6CAKnB,CAEJ,ECyDMC,EAAa,0BAEnB,SAASC,EAAUC,EAA8BC,EAAkBC,EAAiB,CAClF,GAAI,OAAOF,EAAY,WAAc,WAAY,CAC/CA,EAAY,UAAUC,EAAUC,CAAM,EACtC,MACF,CAEKF,EAAY,SACfA,EAAY,OAAS,CAAA,GAEvBA,EAAY,OAAOC,CAAQ,EAAIC,CACjC,CAEA,MAAMC,CAAwB,CAG5B,YAAYC,EAA+B,CACzC,KAAK,QAAUA,GAAiB,CAC9B,SAAU,EAAA,CAEd,CAEA,MAAMC,EAAwB,OAC5B,GAAI,KAAK,QAAQ,SACf,OAGF,MAAMC,GAAmBC,EAAAF,EAAS,SAAT,YAAAE,EAAiB,iBAC1C,GAAI,EAACD,GAAA,MAAAA,EAAkB,qBACrB,MAAM,IAAI,MACR,GAAGR,CAAU,4FAAA,EAIjBO,EAAS,MAAM,YAAY,IAAIP,EAAaE,GAAgB,SAC1D,MAAMQ,GAAYC,GAAAF,EAAAF,EAAS,UAAT,YAAAE,EAAkB,UAAlB,YAAAE,EAA2B,UAC7C,GAAI,CAACD,EACH,MAAM,IAAI,MAAM,GAAGV,CAAU,+CAA+C,EAG9E,KAAM,CAAE,WAAAY,EAAY,aAAAC,EAAc,cAAAd,GAAkBN,EAAiB,KAAK,OAAO,EACjFQ,EAAUC,EAAaX,EAAS,IAAImB,EAAUE,CAAU,CAAC,EACzDX,EAAUC,EAAaV,EAAW,IAAIkB,EAAUG,CAAY,CAAC,EAE7DL,EAAiB,oBAAoBN,CAAW,EAAE,oBAAoB,WACpEF,EACA,MAAOc,IACLA,EAAK,SAAS,QACZ,CACE,WAAY,CAAE,MAAO,GAAM,IAAK,IAAItB,CAAS,EAAA,EAC7C,QAAS,SACT,QAAS,GACT,KAAM,CAAA,CAAC,EAET,CACE,WAAY,CAAE,MAAO,GAAM,IAAK,IAAID,CAAO,EAAA,EAC3C,QAAS,SACT,QAAS,GACT,KAAM,CAAA,CAAC,CACT,EAGFuB,EAAK,SAAS,QAAQ,CACpB,WAAY,CAAA,EACZ,QAAS,SACT,QAAS,GACT,UAAWf,EACX,KAAM,CAAA,CAAC,CACR,EAEMe,EACT,CAEJ,CAAC,CACH,CACF"}

package/dist/index.d.ts

@@ -0,0 +1,77 @@
+import { BackendEnv } from '@zk-tech/rrt-shared';
+interface PluginOptions {
+    /**
+     * Specifies whether the devtools should be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * Sets the rendererId to inspect, only if you know what it is used for.
+     *
+     * It is recommended to use the plugin's rendererId selection feature before manually configuring the rendererId when using the plugin for the first time.
+     */
+    rendererId?: number;
+    /**
+     * The diff mode to use. Defaults to lite diff mode. Full diff mode is not supported yet.
+     * - "off": No diffs (Performance will be slightly improved).
+     * - "lite": Only simple diffs (Performance will be slightly impacted).
+     * - "full": All nested diffs (Performance will be significantly impacted).
+     * @default "lite"
+     */
+    diffMode?: BackendEnv['diffMode'];
+    /**
+     * Whether to record update related events.
+     * @default true
+     */
+    updateTrace?: boolean;
+    /**
+     * Whether to record commit.
+     * @default true
+     */
+    commitTrace?: boolean;
+}
+interface HtmlTag {
+    attributes: Record<string, string | boolean>;
+    tagName: string;
+    voidTag: boolean;
+    innerHTML?: string;
+    meta: Record<string, unknown>;
+}
+interface HtmlTagGroupsData {
+    headTags: HtmlTag[];
+}
+interface HtmlTagGroupsHook {
+    tapPromise: (name: string, fn: (data: HtmlTagGroupsData) => Promise<HtmlTagGroupsData | void> | HtmlTagGroupsData | void) => void;
+}
+interface HtmlRspackPluginLike {
+    getCompilationHooks: (compilation: CompilationLike) => {
+        alterAssetTagGroups: HtmlTagGroupsHook;
+    };
+}
+interface RawSourceConstructor {
+    new (source: string): unknown;
+}
+interface CompilationLike {
+    assets?: Record<string, unknown>;
+    emitAsset?: (name: string, source: unknown) => void;
+}
+interface CompilerLike {
+    hooks: {
+        compilation: {
+            tap: (name: string, fn: (compilation: CompilationLike) => void) => void;
+        };
+    };
+    webpack?: {
+        sources?: {
+            RawSource?: RawSourceConstructor;
+        };
+    };
+    rspack?: {
+        HtmlRspackPlugin?: HtmlRspackPluginLike;
+    };
+}
+declare class PerfMonitorRspackPlugin {
+    options: PluginOptions;
+    constructor(pluginOptions?: PluginOptions);
+    apply(compiler: CompilerLike): void;
+}
+export { PerfMonitorRspackPlugin, type PluginOptions };

package/dist/utilities/scripts.d.ts

@@ -0,0 +1,6 @@
+import { PluginOptions } from '..';
+export declare const getPluginScripts: (options?: PluginOptions) => {
+    settingScript: string;
+    coreScript: string;
+    clientScript: string;
+};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@zk-tech/rrt-plugin-rspack",
+  "version": "0.0.2",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.cjs",
+  "dependencies": {
+    "@zk-tech/rrt-client": "0.0.2",
+    "@zk-tech/rrt-core": "0.0.2",
+    "@zk-tech/rrt-shared": "0.0.2"
+  },
+  "peerDependencies": {
+    "@rspack/core": ">=0.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.15.3",
+    "rimraf": "~3.0.2",
+    "typescript": "~5.0.4"
+  },
+  "files": [
+    "dist"
+  ],
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.cjs"
+    }
+  },
+  "private": false,
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "lint": "eslint src --ext .ts,.tsx",
+    "typecheck": "tsc --noEmit --emitDeclarationOnly false"
+  }
+}