@open-xchange/vite-plugin-replace-pkg 1.1.1 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## `1.2.0` – 2026-Mar-13
+
+- added: support for Vite 8
+
 ## `1.1.1` – 2025-Sep-09
 
 - chore: bump dependencies
@@ -37,7 +41,7 @@
 
 - added: options `prepend`, `append`, `exportGlobal`
 - changed: made option `replace.token` optional (defaults to `GITLAB_TOKEN` env var)
-- fixed: inactive log level "info"
+- fixed: inactive log level 'info'
 
 ## `0.0.2` – 2024-Aug-07
 

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -11,14 +11,14 @@ A common use case is replacing a public package with an internally hosted commer
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite" // or "vitest/config"
-import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+import { defineConfig } from 'vite' // or 'vitest/config'
+import replacePlugin from '@open-xchange/vite-plugin-replace-pkg'
 
 export default defineConfig(() => {
   plugins: [
     replacePlugin({
-      package: "external-package",
-      replace: "https://example.org/path/to/index.js",
+      package: 'external-package',
+      replace: 'https://example.org/path/to/index.js',
     }),
   ],
 })
@@ -27,7 +27,7 @@ export default defineConfig(() => {
 ```ts
 // src/index.ts
 
-import * as ext from "external-package" // imports replacement if available
+import * as ext from 'external-package' // imports replacement if available
 ```
 
 It is possible to replace different packages by instantiating this plugin multiple times:
@@ -35,17 +35,17 @@ It is possible to replace different packages by instantiating this plugin multip
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite" // or "vitest/config"
-import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+import { defineConfig } from 'vite' // or 'vitest/config'
+import replacePlugin from '@open-xchange/vite-plugin-replace-pkg'
 
 export default defineConfig(() => {
   plugins: [
     replacePlugin({
-      package: "external-package",
-      replace: "https://example.org/path/to/index.js",
+      package: 'external-package',
+      replace: 'https://example.org/path/to/index.js',
     }),
     replacePlugin({
-      package: "@namespace/another-package",
+      package: '@namespace/another-package',
       replace: { /* GitLab project file */ },
     }),
   ],
@@ -82,17 +82,17 @@ The location of the source file to resolve the module imports with. There are di
    ```ts
    // vite.config.ts
 
-   import { defineConfig } from "vite" // or "vitest/config"
-   import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+   import { defineConfig } from 'vite' // or 'vitest/config'
+   import replacePlugin from '@open-xchange/vite-plugin-replace-pkg'
 
    export default defineConfig(() => {
      plugins: [
        replacePlugin({
-         package: "external-package",
+         package: 'external-package',
          replace: {
-           method: "POST",
-           headers: { "X-Some-Header", "abc" },
-           url: "https://example.org/api/to/endpoint",
+           method: 'POST',
+           headers: { 'X-Some-Header', 'abc' },
+           url: 'https://example.org/api/to/endpoint',
            query: { ts: Date.now() },
          },
        }),
@@ -105,7 +105,7 @@ The location of the source file to resolve the module imports with. There are di
    | Name | Type | Default | Description |
    | - | - | - | - |
    | `server` | `string` | _required_ | The URL of the GitLab server to be used for downloading the source file. |
-   | `project` | `string\|number` | _required_ | Name or numeric identifier of the GitLab project. The project name may contain slashes (e.g. `"my-group/my-project"`) which will be encoded internally. |
+   | `project` | `string\|number` | _required_ | Name or numeric identifier of the GitLab project. The project name may contain slashes (e.g. `'my-group/my-project'`) which will be encoded internally. |
    | `path` | `string` | _required_ | Path to the source file to be downloaded. Slashes in the path will be encoded internally. |
    | `ref` | `string` | `HEAD` | The name of a branch or tag, or a commit ID. Slashes in branch names will be encoded internally. |
    | `token` | `string` | environment variable `GITLAB_TOKEN` | A valid GitLab API access token. If omitted, uses the contents of the environment variable `GITLAB_TOKEN`. If the resulting token is empty, downloading the source file will be skipped silently. |
@@ -115,18 +115,18 @@ The location of the source file to resolve the module imports with. There are di
    ```ts
    // vite.config.ts
 
-   import { defineConfig } from "vite" // or "vitest/config"
-   import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+   import { defineConfig } from 'vite' // or 'vitest/config'
+   import replacePlugin from '@open-xchange/vite-plugin-replace-pkg'
 
    export default defineConfig(() => {
      plugins: [
        replacePlugin({
-         package: "external-package",
+         package: 'external-package',
          replace: {
-           server: "https://gitlab.example.org",
-           project: "internals/commercial-package",
-           path: "path/to/index.js",
-           ref: "feature/branch-2",
+           server: 'https://gitlab.example.org',
+           project: 'internals/commercial-package',
+           path: 'path/to/index.js',
+           ref: 'feature/branch-2',
          },
        }),
      ],
@@ -140,13 +140,13 @@ The location of the source file to resolve the module imports with. There are di
    ```ts
    // vite.config.ts
 
-   import { defineConfig } from "vite" // or "vitest/config"
-   import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+   import { defineConfig } from 'vite' // or 'vitest/config'
+   import replacePlugin from '@open-xchange/vite-plugin-replace-pkg'
 
    export default defineConfig(() => {
      plugins: [
        replacePlugin({
-         package: "external-package",
+         package: 'external-package',
          async replace() { /* ... */ },
        }),
      ],
@@ -165,14 +165,14 @@ Example:
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite" // or "vitest/config"
-import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+import { defineConfig } from 'vite' // or 'vitest/config'
+import replacePlugin from '@open-xchange/vite-plugin-replace-pkg'
 
 export default defineConfig(() => {
   plugins: [
     replacePlugin({
-      package: "external-package"
-      replace: "https://example.org/path/to/index.js",
+      package: 'external-package'
+      replace: 'https://example.org/path/to/index.js',
       transform: source => source.replaceAll(/* ... */)
     }),
   ],
@@ -193,14 +193,14 @@ Example:
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite" // or "vitest/config"
-import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+import { defineConfig } from 'vite' // or 'vitest/config'
+import replacePlugin from '@open-xchange/vite-plugin-replace-pkg'
 
 export default defineConfig(() => {
   plugins: [
     replacePlugin({
-      package: "external-package"
-      replace: "https://example.org/path/to/index.js",
+      package: 'external-package'
+      replace: 'https://example.org/path/to/index.js',
       prepend: [/* ... */],
     }),
   ],
@@ -221,14 +221,14 @@ Example:
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite" // or "vitest/config"
-import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+import { defineConfig } from 'vite' // or 'vitest/config'
+import replacePlugin from '@open-xchange/vite-plugin-replace-pkg'
 
 export default defineConfig(() => {
   plugins: [
     replacePlugin({
-      package: "external-package"
-      replace: "https://example.org/path/to/index.js",
+      package: 'external-package'
+      replace: 'https://example.org/path/to/index.js',
       append: [/* ... */],
     }),
   ],
@@ -249,15 +249,15 @@ Example:
 ```ts
 // vite.config.ts
 
-import { defineConfig } from "vite" // or "vitest/config"
-import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+import { defineConfig } from 'vite' // or 'vitest/config'
+import replacePlugin from '@open-xchange/vite-plugin-replace-pkg'
 
 export default defineConfig(() => {
   plugins: [
     replacePlugin({
-      package: "external-package"
-      replace: "https://example.org/path/to/index.js",
-      exportGlobal: "TheModule",
+      package: 'external-package'
+      replace: 'https://example.org/path/to/index.js',
+      exportGlobal: 'TheModule',
     }),
   ],
 })
@@ -270,12 +270,12 @@ is equivalent to
 
 // ...
     replacePlugin({
-      package: "external-package"
-      replace: "https://example.org/path/to/index.js",
+      package: 'external-package'
+      replace: 'https://example.org/path/to/index.js',
       append: [
-        "const __contents = globalThis.TheModule",
-        "delete globalThis.TheModule",
-        "export default __contents",
+        'const __contents = globalThis.TheModule',
+        'delete globalThis.TheModule',
+        'export default __contents',
       ],
     }),
 ```

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import type { Plugin } from "vite";
-import type { Dict } from "@open-xchange/vite-helper/utils";
+import type { Plugin } from 'vite';
+import type { Dict } from '@open-xchange/vite-helper/utils';
 /**
  * The configuration options for the `fetch` function needed to download a
  * source file.
@@ -24,7 +24,7 @@ export interface VitePluginReplacePkg_GitLabFile {
     server: string;
     /**
      * Name or identifier of the GitLab project (repository). The project name
-     * may contain slashes (e.g. "my-group/my-project") which will be encoded
+     * may contain slashes (e.g. 'my-group/my-project') which will be encoded
      * internally.
      */
     project: string | number;
@@ -37,7 +37,7 @@ export interface VitePluginReplacePkg_GitLabFile {
      * The name of a branch or a tag, or a commit ID. Slashes in branch names
      * will be encoded internally.
      *
-     * @default "HEAD"
+     * @default 'HEAD'
      */
     ref?: string;
     /**
@@ -61,10 +61,10 @@ export interface VitePluginReplacePkgOptions {
      */
     package: string;
     /**
-     * The location of the source file to resolve the module import with. Can
-     * be a simple URL as string, a configuration object for the `fetch`
-     * function (with URL, headers, etc.), a specification for a file in a
-     * GitLab project repository, or a custom callback function.
+     * The location of the source file to resolve the module import with. Can be
+     * a simple URL as string, a configuration object for the `fetch` function
+     * (with URL, headers, etc.), a specification for a file in a GitLab project
+     * repository, or a custom callback function.
      */
     replace: string | VitePluginReplacePkg_RequestInit | VitePluginReplacePkg_GitLabFile | VitePluginReplacePkg_Callback;
     /**
@@ -79,25 +79,24 @@ export interface VitePluginReplacePkgOptions {
      */
     transform?: (source: string) => string | string[] | Promise<string | string[]>;
     /**
-     * Inserts arbitrary source code to the beginning of the replacement
-     * module. An array of strings will be concatenated with newline
-     * characters. This option will be applied after source code transformation
-     * (option `transform`).
+     * Inserts arbitrary source code to the beginning of the replacement module.
+     * An array of strings will be concatenated with newline characters. This
+     * option will be applied after source code transformation (option
+     * `transform`).
      */
     prepend?: string | string[];
     /**
      * Inserts arbitrary source code to the end of the replacement module. An
-     * array of strings will be concatenated with newline characters. This
-     * option will be applied after source code transformation (option
-     * `transform`).
+     * array of strings will be concatenated with newline characters. This option
+     * will be applied after source code transformation (option `transform`).
      */
     append?: string | string[];
     /**
      * Specifies the name of a global variable that will be defined by the
-     * replacement module. This plugin will append source code to the
-     * replacement module that will delete the variable from global scope, and
-     * will export it as the default export instead. This option will be
-     * applied after source code transformation (option `transform`).
+     * replacement module. This plugin will append source code to the replacement
+     * module that will delete the variable from global scope, and will export it
+     * as the default export instead. This option will be applied after source
+     * code transformation (option `transform`).
      */
     exportGlobal?: string;
 }

package/dist/index.js

@@ -1,7 +1,7 @@
-import { onceFn } from "@open-xchange/vite-helper/utils";
-import { Logger } from "@open-xchange/vite-helper/logger";
+import { onceFn } from '@open-xchange/vite-helper/utils';
+import { Logger } from '@open-xchange/vite-helper/logger';
 // constants ==================================================================
-export const PROJECT_NAME = "@open-xchange/vite-plugin-replace-pkg";
+export const PROJECT_NAME = '@open-xchange/vite-plugin-replace-pkg';
 // functions ==================================================================
 /**
  * Joins a string array with newline characters, ensures trailing newline.
@@ -13,8 +13,8 @@ export const PROJECT_NAME = "@open-xchange/vite-plugin-replace-pkg";
  *  The flattened contents.
  */
 function flatten(contents) {
-    const result = Array.isArray(contents) ? contents.join("\n") : contents;
-    return result.endsWith("\n") ? result : (result + "\n");
+    const result = Array.isArray(contents) ? contents.join('\n') : contents;
+    return result.endsWith('\n') ? result : (result + '\n');
 }
 // plugin =====================================================================
 /**
@@ -31,34 +31,34 @@ function flatten(contents) {
  */
 export default function vitePluginReplacePkg(options) {
     const pkgName = options.package;
-    const moduleId = "\0" + PROJECT_NAME + "/" + pkgName;
+    const moduleId = '\0' + PROJECT_NAME + '/' + pkgName;
     // must not be instantiated globally (needs initialized environment variables)
     const logger = new Logger({
-        loggerPrefix: "pkg",
-        logLevelEnvVar: "PLUGIN_REPLACE_PKG_LOGLEVEL",
+        loggerPrefix: 'pkg',
+        logLevelEnvVar: 'PLUGIN_REPLACE_PKG_LOGLEVEL',
     });
     // resolves the URL of the replacement module to be fetched
     const resolveFetchOptions = () => {
-        logger.info("resolving replacement module for %f", pkgName);
+        logger.info('resolving replacement module for %f', pkgName);
         const { replace } = options;
         // callback function
-        if (typeof replace === "function") {
+        if (typeof replace === 'function') {
             return;
         }
         // plain string
-        if (typeof replace === "string") {
+        if (typeof replace === 'string') {
             return replace ? { url: replace } : undefined;
         }
         // `RequestInit` object
-        if ("url" in replace) {
+        if ('url' in replace) {
             return replace.url ? replace : undefined;
         }
         // `GitLabFile` object
-        if ("project" in replace) {
+        if ('project' in replace) {
             // GitLab API token
             const token = replace.token ?? process.env.GITLAB_TOKEN;
             if (!token) {
-                logger.warn("missing GitLab API token");
+                logger.warn('missing GitLab API token');
                 return;
             }
             // build the file URL for the GitLab API
@@ -71,23 +71,23 @@ export default function vitePluginReplacePkg(options) {
             if (replace.ref) {
                 query.ref = replace.ref;
             }
-            const headers = { "PRIVATE-TOKEN": token };
+            const headers = { 'PRIVATE-TOKEN': token };
             return { url, headers, query };
         }
-        logger.error("invalid configuration for package %f", pkgName);
+        logger.error('invalid configuration for package %f', pkgName);
         return undefined;
     };
-    // fetches the replacement module ("onceFn" wrapped to be called from "resolveId" and "load")
+    // fetches the replacement module ('onceFn' wrapped to be called from 'resolveId' and 'load')
     const fetchSourceFile = onceFn(async () => {
         try {
-            if (typeof options.replace === "function") {
+            if (typeof options.replace === 'function') {
                 return await options.replace(pkgName);
             }
             const fetchOptions = resolveFetchOptions();
             if (fetchOptions) {
-                const query = Object.entries(fetchOptions.query ?? {}).map(entry => entry.map(encodeURIComponent).join("=")).join("&");
-                const url = fetchOptions.url + (query ? `?${query}` : "");
-                logger.info("requesting package %f from %f", pkgName, url);
+                const query = Object.entries(fetchOptions.query ?? {}).map(entry => entry.map(encodeURIComponent).join('=')).join('&');
+                const url = fetchOptions.url + (query ? `?${query}` : '');
+                logger.info('requesting package %f from %f', pkgName, url);
                 const response = await fetch(url, fetchOptions);
                 if (response.ok) {
                     return await response.text();
@@ -95,24 +95,24 @@ export default function vitePluginReplacePkg(options) {
                 logger.warn(`requesting package %f failed: ${response.status} ${response.statusText}`, pkgName);
             }
             else {
-                logger.info("no replacement available for package %f", pkgName);
+                logger.info('no replacement available for package %f', pkgName);
             }
         }
         catch (error) {
             logger.warn(`requesting package %f failed: ${error.message}`, pkgName);
         }
-        return "";
+        return '';
     });
     // create and return the plugin object
     return {
         name: PROJECT_NAME,
         resolveId: {
-            order: "pre",
+            order: 'pre',
             async handler(source) {
                 if (source !== pkgName) {
                     return;
                 }
-                // try to fetch source file, skip "load" hook if not available
+                // try to fetch source file, skip 'load' hook if not available
                 const contents = await fetchSourceFile();
                 return contents ? moduleId : undefined;
             },
@@ -134,9 +134,9 @@ export default function vitePluginReplacePkg(options) {
             }
             if (exportGlobal) {
                 contents += flatten([
-                    `const __contents = globalThis["${exportGlobal}"];`,
-                    `delete globalThis["${exportGlobal}"];`,
-                    "export default __contents;",
+                    `const __contents = globalThis['${exportGlobal}']`,
+                    `delete globalThis['${exportGlobal}']`,
+                    'export default __contents',
                 ]);
             }
             return contents;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/vite-plugin-replace-pkg",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Vite plugin replacing a specific external package with an arbitrary source code module",
   "repository": {
     "type": "git",
@@ -11,32 +11,25 @@
   "engines": {
     "node": ">=20.18"
   },
-  "packageManager": "yarn@4.9.4",
   "type": "module",
   "exports": "./dist/index.js",
   "files": [
     "dist",
     "CHANGELOG.*"
   ],
-  "scripts": {
-    "prepack": "yarn build && yarn lint",
-    "clean": "premove dist",
-    "build": "yarn clean && tsc --project src/tsconfig.json",
-    "lint": "tsc && tsc --project src/tsconfig.json --noEmit && eslint ."
-  },
   "dependencies": {
-    "@open-xchange/vite-helper": "^1.1.1"
+    "@open-xchange/vite-helper": "^1.2.2"
   },
   "devDependencies": {
-    "@open-xchange/linter-presets": "^1.9.0",
-    "@types/node": "^24.3.1",
-    "eslint": "^9.35.0",
-    "jiti": "^2.5.1",
-    "premove": "^4.0.0",
-    "typescript": "^5.9.2",
-    "vite": "^7.1.5"
+    "vite": "^8.0.0",
+    "@open-xchange/linter-presets": "^1.18.4"
   },
   "peerDependencies": {
-    "vite": "^6.0.0 || ^7.0.0"
+    "vite": "^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "scripts": {
+    "build": "pnpm clean && tsc --project src/tsconfig.json",
+    "clean": "premove dist",
+    "lint": "tsc && tsc --project src/tsconfig.json --noEmit && eslint ."
   }
 }