Update comments / leverage type aliases

Author: nsaunders

src/Dotenv/Internal/Parse.purs

@@ -9,7 +9,7 @@ import Data.Array.NonEmpty (head, length, some) as NonEmpty
 import Data.Array.NonEmpty (NonEmptyArray)
 import Data.String.CodeUnits (fromCharArray)
 import Data.Tuple (Tuple(..))
-import Dotenv.Internal.Types (Name, Settings, Value(..))
+import Dotenv.Internal.Types (Name, Setting, Settings, Value(..))
 import Text.Parsing.Parser (Parser)
 import Text.Parsing.Parser.Combinators ((<?>), lookAhead, notFollowedBy, skipMany, sepEndBy, try)
 import Text.Parsing.Parser.String (char, noneOf, oneOf, string, whiteSpace)
@@ -70,5 +70,5 @@ value :: Parser String Value
 value = (quotedValue '"' <|> quotedValue '\'' <|> unquotedValue) <?> "variable value"
 
 -- | Parses a setting in the form of `NAME=value`.
-setting :: Parser String (Tuple String Value)
+setting :: Parser String Setting
 setting = Tuple <$> name <*> value

src/Dotenv/Internal/Resolve.purs

@@ -12,6 +12,7 @@ import Data.String (joinWith)
 import Data.Traversable (sequence)
 import Data.Tuple (Tuple, fst, snd)
 import Dotenv.Internal.Types (Environment, Name, Settings, Value(..))
+import Dotenv.Types (Settings) as Public
 import Foreign.Object (lookup)
 
 -- | Given the environment and an array of `.env` settings, resolves the specified value.
@@ -30,5 +31,5 @@ value env settings val =
       VariableSubstitution name -> lookup name env <|> (value' =<< snd <$> find (eq name <<< fst) settings)
 
 -- | Given the environment and an array of `.env` settings, resolves the value of each setting.
-values :: Environment -> Settings -> Array (Tuple Name (Maybe String))
+values :: Environment -> Settings -> Public.Settings
 values env settings = rmap (value env settings) <$> settings

src/Dotenv/Internal/Types.purs

@@ -1,4 +1,4 @@
--- | This module contains the data types representing parsed `.env` content.
+-- | This module contains data types representing parsed `.env` content and the unmodified environment.
 
 module Dotenv.Internal.Types (Environment, Name, Setting, Settings, Value(..)) where
 
@@ -20,7 +20,7 @@ instance showValue :: Show Value where
   show (VariableSubstitution v) = "(VariableSubstitution \"" <> v <> "\")"
   show (ValueExpression vs) = "(ValueExpression " <> show vs <> ")"
 
--- | The conjunction of a setting name and value
+-- | The conjunction of a setting name and the corresponding value
 type Setting = Tuple Name Value
 
 -- | A collection of settings

src/Dotenv/Types.purs

@@ -1,4 +1,4 @@
--- | This module defines type aliases used in the base module.
+-- | This module defines type aliases representing `.env` settings.
 
 module Dotenv.Types (Name, Setting, Settings, Value) where