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

elmPackages.*: add meta #109553

Merged
merged 1 commit into from Jan 16, 2021
Merged

Conversation

turboMaCk
Copy link
Member

@turboMaCk turboMaCk commented Jan 16, 2021

Motivation for this change

elmPackages were missing meta attributes. This PR adds all missing meta information for rest of the tooling to consume. This will be handy especially as nixos-search will soon be able to filter packages by license, maintainer etc NixOS/nixos-search#261.

In the future we should also add platform information.

Things done

Added meta.

  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

cc @domenkozar (I've added you as a maintainer of elm compiler)

@turboMaCk turboMaCk changed the title elmPAckages.*: add meta elmPackages.*: add meta Jan 16, 2021
description = "elm-format formats Elm source code according to a standard set of rules based on the official Elm Style Guide";
homepage = "https://github.com/avh4/elm-format";
license = licenses.bsd3;
maintainers = [ maintainers.avh4 maintainers.turbomack ];
Copy link
Member Author

Choose a reason for hiding this comment

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

@avh4 just so you know - I'm adding you as a maintainer to elm-format. I believe in past you were declared directly in elm-format.nix file but I think it was overwritten by cabal2nix when the file was regenerated during some update. Defining this here means we can regenerate the file without loosing the information. Feel free to suggest change if you don't want to be declared as a maintainer anymore.

Copy link
Member Author

Choose a reason for hiding this comment

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

Update: turned out your profile is not in maintainer list so I removed you.

Copy link
Member

@SuperSandro2000 SuperSandro2000 left a comment

Choose a reason for hiding this comment

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

I didn't comment every occurrence stdenv.lib and possible uses of with maintainers.

pkgs/development/compilers/elm/default.nix Outdated Show resolved Hide resolved
pkgs/development/compilers/elm/default.nix Outdated Show resolved Hide resolved
@@ -23,6 +23,11 @@ let
wrapProgram $out/bin/elm \
--prefix PATH ':' ${lib.makeBinPath [ nodejs ]}
'';

description = "A delightful language for reliable webapps.";
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description = "A delightful language for reliable webapps.";
description = "Delightful language for reliable webapps";

Copy link
Member Author

Choose a reason for hiding this comment

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

This is taken from https://elm-lang.org/ - I'm not sure if it makes sense to change this.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've removed trailing . but kept A as it is the official tagline.

pkgs/development/compilers/elm/default.nix Outdated Show resolved Hide resolved
pkgs/development/compilers/elm/default.nix Outdated Show resolved Hide resolved
@@ -48,6 +63,11 @@ let
jailbreak = true;
# Tests are failing because of missing instances for Eq and Show type classes
doCheck = false;

description = "Instrument Elm code as a preprocessing step. Meant to be using in conjunction with elm-coverage.";
Copy link
Member

Choose a reason for hiding this comment

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

description should not contain dots at the end which probably means two sentences are to long.

pkgs/development/compilers/elm/default.nix Outdated Show resolved Hide resolved
pkgs/development/compilers/elm/default.nix Outdated Show resolved Hide resolved
pkgs/development/compilers/elm/default.nix Outdated Show resolved Hide resolved
pkgs/development/compilers/elm/default.nix Outdated Show resolved Hide resolved
@turboMaCk
Copy link
Member Author

@SuperSandro2000 I went through meta again and shorten the description. I think it would be still fair to wait for @domenkozar and @avh4 before we merge this since I'm declaring them as maintainers without consulting them first. Thanks for the review!

@turboMaCk
Copy link
Member Author

It turned out Aaron is not in maintainers list - removing.

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
@avh4
Copy link
Member

avh4 commented Jan 16, 2021

👍 I'm fine either way. (For the record, I still plan to submit a nixpkg PR each time there's a new elm-format version, as I've been doing for a while now.)

@domenkozar domenkozar merged commit feb775d into NixOS:master Jan 16, 2021
@turboMaCk turboMaCk deleted the elmPackages-add-metadata branch February 2, 2021 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants