diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,13 @@ +Change log +========== + +smuggler uses [PVP Versioning][1]. +The change log is available [on GitHub][2]. + +0.0.0 +===== +* Initially created. + +[1]: https://pvp.haskell.org +[2]: https://github.com/kowainik/smuggler/releases + diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# smuggler + +[![Hackage](https://img.shields.io/hackage/v/smuggler.svg)](https://hackage.haskell.org/package/smuggler) +[![Build status](https://secure.travis-ci.org/kowainik/smuggler.svg)](https://travis-ci.org/kowainik/smuggler) +[![MPL-2.0 license](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](https://github.com/kowainik/smuggler/blob/master/LICENSE) + +Haskell Compiler Plugin which removes unused imports automatically. + +## Build instructions + +Requirements: + +* `ghc >= ghc-8.6.1-alpha2` + +### Build project + +```shell +$ cabal new-update +$ cabal new-build --allow-newer +``` + +### Run tests + +```shell +$ cabal new-test --allow-newer +``` diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/app/Main.hs b/app/Main.hs new file mode 100644 --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,12 @@ +module Main where + +import Data.Bool (Bool (False, True), bool) +import Data.List (sort) +import Data.Maybe (fromMaybe, maybe) + +main :: IO () +main = do + let foo = fromMaybe bool Nothing + print $ (foo undefined undefined undefined :: Int) + print True +-- main = parseFile diff --git a/smuggler.cabal b/smuggler.cabal new file mode 100644 --- /dev/null +++ b/smuggler.cabal @@ -0,0 +1,104 @@ +name: smuggler +version: 0.0.0 +synopsis: Smuggling +description: GHC compiler plugin which helps to manage imports +homepage: https://github.com/kowainik/smuggler +bug-reports: https://github.com/kowainik/smuggler/issues +license: MPL-2.0 +license-file: LICENSE +author: Kowainik +maintainer: xrom.xkov@gmail.com +copyright: 2018 Kowainik +category: Development, Refactoring +build-type: Simple +extra-doc-files: README.md + , CHANGELOG.md +cabal-version: 2.0 +tested-with: GHC == 8.6.1 + +source-repository head + type: git + location: git@github.com:kowainik/smuggler.git + +library + hs-source-dirs: src + exposed-modules: Smuggler.Anns + Smuggler.Loc + Smuggler.Parser + Smuggler.Plugin +-- Smuggler.Debug +-- Smuggler.Import +-- Smuggler.Name + + build-depends: base >= 4.9 && < 5 + , bytestring >= 0.10 + , containers >= 0.5 + , filepath >= 1.4 + , ghc >= 8.6.0 + , ghc-exactprint >= 0.5.7.0 + , hash-store >= 0.1.0 + , unordered-containers >= 0.2.7 + + -- Debug dependencies; in separate section to easy comment before release +-- , fmt +-- , pretty-simple +-- , text + + ghc-options: -Wall + default-extensions: DeriveGeneric + GeneralizedNewtypeDeriving + InstanceSigs + LambdaCase + OverloadedStrings + RecordWildCards + ScopedTypeVariables + StandaloneDeriving + + default-language: Haskell2010 + +executable smuggler + hs-source-dirs: app + main-is: Main.hs + ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N + -fplugin=Smuggler.Plugin + build-depends: base + , smuggler + + default-extensions: DeriveGeneric + GeneralizedNewtypeDeriving + InstanceSigs + LambdaCase + OverloadedStrings + RecordWildCards + + default-language: Haskell2010 + +test-suite smuggler-test + type: exitcode-stdio-1.0 + hs-source-dirs: test + + main-is: Test.hs + other-modules: Test.BoolBoolUsed + Test.BoolBoolUnused + Test.BoolPartlyUsedFirst + Test.BoolPartlyUsedLast + Test.Dummy + Test.ImportEmpty + Test.MultilineUnused + Test.TypeConstructorUsed + Test.TypeConstructorUnused + Test.TypeUnused + Test.TypeUsed + + build-depends: base + , directory + , filepath + , smuggler + + ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N + -fno-warn-unused-imports + -fno-warn-missing-signatures + -fhide-source-paths + -fplugin=Smuggler.Plugin + -fplugin-opt=Smuggler.Plugin:test + default-language: Haskell2010 diff --git a/src/Smuggler/Anns.hs b/src/Smuggler/Anns.hs new file mode 100644 --- /dev/null +++ b/src/Smuggler/Anns.hs @@ -0,0 +1,16 @@ +module Smuggler.Anns + ( removeAnnAtLoc + ) where + +import Language.Haskell.GHC.ExactPrint (AnnKey (..), Anns) +import SrcLoc (SrcSpan (RealSrcSpan), srcSpanStartCol, srcSpanStartLine) + +import qualified Data.Map.Strict as Map + +removeAnnAtLoc :: Int -> Int -> Anns -> Anns +removeAnnAtLoc line col = Map.filterWithKey (\k _ -> matchKey k) + where + matchKey :: AnnKey -> Bool + matchKey (AnnKey (RealSrcSpan rss) _) = + not (srcSpanStartLine rss == line && srcSpanStartCol rss == col) + matchKey _ = True diff --git a/src/Smuggler/Loc.hs b/src/Smuggler/Loc.hs new file mode 100644 --- /dev/null +++ b/src/Smuggler/Loc.hs @@ -0,0 +1,21 @@ +module Smuggler.Loc + ( showLoc + , showL + , unL + ) where + +import SrcLoc (GenLocated (L), Located, SrcSpan (RealSrcSpan), srcSpanStartCol, srcSpanStartLine, + unLoc) + +-- | Returns location in the way of @line:col@. +showLoc :: SrcSpan -> String +showLoc (RealSrcSpan r) = show (srcSpanStartLine r) ++ ":" ++ show (srcSpanStartCol r) +showLoc loc = show loc + +-- | Shows 'Located' in brackets. +showL :: String -> (a -> String) -> Located a -> String +showL name showA (L l nm) = "(" ++ showLoc l ++ name ++ showA nm ++ ")" + +-- | Shorter synonim for 'unLoc'. +unL :: GenLocated l e -> e +unL = unLoc diff --git a/src/Smuggler/Parser.hs b/src/Smuggler/Parser.hs new file mode 100644 --- /dev/null +++ b/src/Smuggler/Parser.hs @@ -0,0 +1,21 @@ +module Smuggler.Parser + ( runParser + ) where + +import Language.Haskell.GHC.ExactPrint (Anns, parseModule) + +import HsExtension (GhcPs) +import HsSyn (HsModule (..)) +import SrcLoc (Located) + +runParser :: FilePath -> IO (Either () (Anns, Located (HsModule GhcPs))) +runParser fileName = do + res <- parseModule fileName + pure $ case res of + Left (_srcSpan, _str) -> Left () + Right x -> Right x + +-- newtype ParseException = ParseException String +-- deriving (Show) +-- +-- instance Exception ParseException diff --git a/src/Smuggler/Plugin.hs b/src/Smuggler/Plugin.hs new file mode 100644 --- /dev/null +++ b/src/Smuggler/Plugin.hs @@ -0,0 +1,125 @@ +{-# LANGUAGE TupleSections #-} + +module Smuggler.Plugin + ( plugin + ) where + +import Control.Monad (guard, void) +import Control.Monad.IO.Class (MonadIO (..)) +import Data.ByteString (ByteString) +import Data.List (foldl') +import HashStore (hashStore) +import Language.Haskell.GHC.ExactPrint (exactPrint) +import System.FilePath ((-<.>)) + +import HscTypes (ModSummary (..)) +import HsExtension (GhcRn) +import HsImpExp (IE (..), IEWrappedName (..), ImportDecl (..), LIE, LIEWrappedName) +import IOEnv (readMutVar) +import Name (Name) +import Plugins (CommandLineOption, Plugin (..), defaultPlugin) +import PrelNames (pRELUDE_NAME) +import RdrName (GlobalRdrElt) +import RnNames (ImportDeclUsage, findImportUsage) +import SrcLoc (GenLocated (..), SrcSpan (..), srcSpanEndLine, srcSpanStartCol, srcSpanStartLine, + unLoc) +import TcRnTypes (TcGblEnv (..), TcM) + +import Smuggler.Anns (removeAnnAtLoc) +import Smuggler.Parser (runParser) + +import qualified Data.ByteString as BS + +plugin :: Plugin +plugin = defaultPlugin { typeCheckResultAction = smugglerPlugin } + +cacheDir :: FilePath +cacheDir = ".smuggler" + +munglePath :: FilePath -> FilePath +munglePath = \case + [] -> [] + '/' : xs -> '.' : munglePath xs + c : xs -> c : munglePath xs + +smugglerPlugin :: [CommandLineOption] -> ModSummary -> TcGblEnv -> TcM TcGblEnv +smugglerPlugin clis modSummary tcEnv = do + let modulePath = ms_hspp_file modSummary + + uses <- readMutVar (tcg_used_gres tcEnv) + fileContent <- liftIO $ BS.readFile modulePath + let modifiedName = munglePath modulePath + + liftIO $ void $ hashStore cacheDir + (smuggling uses modulePath) + (modifiedName, fileContent) + + pure tcEnv + where + smuggling :: [GlobalRdrElt] -> FilePath -> ByteString -> IO ByteString + smuggling uses modulePath _ = do + -- 1. Parse given file + runParser modulePath >>= \case -- TODO: don't read file, use given ByteString + Left () -> pure () -- do nothing if file is invalid Haskell + Right (anns, ast) -> do + -- 2. find positions of unused imports + let user_imports = filter (not . ideclImplicit . unLoc) (tcg_rn_imports tcEnv) + let usage = findImportUsage user_imports uses + let unusedPositions = concatMap unusedLocs usage + + -- 3. Remove positions of unused imports from annotations. + let purifiedAnnotations = foldl' (\ann (x, y) -> removeAnnAtLoc x y ann) anns unusedPositions + let newContent = exactPrint ast purifiedAnnotations + case clis of + [] -> putStrLn newContent + (ext:_) -> writeFile (modulePath -<.> ext) newContent + -- 4. Return empty ByteString + pure "" + +unusedLocs ::ImportDeclUsage -> [(Int, Int)] +unusedLocs (L (UnhelpfulSpan _) _, _, _) = [] +unusedLocs (L (RealSrcSpan loc) decl, used, unused) + -- Do not remove `import M ()` + | Just (False, L _ []) <- ideclHiding decl + = [] + + -- Note [Do not warn about Prelude hiding] + -- TODO: add ability to support custom prelude + | Just (True, L _ hides) <- ideclHiding decl + , not (null hides) + , pRELUDE_NAME == unLoc (ideclName decl) + = [] + + -- Nothing used; drop entire decl + -- TODO: optimize + | null used = [ (lineNum, colNum) + | lineNum <- [srcSpanStartLine loc .. srcSpanEndLine loc] + , colNum <- [1..100] + ] + + -- Everything imported is used; drop nothing + | null unused = [] + + -- only part of non-hiding import is used + | Just (False, L _ lies) <- ideclHiding decl + = unusedLies lies + + -- TODO: unused hidings + | otherwise = [] + where + unusedLies :: [LIE GhcRn] -> [(Int, Int)] + unusedLies = concatMap lieToLoc + + lieToLoc :: LIE GhcRn -> [(Int, Int)] + lieToLoc (L _ lie) = case lie of + IEVar _ name -> lieNameToLoc name + IEThingAbs _ name -> lieNameToLoc name + IEThingAll _ name -> lieNameToLoc name + IEThingWith _ name _ names _ -> concatMap lieNameToLoc (name : names) + _ -> [] + + lieNameToLoc :: LIEWrappedName Name -> [(Int, Int)] + lieNameToLoc lieName = do + L _ (IEName (L (RealSrcSpan lieLoc) name)) <- [lieName] + guard $ name `elem` unused + pure (srcSpanStartLine lieLoc, srcSpanStartCol lieLoc) diff --git a/test/Test.hs b/test/Test.hs new file mode 100644 --- /dev/null +++ b/test/Test.hs @@ -0,0 +1,33 @@ +module Main where + +import Data.Foldable (for_) +import System.Directory (listDirectory, removeDirectoryRecursive, removeFile) +import System.Exit (exitFailure) +import System.FilePath (isExtensionOf, splitExtension, (<.>), ()) + +main :: IO () +main = do + files <- map ("test/Test" ) <$> listDirectory "test/Test/" + let testFiles = filter ("test" `isExtensionOf`) files + -- compare outputs of .test and .golden files + result <- traverse compareWithGolden testFiles >>= pure . foldr (&&) True + + + -- clean up all .test files + putStrLn "Cleaning tests" + for_ testFiles removeFile + + -- clean up .smuggler/ cache directory + putStrLn "Cleaning smuggler cache" + removeDirectoryRecursive ".smuggler" + + if result + then putStrLn "Success" + else putStrLn "Fail" >> exitFailure + where + compareWithGolden :: FilePath -> IO Bool + compareWithGolden f = do + let (name, _) = splitExtension f + goldenContent <- readFile $ name <.> "golden" + testContent <- readFile f + pure $ goldenContent == testContent diff --git a/test/Test/BoolBoolUnused.hs b/test/Test/BoolBoolUnused.hs new file mode 100644 --- /dev/null +++ b/test/Test/BoolBoolUnused.hs @@ -0,0 +1,3 @@ +module Test.BoolBoolUnused where + +import Data.Bool (bool) diff --git a/test/Test/BoolBoolUsed.hs b/test/Test/BoolBoolUsed.hs new file mode 100644 --- /dev/null +++ b/test/Test/BoolBoolUsed.hs @@ -0,0 +1,5 @@ +module Test.BoolBoolUsed where + +import Data.Bool (bool) + +func = bool diff --git a/test/Test/BoolPartlyUsedFirst.hs b/test/Test/BoolPartlyUsedFirst.hs new file mode 100644 --- /dev/null +++ b/test/Test/BoolPartlyUsedFirst.hs @@ -0,0 +1,5 @@ +module Test.BoolPartlyUsedFirst where + +import Data.Bool (bool, not) + +foo = bool diff --git a/test/Test/BoolPartlyUsedLast.hs b/test/Test/BoolPartlyUsedLast.hs new file mode 100644 --- /dev/null +++ b/test/Test/BoolPartlyUsedLast.hs @@ -0,0 +1,5 @@ +module Test.BoolPartlyUsedLast where + +import Data.Bool (bool, not) + +foo = not diff --git a/test/Test/Dummy.hs b/test/Test/Dummy.hs new file mode 100644 --- /dev/null +++ b/test/Test/Dummy.hs @@ -0,0 +1,4 @@ +module Test.Dummy where + +main :: IO () +main = pure () diff --git a/test/Test/ImportEmpty.hs b/test/Test/ImportEmpty.hs new file mode 100644 --- /dev/null +++ b/test/Test/ImportEmpty.hs @@ -0,0 +1,3 @@ +module Test.ImportEmpty where + +import Data.Bool () diff --git a/test/Test/MultilineUnused.hs b/test/Test/MultilineUnused.hs new file mode 100644 --- /dev/null +++ b/test/Test/MultilineUnused.hs @@ -0,0 +1,10 @@ +module Test.MultilineUnused where + +import Data.Bool (bool) +import Data.List (break, cycle, drop, dropWhile, filter, genericDrop, genericLength, + genericReplicate, genericSplitAt, genericTake, group, inits, intercalate, + intersperse, isPrefixOf, iterate, map, permutations, repeat, replicate, reverse, + scanl, scanr, sort, sortBy, sortOn, splitAt, subsequences, tails, take, takeWhile, + transpose, unfoldr, unzip, unzip3, zip, zip3, zipWith, (++)) + +foo = bool diff --git a/test/Test/TypeConstructorUnused.hs b/test/Test/TypeConstructorUnused.hs new file mode 100644 --- /dev/null +++ b/test/Test/TypeConstructorUnused.hs @@ -0,0 +1,5 @@ +module Test.TypeConstructorUnused where + +import Data.Bool (Bool (False, True)) + +true = True diff --git a/test/Test/TypeConstructorUsed.hs b/test/Test/TypeConstructorUsed.hs new file mode 100644 --- /dev/null +++ b/test/Test/TypeConstructorUsed.hs @@ -0,0 +1,5 @@ +module Test.TypeConstructorUsed where + +import Data.Bool (Bool (True)) + +true = True diff --git a/test/Test/TypeUnused.hs b/test/Test/TypeUnused.hs new file mode 100644 --- /dev/null +++ b/test/Test/TypeUnused.hs @@ -0,0 +1,5 @@ +module Test.TypeUnused where + +import Data.Bool (Bool, not) + +foo = not diff --git a/test/Test/TypeUsed.hs b/test/Test/TypeUsed.hs new file mode 100644 --- /dev/null +++ b/test/Test/TypeUsed.hs @@ -0,0 +1,6 @@ +module Test.TypeUsed where + +import Data.Bool (Bool, not) + +foo :: Bool +foo = undefined