Merge pull request #380 from luojiyin1987/fix/typo-cleanups

Fix spelling mistakes in comments, changelog, and test fixtures

Author: dyegoaurelio

CHANGELOG.md

@@ -38,7 +38,7 @@ Other than the above, there are some notable UX changes:
   - A [Git mergetool mode](https://github.com/nixos/nixfmt?tab=readme-ov-file#git-mergetool) is now supported.
 - CLI changes:
   - In stdin-mode, `--filename <path>` can now be used to specify a filename for diagnostics.
-  - Number of indendation spaces can now be configured using `--indent <number>`
+  - Number of indentation spaces can now be configured using `--indent <number>`
 
 ## 0.6.0 -- 2023-10-31
 

main/System/IO/Atomic.hs

@@ -43,7 +43,7 @@ withOutputFile path act = transact begin commit rollback $ \(tpath, th) -> do
     begin :: IO (FilePath, Handle)
     begin = openTempFileWithDefaultPermissions tmpDir tmpTemplate
 
-    -- TODO: Support for non-unix platofrms.
+    -- TODO: Support for non-unix platforms.
     -- TODO: Preserve ctime?
     -- TODO: Preserve extended attributes (ACLs, ...)?
     copyAttributes :: (FilePath, Handle) -> IO ()

src/Nixfmt/Predoc.hs

@@ -400,7 +400,7 @@ textWidth = Text.length
 
 -- | Attempt to fit a list of documents in a single line of a specific width.
 -- ni — next indentation. Only used for trailing comment calculations. Set this to the indentation
---      of the next line relative to the current one. So usuall 2 when the indentation level increases, 0 otherwise.
+--      of the next line relative to the current one. So usually 2 when the indentation level increases, 0 otherwise.
 -- c — allowed width
 fits :: Int -> Int -> Doc -> Maybe Text
 fits _ c _ | c < 0 = Nothing

src/Nixfmt/Pretty.hs

@@ -352,7 +352,7 @@ moveParamsComments
     [ ParamAttr name maybeDefault (Just (comma{preTrivia = []})),
       ParamEllipsis (ellipsis{preTrivia = trivia <> trivia'})
     ]
--- Inject a trailing comma on the last element if nessecary
+-- Inject a trailing comma on the last element if necessary
 moveParamsComments [ParamAttr name@Ann{sourceLine} def Nothing] = [ParamAttr name def (Just (ann sourceLine TComma))]
 moveParamsComments (x : xs) = x : moveParamsComments xs
 moveParamsComments [] = []

src/Nixfmt/Types.hs

@@ -203,7 +203,7 @@ instance Eq Parameter where
       && cmp l2 r2
       && l3 == r3
     where
-      -- Compare two lists of paramters, but for the last argument don't compare whether or not there is a trailing comma
+      -- Compare two lists of parameters, but for the last argument don't compare whether or not there is a trailing comma
       cmp [] [] = True
       cmp [ParamAttr x1 x2 _] [ParamAttr y1 y2 _] = x1 == y1 && x2 == y2
       cmp (x : xs) (y : ys) = x == y && cmp xs ys

test/diff/idioms_lib_5/in.nix

@@ -62,7 +62,7 @@ let
 
   isMarkedInsecure = attrs: (attrs.meta.knownVulnerabilities or []) != [];
 
-  # Alow granular checks to allow only some unfree packages
+  # Allow granular checks to allow only some unfree packages
   # Example:
   # {pkgs, ...}:
   # {
@@ -218,7 +218,7 @@ let
 
       however ${getName attrs} only has the outputs: ${builtins.concatStringsSep ", " actualOutputs}
 
-      and is missing the following ouputs:
+      and is missing the following outputs:
 
       ${lib.concatStrings (builtins.map (output: "  - ${output}\n") missingOutputs)}
     '';

test/diff/idioms_lib_5/out-pure.nix

@@ -78,7 +78,7 @@ let
 
   isMarkedInsecure = attrs: (attrs.meta.knownVulnerabilities or [ ]) != [ ];
 
-  # Alow granular checks to allow only some unfree packages
+  # Allow granular checks to allow only some unfree packages
   # Example:
   # {pkgs, ...}:
   # {
@@ -254,7 +254,7 @@ let
 
       however ${getName attrs} only has the outputs: ${builtins.concatStringsSep ", " actualOutputs}
 
-      and is missing the following ouputs:
+      and is missing the following outputs:
 
       ${lib.concatStrings (builtins.map (output: "  - ${output}\n") missingOutputs)}
     '';

test/diff/idioms_lib_5/out.nix

@@ -78,7 +78,7 @@ let
 
   isMarkedInsecure = attrs: (attrs.meta.knownVulnerabilities or [ ]) != [ ];
 
-  # Alow granular checks to allow only some unfree packages
+  # Allow granular checks to allow only some unfree packages
   # Example:
   # {pkgs, ...}:
   # {
@@ -254,7 +254,7 @@ let
 
       however ${getName attrs} only has the outputs: ${builtins.concatStringsSep ", " actualOutputs}
 
-      and is missing the following ouputs:
+      and is missing the following outputs:
 
       ${lib.concatStrings (builtins.map (output: "  - ${output}\n") missingOutputs)}
     '';

test/diff/idioms_pkgs_5/in.nix

@@ -380,7 +380,7 @@ else let
       # Derivations set it to choose what sort of machine could be used to
       # execute the build, The build platform entirely determines this,
       # indeed more finely than Nix knows or cares about. The `system`
-      # attribute of `buildPlatfom` matches Nix's degree of specificity.
+      # attribute of `buildPlatform` matches Nix's degree of specificity.
       # exactly.
       inherit (stdenv.buildPlatform) system;
 

test/diff/idioms_pkgs_5/out-pure.nix

@@ -514,7 +514,7 @@ let
             # Derivations set it to choose what sort of machine could be used to
             # execute the build, The build platform entirely determines this,
             # indeed more finely than Nix knows or cares about. The `system`
-            # attribute of `buildPlatfom` matches Nix's degree of specificity.
+            # attribute of `buildPlatform` matches Nix's degree of specificity.
             # exactly.
             inherit (stdenv.buildPlatform) system;