Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Glossary #2008

Open
nedtwigg opened this issue Jan 17, 2024 · 1 comment
Open

Glossary #2008

nedtwigg opened this issue Jan 17, 2024 · 1 comment

Comments

@nedtwigg
Copy link
Member

nedtwigg commented Jan 17, 2024

  • 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 nedtwigg pinned this issue Jan 17, 2024
@jbduncan
Copy link
Member

This is a great idea! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants