search

geocaml / ocaml-geojson

A library for manipulating, creating and parsing GeoJSON
https://geocaml.github.io/ocaml-geojson
Other
38 stars 10 forks source link

Installing correct version of `ocamlformat` #22

Closed IIITM-Jay closed 2 years ago

IIITM-Jay commented 2 years ago

By default when installing the ocamlformat via the command opam install ocamlformat it automatically installs the latest version of it as 0.21.0 but as per the .ocamlformat file we require 0.20.1.

image

IIITM-Jay commented 2 years ago

Hi Sir @patricoferris , I solved this issue by using the command opam install ocamlformat=0.20.1 , but sir I have a doubt that as why we are not using the latest version of ocamlformat (any stability issue with 0.21.0), just to know more about ocaml and opam and to gain more knowledge on that.

image

(way-1) And if we have to install the mentioned 0.20.1 version only , then I think it will be good if we add the command opam install ocamlformat=0.20.1 in the CONTRIBUTING.md file in order to make it easier for the new contributors as the common command that we found usually is opam install ocamlformat as mentioned on the git hub page of ocamlformat but that installs the latest version.

(way-2) or else, if we want to work on latest version of it i.e. 0.21.0, we have to change the version inside .ocamlformat file.

If you don't mind, shall I make a pull request on this with whichever way you like (either way-1 or 2).

waiting for your valuable suggestion on the same as I don't know whether I am going in correct direction or not.

IIITM-Jay commented 2 years ago

Hi Sir @patricoferris , Good Afternoon, any guidance on above...

patricoferris commented 2 years ago

Hi @IIITM-Jay,

Thanks :)) Yeah OCaml (opam) still has no good way to track dev dependencies -- I think just mentioning a user can get the correct version of OCamlformat from the .ocamlformat file is enough (no need to mention the version otherwise we will have to keep changing it in two places).

Deciding on what OCamlformat to use can be tricky -- using the latest means the user must be aware that they probably need to do an opam update to ensure their repository has the latest OCamlforrmat information. So it is a trade-off. If you want to also bump it to 0.21.0 at the same time I don't mind ^^

IIITM-Jay commented 2 years ago

Hi @patricoferris , Thank you so much for letting me know about this. Got clear with whatever you have explained above. Closing now as it's no longer needed

patricoferris commented 2 years ago

Hi @IIITM-Jay, sorry there's been some confusion :))

What I was trying to say was, I think adding something to the CONTRIBUTING.md would be a good thing, it should just tell people to opam install ocamlformat=X.XX.X for whatever X.XX.X is in the .ocamlformat file. Does that make sense?

IIITM-Jay commented 2 years ago

Hi Patrick Sir, @patricoferris , Thank you so much for reopening this. Actually yes, that was the only main motive to open this issue (and what I was also trying to say by opening this), and that what you have stated above also is so true.

Thank you once again :pray: for considering this and soon I will create a PR regarding this.

Thanking You. -Jay

IIITM-Jay commented 2 years ago

Hi Sir, @patricoferris , I have created a PR for this.

patricoferris commented 2 years ago

Fixed in #24