https://github.com/jackfirth/resyntax
A Racket refactoring engine
https://github.com/jackfirth/resyntax
Last synced: 9 months ago
JSON representation
A Racket refactoring engine
- Host: GitHub
- URL: https://github.com/jackfirth/resyntax
- Owner: jackfirth
- License: apache-2.0
- Created: 2021-01-09T01:19:13.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-06T10:57:43.000Z (9 months ago)
- Last Synced: 2025-04-07T13:54:49.906Z (9 months ago)
- Language: Racket
- Size: 696 KB
- Stars: 63
- Watchers: 4
- Forks: 11
- Open Issues: 60
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# resyntax [![CI Status][ci-status-badge]][ci-status] [![Documentation][docs-badge]][docs]
A refactoring tool for Racket built on top of `syntax-parse`.
[ci-status]: https://github.com/jackfirth/resyntax/actions
[ci-status-badge]: https://github.com/jackfirth/resyntax/workflows/CI/badge.svg
[docs]: https://docs.racket-lang.org/resyntax/index.html
[docs-badge]: https://img.shields.io/badge/docs-published-blue.svg
## Quickstart
Use the Racket package manager to install in the installation scope.
```
raco pkg install --installation resyntax
```
The `--installation` flag (shorthand for `--scope installation`) installs packages for all users of a Racket installation and ensures `resyntax` is in your `$PATH`.
e.g.
```
% resyntax analyze --file coroutines-example.rkt
resyntax: --- analyzing code ---
resyntax: --- displaying results ---
%
```
See the documentation for more details on how to use `resyntax`.
## Examples
Resyntax integrates with GitHub in two ways: an _analyzer_ GitHub action that reviews pull requests, and an _autofixer_ GitHub action that periodically creates pull requests cleaning up a repository. You can find reviews the Resyntax analyzer has left on GitHub pull requests "in the wild" using [this search](https://github.com/search?q=%22Resyntax%20analyzed%22%20%22added%20suggestions%22%20in%3Acomments%20is%3Apr%20sort%3Aupdated%20&type=pullrequests). To find pull requests created by the autofixer, use [this search](https://github.com/search?q=author%3Aapp%2Fresyntax-ci&type=pullrequests).