From 75a9bcf56b77149f07873c3984537849ac8a49be Mon Sep 17 00:00:00 2001 From: amatrelan Date: Mon, 4 May 2020 13:47:59 +0300 Subject: [PATCH 1/3] Added lang/nix barebone readme. I added all the things I know about this module but there might be something I don't know about so check and validate. This is related to #1166 effort. --- modules/lang/nix/README.org | 55 +++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 modules/lang/nix/README.org diff --git a/modules/lang/nix/README.org b/modules/lang/nix/README.org new file mode 100644 index 000000000..13a45eab5 --- /dev/null +++ b/modules/lang/nix/README.org @@ -0,0 +1,55 @@ +#+TITLE: lang/nix +#+DATE: May 4, 2020 +#+SINCE: v2.0.7 +#+STARTUP: inlineimages nofold + +* Table of Contents :TOC_3:noexport: +- [[#description][Description]] + - [[#maintainers][Maintainers]] + - [[#module-flags][Module Flags]] + - [[#plugins][Plugins]] +- [[#prerequisites][Prerequisites]] +- [[#features][Features]] +- [[#configuration][Configuration]] +- [[#troubleshooting][Troubleshooting]] + +* Description +Adds many tools for [[https://nixos.org/][nix(os)]] users in nice package for Doom users. + ++ Syntax highlight ++ Completion through ~company~ / ~helm~ ++ Nix option lookup ++ Formatting (~nixfmt~) + +** Maintainers +This module has no dedicated maintainers. + +** Module Flags +This module provides no flags. + +** Plugins ++ [[https://github.com/NixOS/nix-mode][nix-mode]] ++ [[https://github.com/jwiegley/nix-update-el][nix-update]] + +* Prerequisites + +* Features ++ ~nixfmt~ is required to use formatting + + If you have nix(os) installed it can be installed trough nix configuration ~enviroment.systemPackages = with pkgs; [ nixfmt ];~ (recommended) + + Or trough nix-env ~nix-env -iA nixpkgs.nixfmt~ + + Or trough nix-shell ~nix-shell -f https://github.com/serokell/nixfmt/archive/master.tar.gz -i~ ++ ~:editor format~ ~format-all~ also supports ~nixfmt~ so you can use that also to format nix code, default bindings ~SPC c f~ in evil. + +* Configuration +| Binding | Description | +|-------------------+----------------------| +| ~ b~ | ~nix-build~ | +| ~ f~ | ~nix-update-fetch~ | +| ~ o~ | ~+nix/lookup-option~ | +| ~ p~ | ~nix-format-buffer~ | +| ~ r~ | ~nix-repl-show~ | +| ~ s~ | ~nix-repl-shell~ | +| ~ u~ | ~nix-unpack~ | + +* Troubleshooting ++ There isn't any known problems. From 9219d257466140bb3dafb33205bf98bdf6a78844 Mon Sep 17 00:00:00 2001 From: Jarmo Riikonen Date: Wed, 6 May 2020 19:27:10 +0300 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Oleksii Filonenko --- modules/lang/nix/README.org | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/modules/lang/nix/README.org b/modules/lang/nix/README.org index 13a45eab5..ef3e702d5 100644 --- a/modules/lang/nix/README.org +++ b/modules/lang/nix/README.org @@ -14,9 +14,9 @@ - [[#troubleshooting][Troubleshooting]] * Description -Adds many tools for [[https://nixos.org/][nix(os)]] users in nice package for Doom users. +Adds many tools for [[https://nixos.org/][Nix(OS)]] users in nice package for Doom users. -+ Syntax highlight ++ Syntax highlighting + Completion through ~company~ / ~helm~ + Nix option lookup + Formatting (~nixfmt~) @@ -35,10 +35,10 @@ This module provides no flags. * Features + ~nixfmt~ is required to use formatting - + If you have nix(os) installed it can be installed trough nix configuration ~enviroment.systemPackages = with pkgs; [ nixfmt ];~ (recommended) - + Or trough nix-env ~nix-env -iA nixpkgs.nixfmt~ - + Or trough nix-shell ~nix-shell -f https://github.com/serokell/nixfmt/archive/master.tar.gz -i~ -+ ~:editor format~ ~format-all~ also supports ~nixfmt~ so you can use that also to format nix code, default bindings ~SPC c f~ in evil. + + If you have Nix(OS) installed it can be installed through Nix configuration ~environment.systemPackages = with pkgs; [ nixfmt ];~ (recommended) + + Or through nix-env ~nix-env -iA nixpkgs.nixfmt~ + + Or through nix-shell ~nix-shell -f https://github.com/serokell/nixfmt/archive/master.tar.gz -i~ ++ ~:editor format~ ~format-all~ also supports ~nixfmt~ so you can use that also to format Nix code, default binding is ~SPC c f~ in evil. * Configuration | Binding | Description | @@ -52,4 +52,4 @@ This module provides no flags. | ~ u~ | ~nix-unpack~ | * Troubleshooting -+ There isn't any known problems. ++ There aren't any known problems. From 7dbf51f11cbc8990a7328d24bf519907a84372e8 Mon Sep 17 00:00:00 2001 From: amatrelan Date: Wed, 6 May 2020 22:14:38 +0300 Subject: [PATCH 3/3] Move nixfmt note and Keybindings to correct place --- modules/lang/nix/README.org | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/modules/lang/nix/README.org b/modules/lang/nix/README.org index ef3e702d5..64f3d1ef3 100644 --- a/modules/lang/nix/README.org +++ b/modules/lang/nix/README.org @@ -10,6 +10,7 @@ - [[#plugins][Plugins]] - [[#prerequisites][Prerequisites]] - [[#features][Features]] + - [[#keybindings][Keybindings]] - [[#configuration][Configuration]] - [[#troubleshooting][Troubleshooting]] @@ -32,15 +33,14 @@ This module provides no flags. + [[https://github.com/jwiegley/nix-update-el][nix-update]] * Prerequisites - -* Features + ~nixfmt~ is required to use formatting + If you have Nix(OS) installed it can be installed through Nix configuration ~environment.systemPackages = with pkgs; [ nixfmt ];~ (recommended) + Or through nix-env ~nix-env -iA nixpkgs.nixfmt~ + Or through nix-shell ~nix-shell -f https://github.com/serokell/nixfmt/archive/master.tar.gz -i~ + ~:editor format~ ~format-all~ also supports ~nixfmt~ so you can use that also to format Nix code, default binding is ~SPC c f~ in evil. -* Configuration +* Features +** Keybindings | Binding | Description | |-------------------+----------------------| | ~ b~ | ~nix-build~ | @@ -51,5 +51,7 @@ This module provides no flags. | ~ s~ | ~nix-repl-shell~ | | ~ u~ | ~nix-unpack~ | +* Configuration + * Troubleshooting + There aren't any known problems.