libgit2 / libgit2/libgit2sharp
The Filter API contains singleton Entry-points which are agnostic to `FilterMode`, does having `Clean` and `Smudge` entry-points make sense?
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- C#
- Estrellas
- 3.5k
- Forks
- 925
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Today the Filter object (the API we expose to lib consumers) contains the following entry-points:
virtual void Initialize()virtual void Complete(string path, string root, Stream output)virtual void Create(string path, string root, FilterMode)virtual void Clean(string path, string root, Stream input, Stream output)virtual void Smudge(string path, string root, Stream input, Stream output)
This is very uneven and, to my OCD, a fairly inconsistent API. I'm responsible and I'd like to change it, however some have already taken a dependency. In the spirit of #1103 I suggest changing the API to the following.
virtual void Initialize()virtual void Complete(string root, string path, Stream output, FilterMode mode)virtual void Create(string root, string path, FilterMode mode)virtual void Apply(string root, string path, Stream input, Stream output, FilterMode mode)
I believe this is a simplified API which presents a consistent set of entry-points, and leaves the mode management up to the implementation of Filter. I'll happily make the changes and update the associated tests.
As a side note, I had a side-band discussion with @ethomson about how to handle the .gitattributes macros (example: [filter "lfs"] \n clean = git lfs clean %f \n smudge = git lfs smudge %f). While there are normal situations when you just know(tm) what to do on smudge and clean callbacks, ideally the filter would at least aware if the user has edited the values of the macro.
Assuming we can find a solution, whatever solution we'll find will likely end up impact this API. Perhaps then we should combine the two discussions here.
/CC @ammeep @shiftkey @nulltoken
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza revisando la Filter API expuesta y sus pruebas asociadas, que el issue identifica como afectadas por los cambios de firma propuestos. Después, examina cómo se gestionan las macros clean y smudge de .gitattributes; para darlo por terminado se requiere un diseño de API acordado, dependientes actualizados y pruebas superadas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- csharp, git
- Área
- backend-api-design, tooling
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100