Skip to content

hypermod-io/hypermod-community

Repository files navigation

Hypermod Community banner

Hypermod Community

Hypermod Community is the open-source codemod registry and CLI ecosystem for Hypermod.io. Use this repository to discover, author, test, publish, and contribute codemods; use Hypermod.io to explore codemods, learn migration workflows, and promote safer package upgrades at scale.

Explore Hypermod.ioBrowse codemodsRead the docsJoin Discord

Why this project exists

Upgrading dependencies is expensive when maintainers only ship changelogs and users are left to translate breaking changes by hand. Hypermod helps library maintainers, platform teams, design-system teams, and migration owners turn breaking API changes into repeatable codemods that can be shared with the wider ecosystem and used by agents.

This repository is the community-facing home for that workflow:

  • Community codemod registry for versioned and reusable codemods.
  • CLI packages for running codemods locally, from npm, or from Hypermod.io-hosted sources.
  • Authoring utilities for creating, validating, and testing codemod packages.
  • Examples and templates that make it easier to ship migrations users can actually adopt.

How Hypermod Community and Hypermod.io fit together

  • Hypermod.io is the orchestration and discovery layer: explore codemods, generate codemods, deploy migrations across repositories, and access hosted Hypermod experiences.
  • @hypermod/cli is the command-line entry point for running codemods in local projects, from npm packages, and from Hypermod.io-powered sources.
  • This repository is the open-source registry, package monorepo, and contribution surface behind the ecosystem.

Get started with the CLI

We recommend using the CLI with npx so you always run the latest version:

npx @hypermod/cli --packages react@18.0.0 ./src

You can also install it globally:

npm install -g @hypermod/cli
# or
yarn global add @hypermod/cli

Then run it with either binary:

hypermod --help
# or
hypermod-cli --help

Common usage examples

Run a package migration from npm/community codemods

npx @hypermod/cli --packages @atlaskit/button@3.0.0 ./src

Run all transforms from a version to latest

npx @hypermod/cli --sequence --packages @mylib/button@3.0.0 ./src

Run a preset

npx @hypermod/cli --packages @mylib/button#remove-deprecated-props ./src

Run a local transform file

npx @hypermod/cli --transform ./codemods/rename-imports/transform.ts ./src

Browse available codemods for packages

npx @hypermod/cli list react @atlaskit/button

Initialize a new codemod package

npx @hypermod/cli init --transform 1.0.0 my-codemod-package

Validate a codemod package

npx @hypermod/cli validate ./community/my-package

What the CLI supports

@hypermod/cli is built for real migration workflows, not just one-off transforms.

  • Run codemods from local transform files.
  • Resolve codemods from npm packages and the community registry.
  • Run versioned transforms in sequence for safer upgrades.
  • Run presets for utility codemods that are not tied to a semver milestone.
  • Initialize and validate codemod packages for maintainers and contributors.
  • Access Hypermod.io-powered transform sources through the same CLI surface.

For the latest product docs and guides, visit hypermod.io/docs.

Who this is for

  • Library maintainers who want to ship upgrades users can actually adopt.
  • Platform and infra teams performing large-scale migrations across many repositories.
  • Design-system teams managing frequent component API changes.
  • Application teams that want safer, faster JavaScript and TypeScript refactors.

Contributing codemods

Community codemods live in the community/ directory and are published as packages that can be discovered and run through the Hypermod ecosystem.

Useful starting points:

Used by

Sponsors

Huge thanks for all of the support from our sponsors!

@omeraplak @necatiozmen @PreciselyAlyss @PreciselyAlyss

About

Community-owned global registry and documentation hub for codemods. Write & run codemods, share them with your friends!

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors