refactor(lib): Restructure modules

app/Main.hs

@@ -1,10 +1,7 @@
 module Main (main) where
 
-import Data.Gibberish.Format qualified as Fmt
-import Data.Gibberish.GenPass (genPassphrase, genPassword)
-import Data.Gibberish.MonadPass (Pass (), usingPass)
-import Data.Gibberish.Trigraph (Language (..), TrigraphConfig (..), loadTrigraph)
-import Data.Gibberish.Types (GenPassphraseOpts (..), GenPasswordOpts (..))
+import Data.Gibberish
+import Data.Gibberish.Formatting qualified as Fmt
 
 import Control.Monad.IO.Class (MonadIO (..))
 import Data.Text (Text ())

app/gen-trigraph.hs

@@ -1,6 +1,6 @@
 module Main (main) where
 
-import Data.Gibberish.Trigraph (genTrigraph)
+import Data.Gibberish (genTrigraph)
 
 import Data.Aeson.Encode.Pretty (encodePretty)
 import Data.ByteString.Lazy (ByteString ())

gibberish.cabal

@@ -95,11 +95,13 @@ common common-test
 library
   import:          common-options
   exposed-modules:
+    Data.Gibberish,
     Data.Gibberish.Errors,
-    Data.Gibberish.Format,
-    Data.Gibberish.GenPass,
-    Data.Gibberish.MonadPass,
-    Data.Gibberish.Trigraph,
+    Data.Gibberish.Formatting,
+    Data.Gibberish.Gen,
+    Data.Gibberish.Gen.Pass,
+    Data.Gibberish.Gen.Trigraph,
+    Data.Gibberish.Monad.Pass,
     Data.Gibberish.Types,
     Data.Gibberish.Utils
   other-modules:
@@ -145,9 +147,9 @@ test-suite spec
   build-tool-depends:
     hspec-discover:hspec-discover
   other-modules:
-    Data.Gibberish.FormatSpec
-    Data.Gibberish.GenPassSpec
-    Data.Gibberish.TrigraphSpec
+    Data.Gibberish.FormattingSpec
+    Data.Gibberish.Gen.PassSpec
+    Data.Gibberish.Gen.TrigraphSpec
     Data.Gibberish.TypesSpec
     Data.Gibberish.UtilsSpec
     Paths_gibberish

src/Data/Gibberish.hs

@@ -0,0 +1,46 @@
+module Data.Gibberish
+  ( -- * Core types
+    GenPasswordOpts (..),
+    GenPassphraseOpts (..),
+    Unigram (..),
+    Digram (..),
+    Trigram (..),
+    Frequency (..),
+    Frequencies (..),
+    Trigraph (..),
+    Word (..),
+
+    -- * Password/phrase generation
+    genPassword,
+    genPassphrase,
+    genPassphrase',
+
+    -- * Trigraph generation
+    Language (..),
+    TrigraphConfig (..),
+    genTrigraph,
+    loadTrigraph,
+
+    -- * Password/phrase generation monad
+    Pass (),
+    PassT (..),
+    MonadRandom (..),
+    runPass,
+    evalPass,
+    usingPass,
+    runPassT,
+    evalPassT,
+    usingPassT,
+
+    -- * Error handling
+    GibberishErr (..),
+    isTrigraphNotFound,
+    isImpossibleError,
+  ) where
+
+import Data.Gibberish.Errors
+import Data.Gibberish.Gen
+import Data.Gibberish.Monad.Pass
+import Data.Gibberish.Types
+
+import Prelude hiding (Word ())

src/Data/Gibberish/Format.hs → src/Data/Gibberish/Formatting.hs

