Skip to content

ZephyrCloudIO/zephyr-packages

Repository files navigation

Zephyr Plugins

Alt

Contributing

We welcome contributions! Please read our contributing guidelines for more information.

Plugins

Plugins within this repository are built for applications to deploy with Zephyr. This repository also includes utility packages for building npm plugins with Zephyr.

Public Plugins

Utility Packages

  • zephyr-agent - The main internal package to build bundler integration with Zephyr. Public plugins mostly interact with this package.
  • zephyr-xpack-internal - Sharing types, module federation capabilities and utilities for bundler built on top of webpack or Rspack.
  • zephyr-edge-contract - Provide typings, constants and smaller utilites for Zephyr plugins.

Repository Structure

This is a Turborepo monorepo. Libraries are built with Rslib, tests run with Rstest, and repository linting and formatting use Oxlint and Oxfmt.

  • libs - Contains all the plugins and utility packages.
  • examples - Contains examples to use and test the plugins.

Using this repository

pnpm install

For descriptor-backed TAP mini-app publication, see the tap-app publication contract. Cross-repository TAP ownership, versions, sequencing, and completion status are maintained in the canonical miniapp architecture directory, not in a copied plan in this generic plugin repository.

TAP migration evidence

Responsibility Status Evidence or next gate
Generic tap-app publication adapter and lifecycle runtime implemented-unverified Current-main coordinated build and real-cloud consumer receipt
Exact 0.0.0-canary.68 release train in consumers verified Non-applicable in this source workspace: examples use workspace source; pnpm test:miniapp-wave1 requires exact .68 for any external publication dependency
Module Federation 2.8.0 catalogs and ESM regression verified Catalogs and TAP runtime peers use stable 2.8.0; the policy proves no executable Rsbuild/Rspack ESM remote fixture exists, forbids the retired patch, and requires an exact pin if one is added

The central evidence ledger is authoritative for status changes. This generic plugin repository does not own product applications or duplicate their plan.

Available Scripts

Development

  • pnpm build - Builds every package under libs
  • pnpm build-all - Builds all packages and examples in dependency order
  • pnpm typecheck - Type-checks the TypeScript project-reference graph

Testing

  • pnpm test - Runs the test suite
  • pnpm test:affected - Runs tests affected by the current branch
  • pnpm test:coverage - Runs the repository-wide Rstest coverage suite
  • pnpm test:examples - Runs example unit tests and the production deployment E2E suite

Linting & Formatting

  • pnpm lint - Checks code for linting errors
  • pnpm format:check - Checks formatting with Oxfmt
  • pnpm format - Formats code with Oxfmt

Version Management

  • pnpm bump-patch - Automated patch version bump across all packages

  • pnpm bump-minor - Automated minor version bump across all packages

  • pnpm bump-major - Automated major version bump across all packages

    These scripts automate the version release process:

    • Runs pnpm audit --audit-level high before making any version changes
    • Increments the selected version in root and all lib package.json files
    • Creates a commit with conventional commit message
    • Creates a git tag (vX.X.X)
    • If on main/master branch, creates a new feature branch and opens a PR
    • Pushes changes and tags to origin

    Requirements:

    • Clean working directory (no uncommitted changes)
    • gh CLI installed and authenticated (for automatic PR creation)
    • Git configured with push access to origin

Note: Please ensure you have run pnpm install before executing any of these commands.

About

Topics

Resources

License

Stars

21 stars

Watchers

3 watching

Forks

Packages

 
 
 

Contributors