Make KDL a top-level module

Author: brandonchinn178

README.md

@@ -24,7 +24,7 @@ package {
 Parse it with `kdl-hs`:
 
 ```hs
-import Data.KDL qualified as KDL
+import KDL qualified as KDL
 
 main :: IO ()
 main = do

kdl-hs.cabal

@@ -23,24 +23,24 @@ source-repository head
 library
   hs-source-dirs: src
   exposed-modules:
-    Data.KDL
-    Data.KDL.Arrow
-    Data.KDL.Decoder
-    Data.KDL.Decoder.Arrow
-    Data.KDL.Decoder.Internal.DecodeM
-    Data.KDL.Decoder.Internal.Error
-    Data.KDL.Decoder.Internal.Monad
-    Data.KDL.Decoder.Monad
-    Data.KDL.Decoder.Schema
-    Data.KDL.Parser
-    Data.KDL.Render
-    Data.KDL.Types
+    KDL
+    KDL.Arrow
+    KDL.Decoder
+    KDL.Decoder.Arrow
+    KDL.Decoder.Internal.DecodeM
+    KDL.Decoder.Internal.Error
+    KDL.Decoder.Internal.Monad
+    KDL.Decoder.Monad
+    KDL.Decoder.Schema
+    KDL.Parser
+    KDL.Render
+    KDL.Types
   other-modules:
-    Data.KDL.Parser.Hustle
-    Data.KDL.Parser.Hustle.Formatter
-    Data.KDL.Parser.Hustle.Internal
-    Data.KDL.Parser.Hustle.Parser
-    Data.KDL.Parser.Hustle.Types
+    KDL.Parser.Hustle
+    KDL.Parser.Hustle.Formatter
+    KDL.Parser.Hustle.Internal
+    KDL.Parser.Hustle.Parser
+    KDL.Parser.Hustle.Types
   build-depends:
       base < 5
     , containers
@@ -59,9 +59,9 @@ test-suite kdl-tests
   hs-source-dirs: test
   main-is: Main.hs
   other-modules:
-    Data.KDL.ParserSpec
-    Data.KDL.Decoder.ArrowSpec
-    Data.KDL.Decoder.MonadSpec
+    KDL.ParserSpec
+    KDL.Decoder.ArrowSpec
+    KDL.Decoder.MonadSpec
   build-depends:
       base
     , containers

src/Data/KDL/Decoder.hs

@@ -1,10 +1,10 @@
 {-|
 This module is intended to be imported qualified as:
 
-> import Data.KDL qualified as KDL
+> import KDL qualified as KDL
 
 This provides a Monad interface for decoding KDL files, which is sufficient for
-most cases. You may wish to use "Data.KDL.Arrow" if you would like to
+most cases. You may wish to use "KDL.Arrow" if you would like to
 statically analyze a decoder's schema, e.g. to generate documentation.
 
 = Quickstart
@@ -26,7 +26,7 @@ package {
 Parse it with @kdl-hs@:
 
 @
-import Data.KDL qualified as KDL
+import KDL qualified as KDL
 
 main :: IO ()
 main = do
@@ -64,11 +64,11 @@ instance KDL.DecodeNode Dep where
     pure Dep{..}
 @
 -}
-module Data.KDL (
+module KDL (
   module X,
 ) where
 
-import Data.KDL.Decoder as X
-import Data.KDL.Parser as X
-import Data.KDL.Render as X
-import Data.KDL.Types as X
+import KDL.Decoder as X
+import KDL.Parser as X
+import KDL.Render as X
+import KDL.Types as X

src/Data/KDL/Decoder/Monad.hs

@@ -2,9 +2,9 @@
 This module defines the Arrow interface for decoding a KDL document. Intended to
 be imported qualified as:
 
-> import Data.KDL.Arrow qualified as KDL
+> import KDL.Arrow qualified as KDL
 
-For most use-cases, the Monad interface exported by "Data.KDL" is sufficient. You
+For most use-cases, the Monad interface exported by "KDL" is sufficient. You
 may wish to use the Arrow interface if you would like to statically analyze a
 decoder's schema, e.g. to generate documentation.
 
@@ -29,7 +29,7 @@ Parse it with:
 @
 {\-# LANGUAGE Arrows #-\}
 
-import Data.KDL.Decoder.Arrow qualified as KDL
+import KDL.Decoder.Arrow qualified as KDL
 
 main :: IO ()
 main = do
@@ -67,12 +67,12 @@ instance KDL.DecodeNode Dep where
     returnA -< Dep{..}
 @
 -}
-module Data.KDL.Arrow (
+module KDL.Arrow (
   module X,
 ) where
 
-import Data.KDL.Decoder.Arrow as X
-import Data.KDL.Decoder.Schema as X
-import Data.KDL.Parser as X
-import Data.KDL.Render as X
-import Data.KDL.Types as X
+import KDL.Decoder.Arrow as X
+import KDL.Decoder.Schema as X
+import KDL.Parser as X
+import KDL.Render as X
+import KDL.Types as X

src/Data/KDL.hs src/KDL.hssrc/Data/KDL.hs renamed to src/KDL.hs

@@ -0,0 +1,10 @@
+module KDL.Decoder (
+  -- * Decoder monad
+  module KDL.Decoder.Monad,
+
+  -- * Schema
+  module KDL.Decoder.Schema,
+) where
+
+import KDL.Decoder.Monad
+import KDL.Decoder.Schema

src/Data/KDL/Arrow.hs src/KDL/Arrow.hssrc/Data/KDL/Arrow.hs renamed to src/KDL/Arrow.hs

@@ -5,14 +5,14 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE TypeFamilies #-}
 
-module Data.KDL.Decoder.Arrow (
+module KDL.Decoder.Arrow (
   decodeWith,
   decodeFileWith,
   decodeDocWith,
 
   -- * Decoder
   Decoder,
-  module Data.KDL.Decoder.Internal.DecodeM,
+  module KDL.Decoder.Internal.DecodeM,
   fail,
   withDecoder,
   debug,
@@ -91,17 +91,31 @@ import Control.Monad.Trans.State.Strict (StateT)
 import Control.Monad.Trans.State.Strict qualified as StateT
 import Data.Bits (finiteBitSize)
 import Data.Int (Int64)
-import Data.KDL.Decoder.Internal.DecodeM
-import Data.KDL.Decoder.Internal.Monad
-import Data.KDL.Decoder.Schema (
+import Data.List (partition)
+import Data.List.NonEmpty qualified as NonEmpty
+import Data.Map.Strict (Map)
+import Data.Map.Strict qualified as Map
+import Data.Maybe (fromMaybe, isNothing)
+import Data.Proxy (Proxy (..))
+import Data.Scientific (Scientific)
+import Data.Scientific qualified as Scientific
+import Data.Set qualified as Set
+import Data.Text (Text)
+import Data.Text qualified as Text
+import Data.Typeable (Typeable, typeRep)
+import Data.Word (Word16, Word32, Word64, Word8)
+import GHC.Int (Int16, Int32, Int8)
+import KDL.Decoder.Internal.DecodeM
+import KDL.Decoder.Internal.Monad
+import KDL.Decoder.Schema (
   Schema (..),
   SchemaItem (..),
   SchemaOf,
   TypedNodeSchema (..),
   TypedValueSchema (..),
  )
-import Data.KDL.Parser (parse, parseFile)
-import Data.KDL.Types (
+import KDL.Parser (parse, parseFile)
+import KDL.Types (
   Ann (..),
   Document,
   Entry (..),
@@ -111,20 +125,6 @@ import Data.KDL.Types (
   Value (..),
   ValueData (..),
  )
-import Data.List (partition)
-import Data.List.NonEmpty qualified as NonEmpty
-import Data.Map.Strict (Map)
-import Data.Map.Strict qualified as Map
-import Data.Maybe (fromMaybe, isNothing)
-import Data.Proxy (Proxy (..))
-import Data.Scientific (Scientific)
-import Data.Scientific qualified as Scientific
-import Data.Set qualified as Set
-import Data.Text (Text)
-import Data.Text qualified as Text
-import Data.Typeable (Typeable, typeRep)
-import Data.Word (Word16, Word32, Word64, Word8)
-import GHC.Int (Int16, Int32, Int8)
 import Numeric.Natural (Natural)
 import Prelude hiding (any, fail, null)
 import Prelude qualified

src/KDL/Decoder.hs

@@ -4,9 +4,9 @@
 {-# LANGUAGE RecordWildCards #-}
 {-# LANGUAGE NoFieldSelectors #-}
 
-module Data.KDL.Decoder.Internal.DecodeM (
+module KDL.Decoder.Internal.DecodeM (
   -- * Decoding errors
-  module Data.KDL.Decoder.Internal.Error,
+  module KDL.Decoder.Internal.Error,
 
   -- * DecodeM monad
   DecodeM (..),
@@ -19,8 +19,8 @@ module Data.KDL.Decoder.Internal.DecodeM (
 ) where
 
 import Control.Applicative (Alternative (..))
-import Data.KDL.Decoder.Internal.Error
 import Data.Text (Text)
+import KDL.Decoder.Internal.Error
 
 -- | The monad that returns either a 'DecodeError' or a result of type @a@.
 --

src/Data/KDL/Decoder/Arrow.hs src/KDL/Decoder/Arrow.hssrc/Data/KDL/Decoder/Arrow.hs renamed to src/KDL/Decoder/Arrow.hs

@@ -4,25 +4,25 @@
 {-# LANGUAGE RecordWildCards #-}
 {-# LANGUAGE NoFieldSelectors #-}
 
-module Data.KDL.Decoder.Internal.Error (
+module KDL.Decoder.Internal.Error (
   DecodeError (..),
   BaseDecodeError (..),
   Context,
   ContextItem (..),
   renderDecodeError,
 ) where
 
-import Data.KDL.Render (
+import Data.Map qualified as Map
+import Data.Text (Text)
+import Data.Text qualified as Text
+import KDL.Render (
   renderIdentifier,
   renderValue,
  )
-import Data.KDL.Types (
+import KDL.Types (
   Identifier,
   Value,
  )
-import Data.Map qualified as Map
-import Data.Text (Text)
-import Data.Text qualified as Text
 
 data DecodeError = DecodeError [(Context, BaseDecodeError)]
   deriving (Show, Eq)