Make lint-fmt a no-op when ocamlformat is not configured for a project #937
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a workaround for ocaml/dune#10578 Once `dune build @fmt` allows clean exits even when ocamlformat is not installed, we should remove this case, so that we still have the benefit of running other formatting lints that may be associated with the @fmt alias.
benmandrew
approved these changes
May 27, 2024
shonfeder
added a commit
to shonfeder/ocaml-ci
that referenced
this pull request
May 31, 2024
Reworking fixing an error I introduced in ocurrent#937
shonfeder
added a commit
that referenced
this pull request
May 31, 2024
Reworking fixing an error I introduced in #937
mtelvers
pushed a commit
to mtelvers/ocaml-ci
that referenced
this pull request
Aug 2, 2024
Reworking fixing an error I introduced in ocurrent#937
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #936
This is a workaround for ocaml/dune#10578 .
The gist is that
dune build @fmtcurrently exits with 1 if ocamlformat is not installed. So this change makes thefmt-lintjob a no-op in case the project is not configured for ocamlformat.An alternative approach would be to install ocmalformat unconditionally, but that seemed a bit iffy to me, as it takes extra resources and I thought it may produce failing outcomes that devs weren't expecting? I'm happy to go that route of others think it is preferable tho.
Once
dune build @fmtallows clean exits even when ocamlformat is not installed, we should undo this change, so that we still have the benefit of running other formatting lints that may be associated with the@fmtalias.