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

Jump to bottom

vale: install documentation and example styles #81085

Merged
merged 3 commits into from Aug 2, 2020
Merged

vale: install documentation and example styles #81085

merged 3 commits into from Aug 2, 2020

Conversation

KAction
Copy link
Contributor

@KAction KAction commented Feb 26, 2020

"vale" is style checker for natural language. Currently, derivation only
installs binary, without any documentation on how to use it. To
actually have "vale" to generate suggestions, config file with
specification of location of style files must be written.

This changeset adds "doc" output, which contains instructions on writing
config file and "data" output which contains style files.

Things done
  • 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.

@KAction @marsam
vale: 2.0.0 -> 2.2.2
aeb3a34 
Switch from buildGoPackage to buildGoModule

According to documentation, buildGoPackage is designed for legacy Go
packages which do not support go.mod, while "vale" do support it.
@KAction @marsam
vale: install documentation into $doc output
589fb6b
@KAction @marsam
vale: install styles provided by upstream
90a4f2d
@ofborg ofborg bot requested review from kalbasit and marsam February 26, 2020 02:59
@marsam marsam changed the title ###### Install documentation and example style for "vale" linter vale: install documentation and example styles Feb 26, 2020
@ofborg ofborg bot requested a review from marsam August 2, 2020 17:31
@marsam marsam merged commit e8966b0 into NixOS:master Aug 2, 2020
@marsam
Copy link
Contributor

marsam commented Aug 2, 2020

Thank you, and sorry for the delay

@KAction KAction deleted the wip/pkg/vale branch October 29, 2021 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kalbasit kalbasit Awaiting requested review from kalbasit

@marsam marsam Awaiting requested review from marsam

Assignees
No one assigned
Labels
10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 10.rebuild-linux: 1-10 10.rebuild-linux: 1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@KAction @marsam