Support sorting CDDL

This is useful to compare generated CDDL files.

Author: nc6

bin/Main.hs

@@ -22,11 +22,12 @@ import System.Exit (exitFailure, exitSuccess)
 import System.IO (hPutStrLn, stderr)
 import System.Random (getStdGen)
 import Text.Megaparsec (ParseErrorBundle, Parsec, errorBundlePretty, runParser)
+import Codec.CBOR.Cuddle.CDDL (sortCDDL)
 
 data Opts = Opts Command String
 
 data Command
-  = Format
+  = Format FormatOpts
   | Validate
   | GenerateCBOR GenOpts
 
@@ -67,14 +68,25 @@ pGenOpts =
           <> value AsCBOR
       )
 
+newtype FormatOpts = FormatOpts
+  {sort :: Bool}
+
+pFormatOpts :: Parser FormatOpts
+pFormatOpts =
+  FormatOpts
+    <$> switch
+      ( long "sort-rules"
+          <> help "Sort the CDDL rule definitions before printing."
+      )
+
 opts :: Parser Opts
 opts =
   Opts
     <$> subparser
       ( command
           "format"
           ( info
-              (pure Format)
+              ( Format <$> pFormatOpts)
               ( progDesc "Format the provided CDDL file"
               )
           )
@@ -114,7 +126,8 @@ run (Opts cmd cddlFile) = do
       putStrLnErr $ errorBundlePretty err
       exitFailure
     Right res -> case cmd of
-      Format -> putDocW 80 $ pretty res
+      Format fOpts -> let defs = if sort fOpts then sortCDDL res else res in 
+        putDocW 80 $ pretty defs
       Validate -> case fullResolveCDDL res of
         Left err -> putStrLnErr (show err) >> exitFailure
         Right _ -> exitSuccess

cuddle.cabal

@@ -1,6 +1,6 @@
 cabal-version:   3.4
 name:            cuddle
-version:         0.2.0.1
+version:         0.2.1.0
 synopsis:        CDDL Generator and test utilities
 
 -- description:

src/Codec/CBOR/Cuddle/CDDL.hs

@@ -13,9 +13,16 @@ import GHC.Generics (Generic)
 newtype CDDL = CDDL (NE.NonEmpty (WithComments Rule))
   deriving (Eq, Generic, Show)
 
+-- | Sort the CDDL Rules on the basis of their names
+sortCDDL :: CDDL -> CDDL 
+sortCDDL (CDDL xs) = CDDL $ NE.sort xs
+
 data WithComments a = WithComments a (Maybe Comment)
   deriving (Eq, Show, Generic)
 
+instance Ord a => Ord (WithComments a) where
+  compare (WithComments a1 _) (WithComments a2 _) = compare a1 a2 
+
 stripComment :: WithComments a -> a
 stripComment (WithComments a _) = a
 
@@ -114,6 +121,9 @@ newtype GenericArg = GenericArg (NE.NonEmpty Type1)
 data Rule = Rule Name (Maybe GenericParam) Assign TypeOrGroup
   deriving (Eq, Generic, Show)
 
+instance Ord Rule where
+  compare (Rule n1 _ _ _) (Rule n2 _ _ _) = compare n1 n2 
+
 -- |
 --   A range operator can be used to join two type expressions that stand
 --   for either two integer values or two floating-point values; it