with-zephyr

library1.0.2jsnpmunverified

The `with-zephyr` package provides a codemod utility designed to automatically inject the `withZephyr` plugin into various JavaScript bundler configurations. This tool is essential for projects integrating with the Zephyr Cloud platform, facilitating features like Module Federation, Over-The-Air (OTA) updates, and streamlined deployments for micro-frontends. It supports a wide array of bundlers, including Webpack, Vite, Rollup, Rspack, and others within ecosystems like Astro and Modern. Currently at version 1.0.2, the package maintains an active development pace with frequent patch releases, often addressing security vulnerabilities and improving compatibility. Its primary differentiator is its role as an automated transformation tool, simplifying the integration of Zephyr-specific plugins into complex build setups without manual configuration edits. This package is distinct from the Zephyr Real-Time Operating System (RTOS).

devops http-networking aws

npm install with-zephyr

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · WITH-ZEPHYR

with-zephyr

devopsjavascriptv1.0.2

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

runCodemod

✓ import { runCodemod } from 'with-zephyr';

✗ const { runCodemod } = require('with-zephyr');

Primarily an ESM-first utility; programmatic API for custom automation scripts. The main usage is via CLI.

applyCodemod

✓ import { applyCodemod } from 'with-zephyr';

✗ import applyCodemod from 'with-zephyr';

Named export for applying the codemod logic directly, typically used in build scripts or CI/CD pipelines.

Demonstrates how to invoke the `with-zephyr` codemod via the command line to initialize Zephyr plugin integration.

npx with-zephyr --help # Example: Run the codemod to automatically configure a project npx with-zephyr init # The 'init' command would typically detect your bundler configuration # (e.g., webpack.config.js, vite.config.ts) and apply the necessary # modifications to include the Zephyr plugin for Module Federation and deployment. # Always review changes made by codemods before committing.

Debug

Known issues

breakingThe v1.0.0 release marked a major version bump. While specific user-facing breaking API changes for the `with-zephyr` codemod were not explicitly detailed in the changelog, it indicated significant internal restructuring and a move to a stable release state. Users migrating from pre-1.0.0 versions should test thoroughly.

fix

Refer to the GitHub changelog for `zephyr-packages` and consult Zephyr Cloud documentation for any new migration guides related to bundler configurations or plugin usage. Thoroughly test existing build pipelines.

affects: >=1.0.0

gotchaRecent patch releases (e.g., v1.0.2, v1.0.1) included fixes for high and critical pnpm audit vulnerabilities. Older versions may contain known security issues.

fix

Upgrade to the latest stable version of `with-zephyr` immediately to benefit from security remediations: `npm install with-zephyr@latest` or `pnpm update with-zephyr`.

affects: <1.0.2

gotchaVersions prior to v0.1.16 had issues handling trailing commas within plugin arrays in bundler configurations, potentially leading to parsing errors or incorrect modifications.

fix

Ensure your project's bundler configuration files are updated to a version of `with-zephyr` greater than or equal to `0.1.16` to correctly parse and modify plugin arrays. If using an older version, manually remove any trailing commas from plugin arrays in your bundler configuration files or upgrade.

affects: <0.1.16

Errors

Common errors & fixes

Error: Failed to parse configuration file: Unexpected token ','

An older version of `with-zephyr` (prior to v0.1.16) encountered a trailing comma in a JavaScript/TypeScript array within a bundler configuration file, which it couldn't correctly handle.

fix

Upgrade `with-zephyr` to `^0.1.16` or higher (`npm install with-zephyr@latest`). If the issue persists with an older version for specific reasons, manually remove any trailing commas from plugin arrays in your bundler configuration files.

Command failed: npx with-zephyr init Error: No supported bundler configuration found.

The codemod could not detect a supported bundler configuration file (e.g., `webpack.config.js`, `vite.config.ts`) in the current directory or its common subdirectories, or an unexpected file structure prevented automated modification.

fix

Ensure you are running the command in the root of a project with a standard bundler configuration. Verify that your bundler configuration file follows common patterns. Consult Zephyr Cloud documentation for supported bundler versions and manual integration steps if the codemod fails to detect your setup.

Upgrade

Version history

1.0.2latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

35 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/ZephyrCloudIO/zephyr-packages ↗

packagehttps://www.npmjs.com/package/with-zephyr ↗

homepagehttps://www.zephyr-cloud.io ↗