diffplug / diffplug/selfie

Glossary

Abierto
#104 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Kotlin
Estrellas
101
Forks
18
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

- **Subject** - a single value (string or binary) which best records a snapshotted entity
- **Facet** - a single *named* value (string or binary) which records a single aspect or point of view of a snapshotted entity
- **Snapshot** - a combination of a **subject** and zero or more **facets** which captures all relevant data of an entity whose behavior we wish to *record and specify*
- **Camera** - a function that transforms a specific type of entity into a **snapshot**
- **Lens** - a function which transforms one **snapshot** into a new **snapshot**, usually by adding new **facet**s that emphasize a certain point of view of the **subject**, but possibly also by cleaning the existing **subject** and **facet**s
- **Equality assertion** - a success condition which requires a value under to test to exactly match an expected value
- **Inline snapshot** - an **equality assertion** where the expected value can be written into the sourcecode by automated tooling
- **Inline literal snapshot** - an **inline snapshot** where the expected value must always be a source code literal, never a compound expression
- `expect(2 + 2).toMatchInlineSnapshot(4)` <-- inline literal snapshot
- `expect(2 + 2).toMatchInlineSnapshot(2 * 2)` <-- inline ~~literal~~ snapshot, because it's not literal, when tooling modifies the value inside `()`, it can't do a self-error-check to make sure it has correctly parsed the same value which got passed at runtime
- Conversationally people will say "inline snapshot", "literal snapshot", "inline literal snapshot", etc. They mostly mean the same thing, but in selfie we will try to always say "inline literal".

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/i/139974825/glossary) talk.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Revisa el glosario y sus definiciones en el issue #104, y luego considera si los términos incluidos u otros conceptos de código necesitan aclaración. Discute la terminología poco clara en el issue; se considera terminado cuando las definiciones acordadas se hayan incorporado al glosario.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.