Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ocamlformat]: Version detection #41

Merged
merged 5 commits into from Feb 9, 2023
Merged

[ocamlformat]: Version detection #41

merged 5 commits into from Feb 9, 2023

Conversation

huwaireb
Copy link
Contributor

@huwaireb huwaireb commented Feb 6, 2023

Note

There is no way to pass in config file, --config takes in manually placed options, not .ocamlformat files.

builtins.getAttr "ocamlformat_${
builtins.replaceStrings ["."] ["_"]
(optionValue (lib.findFirst (option: builtins.head option == "version") []
(builtins.map (n: lib.splitString "=" n) (lib.splitString "\n" (builtins.readFile configFile)))))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit problematic that this is depending on an Import From Derivation to work. The builtins.readFile is reading the build result of the ocamlformat package that's passed in.

A better solution would be to set the meta.mainProgram of the package in nixpkgs. This would make ocamlformat work out of the box.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But thanks for the contribution!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit problematic that this is depending on an Import From Derivation to work. The builtins.readFile is reading the build result of the ocamlformat package that's passed in.

I don't follow? builtins.readFile is not reading the build result of the ocamformat package nor is it reading any other derivation, what it is reading however is a path passed as a module option, which should be fine because its known pre-eval.

There is no IFD?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad. Can you show me a usage example?

Copy link
Contributor Author

@huwaireb huwaireb Feb 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad. Can you show me a usage example?

programs.ocamlformat = {
     enable = true;
     package = ./.ocamlformat;
 };

.ocamlformat:

profile = default
version = 0.24.1

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. Let's split it out into three different options so they can be better documented:

  • package - leave that as before. Is only used if the ocamlformat file is not passed.
  • pkgs - the package set for ocamlformat file to look into. defaults to nixpkgs.
  • ocamlformat (name to be discussed) - type: none or path - path to the .ocamlformat file. Used to pick the right version of ocamlformat if passed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense,

I pushed up a commit, see if thats any good
I used configFile as opposed to ocamlformat to refer to the name

Copy link
Member

@zimbatm zimbatm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

bors merge

@bors bors bot merged commit e9033ec into numtide:main Feb 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants