mirror of
https://github.com/BetterSEQTA/BetterSEQTA-Plus.git
synced 2026-06-05 19:24:39 +00:00
google-labs-jules[bot]
69ac159bad
This change introduces JSDoc-style comments to several TypeScript and JavaScript files within the `lib` directory. These files primarily consist of Vite plugins, build scripts, and type definitions. Comments were added or improved in: - `lib/base64loader.ts`: I documented the Vite plugin for loading files as base64 data URLs. - `lib/createManifest.ts`: I enhanced existing comments for functions that create extension manifest objects. - `lib/inlineWorker.ts`: I documented the Vite plugin for bundling and inlining web worker scripts. - `lib/utils.ts`: I added comments to utility types and the `createEnum` function, including a note on its type signature vs. runtime behavior. - `lib/closePlugin.ts`: I documented the Vite plugin for handling build completion and exiting the process. - `lib/publish.js`: I added comments to functions within the command-line script used for publishing the extension. - `lib/touchGlobalCSS.ts`: I documented the Vite plugin for improving HMR reliability for global CSS files. - `lib/types.ts`: I added comments to various type definitions, interfaces, and enum-like objects related to manifests, build configurations, and supported technologies.
50 lines
2.1 KiB
TypeScript
50 lines
2.1 KiB
TypeScript
import fs from "fs";
|
|
import mime from "mime-types";
|
|
|
|
/**
|
|
* A Vite plugin designed to load files as base64 encoded data URLs.
|
|
* This plugin intercepts module imports that have a `?base64` query parameter
|
|
* appended to the file path. It then reads the targeted file, converts its content
|
|
* to a base64 string, and constructs a data URL which is then exported as the
|
|
* default export of a new JavaScript module.
|
|
*
|
|
* @example
|
|
* // To use this loader, import a file with ?base64 query:
|
|
* // import myImageBase64 from './path/to/myimage.png?base64';
|
|
* // myImageBase64 will then be a string like "data:image/png;base64,..."
|
|
*/
|
|
export const base64Loader = {
|
|
/**
|
|
* The name of the Vite plugin.
|
|
* @type {string}
|
|
*/
|
|
name: "base64-loader",
|
|
/**
|
|
* The core transformation function of the Vite plugin.
|
|
* It is called by Vite for modules that might need transformation. This function
|
|
* checks if the module ID includes the `?base64` query. If so, it reads the
|
|
* specified file, converts it to a base64 data URL, and returns a new
|
|
* JavaScript module that default exports this data URL.
|
|
*
|
|
* @param {any} _ The original code of the file. This parameter is unused by this loader.
|
|
* @param {string} id The ID of the module being transformed. This string typically
|
|
* contains the absolute file path and any query parameters
|
|
* (e.g., "/path/to/file.png?base64").
|
|
* @returns {string | null} If the module ID does not contain `?base64` query,
|
|
* it returns `null` to indicate no transformation.
|
|
* Otherwise, it returns a string of JavaScript code
|
|
* that default exports the base64 data URL of the file.
|
|
* For example: `export default 'data:image/png;base64,xxxx';`
|
|
*/
|
|
transform(_: any, id: string) {
|
|
const [filePath, query] = id.split("?");
|
|
if (query !== "base64") return null;
|
|
|
|
const data = fs.readFileSync(filePath, { encoding: "base64" });
|
|
const mimeType = mime.lookup(filePath);
|
|
const dataURL = `data:${mimeType};base64,${data}`;
|
|
|
|
return `export default '${dataURL}';`;
|
|
},
|
|
};
|