Add EditorConfig rules, fix trailing whitespaces

.editorconfig

@@ -0,0 +1,22 @@
+# EditorConfig configuration for Colmena
+
+# Top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file, utf-8 charset
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+# Rust
+[*.rs]
+indent_style = space
+indent_size = 2
+
+# Vendored
+[manual/theme/highlight.js]
+end_of_line = unset
+insert_final_newline = unset
+trim_trailing_whitespace = unset

.github/workflows/editorconfig.yml

@@ -0,0 +1,20 @@
+name: Check EditorConfig
+
+on:
+  pull_request:
+  push:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2.3.4
+      - uses: cachix/install-nix-action@v15
+
+      - name: Enable binary cache (optional)
+        uses: cachix/cachix-action@v10
+        with:
+          name: colmena
+          authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+
+      - run: nix-shell --run "editorconfig-checker"

README.md

@@ -96,7 +96,7 @@ Here is a sample `hive.nix` with two nodes, with some common configurations appl
     # If you share a hive with others, or use multiple machines,
     # and are not careful to always commit/push/pull changes
     # you can accidentaly overwrite a remote profile so in those
-    # scenarios you might want to change this default to false. 
+    # scenarios you might want to change this default to false.
     # deployment.replaceUnknownProfiles = true;
   };
 

flake.nix

@@ -52,7 +52,7 @@
 
     devShell = pkgs.mkShell {
       inputsFrom = [ defaultPackage ];
-      packages = with pkgs; [ clippy mdbook python3 rust-analyzer ];
+      packages = with pkgs; [ clippy mdbook python3 editorconfig-checker rust-analyzer ];
       shellHook = ''
         export NIX_PATH=nixpkgs=${pkgs.path}
       '';

manual/src/tutorial/index.md

@@ -76,7 +76,7 @@ Here is a sample `hive.nix` with two nodes, with some common configurations appl
     # If you share a hive with others, or use multiple machines,
     # and are not careful to always commit/push/pull changes
     # you can accidentaly overwrite a remote profile so in those
-    # scenarios you might want to change this default to false. 
+    # scenarios you might want to change this default to false.
     # deployment.replaceUnknownProfiles = true;
   };
 

src/nix/hive/eval.nix

@@ -316,7 +316,7 @@ let
     else {};
 
   # The final hive will always have the meta key instead of network.
-  hive = let 
+  hive = let
     userMeta = (lib.modules.evalModules {
       modules = [ metaOptions uncheckedUserMeta ];
     }).config;

src/nix/hive/mod.rs

@@ -400,7 +400,7 @@ impl<'hive> NixInstantiate<'hive> {
 /// to generate Nix expressions directly or escaping a JSON string to strip
 /// off Nix interpolation.
 struct SerializedNixExpresssion {
-    json_file: TempPath, 
+    json_file: TempPath,
 }
 
 impl SerializedNixExpresssion {

src/nix/host/mod.rs

@@ -106,7 +106,7 @@ pub trait Host: Send + Sync + std::fmt::Debug {
     /// If `require_ownership` is false, then the ownership of a key
     /// will not be applied if the specified user/group does not
     /// exist.
-    #[allow(unused_variables)] 
+    #[allow(unused_variables)]
     async fn upload_keys(&mut self, keys: &HashMap<String, Key>, require_ownership: bool) -> ColmenaResult<()> {
         Err(ColmenaError::Unsupported)
     }
@@ -127,7 +127,7 @@ pub trait Host: Send + Sync + std::fmt::Debug {
     }
 
     /// Runs an arbitrary command on the host.
-    #[allow(unused_variables)] 
+    #[allow(unused_variables)]
     async fn run_command(&mut self, command: &[&str]) -> ColmenaResult<()> {
         Err(ColmenaError::Unsupported)
     }