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

vale: install documentation and example styles #81085

Merged
merged 3 commits into from Aug 2, 2020
Merged

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 added 3 commits Feb 26, 2020
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.
@marsam marsam changed the title ###### Install documentation and example style for "vale" linter vale: install documentation and example styles Feb 26, 2020
@marsam marsam force-pushed the KAction:wip/pkg/vale branch from 60ebb84 to 90a4f2d Aug 2, 2020
@ofborg ofborg bot requested a review from marsam Aug 2, 2020
@marsam marsam merged commit e8966b0 into NixOS:master Aug 2, 2020
18 checks passed
18 checks passed
tests tests
Details
tests
Details
Evaluation Performance Report Evaluator Performance Report
Details
grahamcofborg-eval ^.^!
Details
grahamcofborg-eval-check-maintainers matching changed paths to changed attrs...
Details
grahamcofborg-eval-check-meta config.nix: checkMeta = true
Details
grahamcofborg-eval-darwin nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="90a4f2d"; rev="90a4f2d9bac48b6833f1c952c25d8c606bc159ce"; } ./pkgs/t
Details
grahamcofborg-eval-lib-tests nix-build --arg pkgs import ./. {} ./lib/tests/release.nix
Details
grahamcofborg-eval-nixos nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="90a4f2d"; rev="90a4f2d9bac48b6833f1c952c25d8c606bc159ce"; } ./nixos/
Details
grahamcofborg-eval-nixos-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="90a4f2d"; rev="90a4f2d9bac48b6833f1c952c25d8c606bc159ce"; } ./nixos/
Details
grahamcofborg-eval-nixos-options nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="90a4f2d"; rev="90a4f2d9bac48b6833f1c952c25d8c606bc159ce"; } ./nixos/
Details
grahamcofborg-eval-nixpkgs-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="90a4f2d"; rev="90a4f2d9bac48b6833f1c952c25d8c606bc159ce"; } ./pkgs/t
Details
grahamcofborg-eval-nixpkgs-tarball nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="90a4f2d"; rev="90a4f2d9bac48b6833f1c952c25d8c606bc159ce"; } ./pkgs/t
Details
grahamcofborg-eval-nixpkgs-unstable-jobset nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="90a4f2d"; rev="90a4f2d9bac48b6833f1c952c25d8c606bc159ce"; } ./pkgs/t
Details
grahamcofborg-eval-package-list nix-env -qa --json --file .
Details
grahamcofborg-eval-package-list-no-aliases nix-env -qa --json --file . --arg config { allowAliases = false; }
Details
vale, vale.passthru.tests on aarch64-linux Success
Details
vale, vale.passthru.tests on x86_64-linux Success
Details
@marsam
Copy link
Contributor

@marsam marsam commented Aug 2, 2020

Thank you, and sorry for the delay

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.