Skip to content

Commit a3e0d11

Browse files
committed
start on a summary in the readme
1 parent f3ad0a7 commit a3e0d11

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
1-
# Groom pretty printer
1+
# CodeBuff smart formatter
2+
3+
## Abstract
4+
5+
Code formatting is not particularly exciting but many researchers would consider it either unsolved or not well-solved. The two well-established solutions are:
6+
7+
1. Build a custom program that formats code for specific a language with ad hoc techniques, typically subject to parameters such as "*always put a space between operators*".
8+
2. Define a set of formal rules that map input patterns to layout instructions such as "*line these expressions up vertically*".
9+
10+
Either techniques are painful and finicky.
11+
12+
This repository is a step towards what we hope will be a universal code formatter that looks for patterns in a corpus and attempts to format code using those patterns.
13+
14+
## Mechanism
15+
16+
For a given language *L*, the input to CodeBuff is:
17+
18+
1. a grammar for *L*
19+
2. a set of input files written in *L*
20+
3. a file written in *L* but not in the corpus that you would like to format
221

0 commit comments

Comments
 (0)