chore: use my hackage lib instead of git submodule

* try lens a bit(when we start to analyze the structures from SolFile data, it's very helpful) * print contracts inside a function instead of the whole AST
xieyuschen · Aug 23, 2024 · 649fafd · 649fafd
1 parent 9ee6917
commit 649fafd
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 42 deletions.
diff --git a/.gitmodules b/.gitmodules
diff --git a/slinter.cabal b/slinter.cabal
@@ -7,19 +7,6 @@ author:             xieyuschen
 maintainer:         xieyuschen@gmail.com
 build-type:         Simple
 extra-doc-files:    CHANGELOG.md
-
--- todo: remove this after I upload my forked version to hackage
--- https://github.com/xieyuschen/x-sum-type-boilerplate
-library x-sum-type-boilerplate
-  exposed-modules:
-      SumTypes.TH
-  hs-source-dirs:
-      src/Lib/x-sum-type-boilerplate/library
-  ghc-options: -Wall
-  build-depends:
-      base >= 4.1 && < 4.20
-    , template-haskell
-  default-language: Haskell2010
 
 common warnings
     ghc-options: -Wall
@@ -35,9 +22,9 @@ common common-depends
         bytestring,
         hspec,
         parsec ^>=3.1.16.1,
-        -- force to use my forked version
         x-sum-type-boilerplate,
-        optparse-applicative
+        optparse-applicative,
+        lens
 
 library internallib
     import: common-depends

diff --git a/src/Lib/AST/Model.hs b/src/Lib/AST/Model.hs
@@ -4,9 +4,10 @@
 
 module Lib.AST.Model where
 
+import Control.Lens
 import Data.Text (Text)
 import Lib.AST.Parser (SemVer)
-import SumTypes.TH
+import SumTypesX.TH
 
 keywordLogicalOr :: Text
 keywordLogicalOr = "||"
@@ -81,8 +82,8 @@ data Mapping = Mapping
   deriving (Show, Eq)
 
 data UserDefinedValueTypeDefinition = UserDefinedValueTypeDefinition
-  { userDefinedValueTypeName :: Text,
-    userDefinedValueElemType :: SType
+  { _userDefinedValueTypeName :: Text,
+    _userDefinedValueElemType :: SType
   }
   deriving (Show, Eq)
 
@@ -629,6 +630,8 @@ data SolFile = SolFile
   }
   deriving (Show, Eq)
 
+makeLenses ''UserDefinedValueTypeDefinition
+
 constructSumType
   "SolFileSum"
   defaultSumTypeOptions

diff --git a/src/Lib/AST/Type.hs b/src/Lib/AST/Type.hs
@@ -139,12 +139,7 @@ pTypeDefinition =
 pUserDefinedValueTypeDefinition :: Parser UserDefinedValueTypeDefinition
 pUserDefinedValueTypeDefinition = do
   liftA2
-    ( \ident tp ->
-        UserDefinedValueTypeDefinition
-          { userDefinedValueTypeName = ident,
-            userDefinedValueElemType = tp
-          }
-    )
+    UserDefinedValueTypeDefinition
     ( pManySpaces
         *> pOneKeyword "type"
         *> pMany1Spaces
@@ -157,12 +152,7 @@ pUserDefinedValueTypeDefinition = do
 pTypeStruct :: Parser Structure
 pTypeStruct =
   liftA2
-    ( \ident pairs ->
-        Structure
-          { structName = ident,
-            structFields = pairs
-          }
-    )
+    Structure
     ( pManySpaces
         *> pOneKeyword "struct"
         *> pMany1Spaces

diff --git a/src/Lib/Command.hs b/src/Lib/Command.hs
@@ -1,9 +1,11 @@
 {-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE RecordWildCards #-}
 
 module Lib.Command (executeFile, executeProject) where
 
 import Data.Text (Text, pack, unpack)
 import Lib.AST.File (pWholeSolFile)
+import Lib.AST.Model (ContractDefinition (contractName), SolFile (SolFile, solContracts, solFunctions))
 import Lib.AST.Parser (runSParser)
 import System.Directory (canonicalizePath, doesDirectoryExist, doesFileExist)
 import System.Directory.Internal.Prelude (exitFailure)
@@ -26,7 +28,7 @@ executeFile filepath = do
   fileContent <- pack <$> readFile ensuredPath
   let (re, _) = runSParser (pWholeSolFile ensuredPath) fileContent
   case re of
-    Right file -> print file
+    Right file -> checkFile file
     Left err -> print err >> exitFailure
   return ()
 
@@ -35,3 +37,7 @@ executeProject folderPath = do
   ei <- ensureExist folderPath Folder doesDirectoryExist
   ensuredPath <- either (\err -> print err >> exitFailure) return ei
   print "unsupported faeture for a project"
+
+checkFile :: SolFile -> IO ()
+checkFile SolFile {..} = do
+  foldMap (\c -> putStr "contract definition: " >> (print . contractName) c) solContracts
diff --git a/src/Lib/x-sum-type-boilerplate b/src/Lib/x-sum-type-boilerplate
diff --git a/tests/Lib/AST/TypeSpec.hs b/tests/Lib/AST/TypeSpec.hs
@@ -27,7 +27,7 @@ import Lib.AST.Model
       ),
     STypeEnum (STypeEnum, eelems, ename),
     Structure (Structure, structFields, structName),
-    UserDefinedValueTypeDefinition (UserDefinedValueTypeDefinition, userDefinedValueElemType, userDefinedValueTypeName),
+    UserDefinedValueTypeDefinition (UserDefinedValueTypeDefinition, _userDefinedValueElemType, _userDefinedValueTypeName),
   )
 import Lib.AST.Type
   ( pType,
@@ -305,16 +305,16 @@ parseTypeAliasSpec = do
         [ ( "type Alias1 is uint256;",
             Right $
               UserDefinedValueTypeDefinition
-                { userDefinedValueTypeName = "Alias1",
-                  userDefinedValueElemType = STypeUint 256
+                { _userDefinedValueTypeName = "Alias1",
+                  _userDefinedValueElemType = STypeUint 256
                 },
             ""
           ),
           ( "type _Ab is address;",
             Right $
               UserDefinedValueTypeDefinition
-                { userDefinedValueTypeName = "_Ab",
-                  userDefinedValueElemType = STypeAddress
+                { _userDefinedValueTypeName = "_Ab",
+                  _userDefinedValueElemType = STypeAddress
                 },
             ""
           ),
@@ -406,8 +406,8 @@ parseTypeDifinitionSpec = do
             Right $
               STypeAlias $
                 UserDefinedValueTypeDefinition
-                  { userDefinedValueTypeName = "Alias1",
-                    userDefinedValueElemType = STypeUint 256
+                  { _userDefinedValueTypeName = "Alias1",
+                    _userDefinedValueElemType = STypeUint 256
                   },
             ""
           )