https://github.com/hypermod-io/hypermod-community

Community-owned global registry and documentation hub for codemods. Write & run codemods, share them with your friends!
https://github.com/hypermod-io/hypermod-community

cli codemod codemods codeshift dependency jscodeshift upgrade

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/hypermod-io/hypermod-community
• Owner: hypermod-io
• License: mit
• Created: 2021-03-24T06:30:30.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-22T08:23:28.000Z (4 months ago)
• Last Synced: 2024-10-15T09:03:02.953Z (4 months ago)
• Topics: cli, codemod, codemods, codeshift, dependency, jscodeshift, upgrade
• Language: TypeScript
• Homepage: https://hypermod.io
• Size: 11.3 MB
• Stars: 133
• Watchers: 2
• Forks: 18
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-codemods - codeshift-community - Community-owned global registry and documentation hub for codemods. Write & run codemodes, share them with your friends. (JavaScript)

README

        

  

  

  

# Hypermod Community

**Formerly: CodeshiftCommunity**

The community-owned global registry and documentation hub for codemods. Providing library maintainers & users with facilities to help write, test, publish and consume codemods in a structured, standardized and familiar way.

[💬 Join our community on Discord](https://discord.gg/XGqmKNZ8Rk)

## Features

🔭 Explore an extensive list of codemods [contributed by the community](https://www.codeshiftcommunity.com/docs/registry).

✨ [Create](https://www.codeshiftcommunity.com/docs/authoring), [test](https://www.codeshiftcommunity.com/docs/testing) and [publish](https://www.codeshiftcommunity.com/docs/consuming) codemods from anywhere.

⚡️ Use our [helpers & testing utilities](https://www.codeshiftcommunity.com/docs/utils) to make writing codemods a breeze.

🧠 Up-skill your engineering team using our [guides & resources](https://www.codeshiftcommunity.com/docs/your-first-codemod).

🎨 Perfect for [Design Systems & Monorepos](https://www.codeshiftcommunity.com/docs/monorepos).

🦄 Bring your own [AST transformer](https://www.codeshiftcommunity.com/docs/css-codemods).

## Getting started

- [Writing codemods](https://codeshiftcommunity.github.io/CodeshiftCommunity/docs/authoring)

- [Testing codemods](https://codeshiftcommunity.github.io/CodeshiftCommunity/docs/testing)

- [Guides & learning resources](https://codeshiftcommunity.github.io/CodeshiftCommunity/docs/your-first-codemod)

- [Publishing & contribution](https://codeshiftcommunity.github.io/CodeshiftCommunity/docs/contribution)

- [Consuming codemods](https://codeshiftcommunity.github.io/CodeshiftCommunity/docs/consuming)

## Registry

[The registry](https://www.codeshiftcommunity.com/docs/registry) contains all community contributed codemods, hosted and published directly from the CodeshiftCommunity repository.

Source for these packages are located in the [/community folder](https://github.com/hypermod-io/hypermod-community/tree/main/community).

- [Registry homepage](https://www.codeshiftcommunity.com/docs/contribution)

- [Contributing to the registry](https://www.codeshiftcommunity.com/docs/contribution)

- [Registry source files](https://github.com/hypermod-io/hypermod-community/tree/main/community)

## CLI

Downloading and running codemods as well as initialising and maintaining codemod packages can all be done via the Hypermod CLI (`@hypermod/cli`).

[Please see the docs for more information and examples](https://www.codeshiftcommunity.com/docs/cli)

We recommend running the CLI with $ npx to ensure you always have the latest version.

`$ npx @hypermod/cli --packages [email protected] /project/src`

But it can also be installed globally:

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

and run with:

`$ hypermod or $ hypermod-cli`

## Used by

- [Algolia](https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/react/)

- [Compiled CSS-in-JS](https://github.com/atlassian-labs/compiled/tree/master/packages/codemods)

- [react-resource-router](https://github.com/atlassian-labs/react-resource-router/tree/master/codemods)

- [Webdriver.io](https://github.com/webdriverio/codemod)

## Sponsors

Huge thanks for all of the support from our sponsors!