Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/6cdh/racket-fixw
a Racket formatter that only fixes whitespaces
https://github.com/6cdh/racket-fixw
racket
Last synced: 18 days ago
JSON representation
a Racket formatter that only fixes whitespaces
- Host: GitHub
- URL: https://github.com/6cdh/racket-fixw
- Owner: 6cdh
- License: apache-2.0
- Created: 2023-02-17T05:07:11.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T05:21:50.000Z (10 months ago)
- Last Synced: 2024-11-13T00:43:33.517Z (3 months ago)
- Topics: racket
- Language: Racket
- Homepage: https://docs.racket-lang.org/fixw/
- Size: 129 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE-2.0
Awesome Lists containing this project
README
# Racket fixw
A Racket formatter that add/remove some whitespaces but respects newline.
## :battery: Status
It should work as expected, except some rules for macros and special forms are missing.
## :printer: Example
before
```racket
#lang racket
(define(fib n )
(if (<= n 1)
1
(+ (fib (- n 1))
(fib (- n 2)) )))
```
after
```racket
#lang racket
(define (fib n)
(if (<= n 1)
1
(+ (fib (- n 1))
(fib (- n 2)))))
```
## :airplane: Performance
- [x] format a 5k lines file in 100ms on a 6 years old laptop
The biggest Racket file [class-internal.rkt](https://github.com/racket/racket/blob/9b202f565d85cebdf8b5bb91d013eb0ecf06cba6/racket/collects/racket/private/class-internal.rkt) in [racket/racket](https://github.com/racket/racket) repo has almost 5k lines, so I think it's fast enough.
## :sparkles: Features
- [x] fix indent
- [x] respect newline
- [x] works for unbalanced code
- [x] remove trailing spaces
- [x] force only one space between two tokens with several exceptions
- [x] force only one empty line at the end of the file
- [ ] make it configurable
- [x] raco integration
- [x] read [scmindent](https://github.com/ds26gte/scmindent) compatible configuration file
- [x] skip code that surrounded by special comments
- [x] support range formatting
- [ ] a configurable system looks like macro but allows user customize the formatting
- [ ] support sort `require`
- [ ] support keyword arguments and default arguments
## :bookmark_tabs: todo
- [ ] refactor
- [ ] isolate the lexer workarounds and special escape comments processing
- [ ] simplify the core logic
## :rocket: Run
```shell
# install
raco pkg install fixw
# show help
raco fixw -h
# read from stdin and output formatted text to stdout
raco fixw
# format current directory recursively
raco fixw .
```
## :thinking: docs
See [online docs](https://docs.racket-lang.org/fixw/index.html).
## :paperclips: See also
- [fmt](https://github.com/sorawee/fmt) - a Racket formatter that calculate optimal layout
- [scmindent](https://github.com/ds26gte/scmindent) - a general lisp indenter