Skip to content

openrewrite/rewrite-javascript

Repository files navigation

OpenRewrite Logo

rewrite-javascript

ci Maven Central Revved up by Gradle Enterprise Contributing Guide

Introduction

This project contains a series of Rewrite recipes and visitors to automatically apply best practices in JavaScript and TypeScript applications.

Note: For now, these languages and the associated recipes are only supported via the Moderne CLI or the Moderne Platform (at least until native build tool support catches up). That being said, the Moderne CLI is free to use for open-source repositories. If your repository is closed-source, though, you will need to obtain a license to use the CLI or the Moderne Platform. Please contact Moderne to learn more.

Getting started

For help getting started with the Moderne CLI, check out our getting started guide. Or, if you'd like to try running these recipes in the Moderne Platform, check out the Moderne Platform quickstart guide.

Contributing

We appreciate all types of contributions. See the contributing guide for detailed instructions on how to get started.

Development instructions

The release process is done by pushing a Git tag in the format of: vX.Y.Z. We use Semantic versioning for our releases. Below is example of how this is done:

git tag v1.0.0
git push origin v1.0.0

After pushing the tag, the CI/CD pipeline will automatically build and publish the package to the npm registry and bump the version in the package.json and package-lock.