@@ -1,4 +1,4 @@
-module Data.Gibberish.Format
+module Data.Gibberish.Formatting
   ( FormatOpts (..),
     MaxLen (..),
     MaxHeight (..),

src/Data/Gibberish/Gen.hs

@@ -0,0 +1,7 @@
+module Data.Gibberish.Gen
+  ( module Data.Gibberish.Gen.Pass,
+    module Data.Gibberish.Gen.Trigraph,
+  ) where
+
+import Data.Gibberish.Gen.Pass
+import Data.Gibberish.Gen.Trigraph

src/Data/Gibberish/GenPass.hs → src/Data/Gibberish/Gen/Pass.hs

@@ -1,13 +1,13 @@
 {-# LANGUAGE OverloadedLists #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 
-module Data.Gibberish.GenPass
+module Data.Gibberish.Gen.Pass
   ( genPassword,
     genPassphrase,
     genPassphrase',
   ) where
 
-import Data.Gibberish.MonadPass (MonadRandom ())
+import Data.Gibberish.Monad.Pass (MonadRandom ())
 import Data.Gibberish.Types
 import Data.Gibberish.Utils
 

src/Data/Gibberish/Trigraph.hs → src/Data/Gibberish/Gen/Trigraph.hs

@@ -1,12 +1,13 @@
 {-# LANGUAGE OverloadedLists #-}
 
-module Data.Gibberish.Trigraph
+module Data.Gibberish.Gen.Trigraph
   ( Language (..),
     TrigraphConfig (..),
     genTrigraph,
     loadTrigraph,
   ) where
 
+import Data.Gibberish.Errors (GibberishErr (..))
 import Data.Gibberish.Utils (toQwertyKey)
 import Paths_gibberish (getDataFileName)
 

src/Data/Gibberish/MonadPass.hs → src/Data/Gibberish/Monad/Pass.hs

@@ -1,4 +1,4 @@
-module Data.Gibberish.MonadPass
+module Data.Gibberish.Monad.Pass
   ( Pass (),
     PassT (..),
     MonadRandom (..),

src/Data/Gibberish/Types.hs

@@ -10,11 +10,8 @@ module Data.Gibberish.Types
     Frequencies (..),
     Trigraph (..),
     Word (..),
-    module Data.Gibberish.Errors,
   ) where
 
-import Data.Gibberish.Errors
-
 import Control.DeepSeq (NFData)
 import Data.Aeson (FromJSON (..), FromJSONKey (..), ToJSON (..), ToJSONKey (..))
 import Data.Aeson qualified as Aeson

test/Data/Gibberish/FormatSpec.hs → test/Data/Gibberish/FormattingSpec.hs

@@ -1,6 +1,6 @@
-module Data.Gibberish.FormatSpec (spec) where
+module Data.Gibberish.FormattingSpec (spec) where
 
-import Data.Gibberish.Format
+import Data.Gibberish.Formatting
 import Data.Gibberish.Types
 
 import Control.Monad (forM_)

test/Data/Gibberish/GenPassSpec.hs → test/Data/Gibberish/Gen/PassSpec.hs

@@ -1,8 +1,8 @@
-module Data.Gibberish.GenPassSpec (spec) where
+module Data.Gibberish.Gen.PassSpec (spec) where
 
-import Data.Gibberish.GenPass (genPassphrase, genPassphrase', genPassword)
-import Data.Gibberish.MonadPass (usingPass, usingPassT)
-import Data.Gibberish.Trigraph (Language (..), loadTrigraph)
+import Data.Gibberish.Gen.Pass (genPassphrase, genPassphrase', genPassword)
+import Data.Gibberish.Gen.Trigraph (Language (..), loadTrigraph)
+import Data.Gibberish.Monad.Pass (usingPass, usingPassT)
 import Data.Gibberish.Types
 import Data.Gibberish.Utils (numeralConversions, symbolConversions)
 import Test.Gibberish.Gen qualified as Gen

test/Data/Gibberish/TrigraphSpec.hs → test/Data/Gibberish/Gen/TrigraphSpec.hs

@@ -1,8 +1,9 @@
 {-# LANGUAGE OverloadedLists #-}
 
-module Data.Gibberish.TrigraphSpec (spec) where
+module Data.Gibberish.Gen.TrigraphSpec (spec) where
 
-import Data.Gibberish.Trigraph
+import Data.Gibberish.Errors (isTrigraphNotFound)
+import Data.Gibberish.Gen.Trigraph
 import Data.Gibberish.Types
 import Data.Gibberish.Utils (qwertyKeys)
 import Paths_gibberish (getDataFileName)

test/Data/Gibberish/UtilsSpec.hs

@@ -1,6 +1,6 @@
 module Data.Gibberish.UtilsSpec (spec) where
 
-import Data.Gibberish.MonadPass (usingPass)
+import Data.Gibberish.Monad.Pass (usingPass)
 import Data.Gibberish.Utils
 import Test.Gibberish.Gen qualified as Gen
 

test/Golden.hs

@@ -1,6 +1,6 @@
 module Main (main) where
 
-import Data.Gibberish.Trigraph (genTrigraph)
+import Data.Gibberish (genTrigraph)
 
 import Data.Aeson.Encode.Pretty (encodePretty)
 import Data.ByteString.Lazy (ByteString ())