Skip to content

Commit

Permalink
chore: fix readme in sub package
Browse files Browse the repository at this point in the history
  • Loading branch information
DarkPurple141 committed Nov 15, 2023
1 parent 0b1f53a commit 7c5e2da
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
4 changes: 0 additions & 4 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
# ESLint Codemod Utilities

<div>

![brach build status](https://github.com/darkpurple141/eslint-codemod-utils/actions/workflows/build-test.yml/badge.svg?branch=master)
[![npm version](https://img.shields.io/npm/v/eslint-codemod-utils?style=flat-square)](https://www.npmjs.com/package/eslint-codemod-utils)

</div>

The `eslint-codemod-utils` package is a library of helper functions designed to enable code evolution in a similar way to `jscodeshift` - but leaning on the live and ongoing enforcement of `eslint` in your source - rather than one off codemod scripts. It provides first class typescript support and will supercharge your custom eslint rules.

## Installation
Expand Down
8 changes: 7 additions & 1 deletion packages/eslint-codemod-utils/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

![brach build status](https://github.com/darkpurple141/eslint-codemod-utils/actions/workflows/build-test.yml/badge.svg?branch=master)
[![npm version](https://img.shields.io/npm/v/eslint-codemod-utils?style=flat-square)](https://www.npmjs.com/package/eslint-codemod-utils)

The `eslint-codemod-utils` package is a library of helper functions designed to enable code evolution in a similar way to `jscodeshift` - but leaning on the live and ongoing enforcement of `eslint` in your source - rather than one off codemod scripts. It provides first class typescript support and will supercharge your custom eslint rules.

## Installation
Expand Down Expand Up @@ -133,7 +134,7 @@ Or:

It's a declarative approach to solve the same problem.

See the [eslint-plugin-example](packages/eslint-plugin-codemod) example for examples of more real world fixes.
See the [eslint-plugin-example](packages/eslint-plugin-codemod) for examples of more real world fixes.

## How it works

Expand Down Expand Up @@ -209,3 +210,8 @@ context.report({
},
})
```

## Similar projects

- AST Types [https://github.com/benjamn/ast-types](https://github.com/benjamn/ast-types)
- Codeshift Community [https://www.codeshiftcommunity.com/](https://www.codeshiftcommunity.com/)

0 comments on commit 7c5e2da

Please sign in to comment.