search

wayfair / git-parse

JavaScript library that generates an array of JavaScript objects, representing the current branch of a local git repository's commit history
https://www.npmjs.com/package/git-parse
BSD 2-Clause "Simplified" License
41 stars 18 forks source link

HOT TAKE ALERT: Should we remove/replace Flow? #45

Closed Cooperbuilt closed 2 years ago

Cooperbuilt commented 2 years ago

❗ Disclaimer - this is meant to illicit some conversation. Please weigh in with your thoughts!

Question

This repository uses Flow types to type check javascript. While Flow is a perfectly fine type checking system, there are some drawbacks. First, flow-bin is losing steam and Typrescript continues to gain widespread support.

stats_per_year_image

While this isn't inherently a bad thing, I think we should consider how it may impact the ease-to-contribution for our repo here.

Also, Flow doesn't have a clear and public roadmap (note, we still haven't seen a v1). For comparisons sake, Typescript does have a clear roadmap and a stable v1

Context

Given the focused nature of this package, I'm of the mind we should keep it as simple and easy to contribute to as possible. I don't personally see the benefit of Flow for avoiding type-related bugs and it could deter future contributor-ship given it's lack of widespread adoption.

Comments

I think we should remove flow. If someone has a strong opinion on type checking, we could convert to TS. Looking for thoughts!

finn-orsini commented 2 years ago

👍

Agreed - if we want to use typechecking, we should update to TypeScript IMO.

Cooperbuilt commented 2 years ago

I agree! I guess the better question is then do we want typescript or not?

peterthehan commented 2 years ago

+1 on ts conversion

finn-orsini commented 2 years ago

Closing, decision to adopt TS documented in https://github.com/wayfair/git-parse/issues/56, changes made in https://github.com/wayfair/git-parse/pull/57