spotless icon indicating copy to clipboard operation
spotless copied to clipboard

Glossary

Open nedtwigg opened this issue 1 year ago • 1 comments

  • 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 FormatterSteps 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 talk.

nedtwigg avatar Jan 17 '24 17:01 nedtwigg

This is a great idea! 👍

jbduncan avatar Jan 17 '24 20:01 jbduncan