diffplug / diffplug/spotless

Glossary

Open
#2,008 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
5.6k
Forks
559
Avg merge
1d 14h
Merged PRs (30d)
43

Description

- **FormatterStep** - a named function which turns one string into another string
- **Formatter** - fully determines the formatted content of a file by combining a list of **FormatterStep**s which are applied in sequence, followed by setting the line endings and character encoding
- **Target** - a list of files to be formatted
- **Format** - the combination of a **Formatter** and a **Target**

If you think any of these terms are unclear, feel free to discuss below. If there are any other concepts in the code which should be defined explicitly, feel free to discuss below. The final result of all discussions is incorporated into the list above via editing, after which the discussions may be deleted. This glossary is based on an idea from Rich Hickey's [Design in Practice](https://thecontextwindow.ai/p/rich-hickeys-glossary-and-decision-matrix) talk.

Contributor guide

Open the contributing guide

Research direction

Review the existing glossary terms in the issue and identify any unclear definitions or missing concepts in Spotless. Discuss proposed changes in the issue, then consider the work done when the agreed definitions have been incorporated into the glossary.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.