Skip to content

Module Name Plugin: Treat modules starting with lowercase as Main module #616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 2, 2020
Merged

Module Name Plugin: Treat modules starting with lowercase as Main module #616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 73 additions & 96 deletions plugins/default/src/Ide/Plugin/ModuleName.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
{-# OPTIONS_GHC -Wwarn -fno-warn-type-defaults -fno-warn-unused-binds -fno-warn-unused-imports #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE NoMonomorphismRestriction #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE NamedFieldPuns, NoMonomorphismRestriction, OverloadedStrings #-}
{-# LANGUAGE RecordWildCards, ScopedTypeVariables #-}

{-| Keep the module name in sync with its file path.

Expand All @@ -16,84 +13,61 @@ module Ide.Plugin.ModuleName
)
where

import Control.Monad ( join )
import Control.Monad.IO.Class ( MonadIO(liftIO) )
import Control.Monad.Trans.Maybe ( )
import Data.Aeson ( ToJSON(toJSON)
, Value(Null)
)
import qualified Data.HashMap.Strict as Map
import Data.List ( isPrefixOf )
import Data.List.Extra ( replace )
import Data.Maybe ( listToMaybe )
import Data.String ( IsString )
import Data.Text ( Text )
import qualified Data.Text as T
import Development.IDE ( hscEnvWithImportPaths
, GetParsedModule
( GetParsedModule
)
, GhcSession(GhcSession)
, HscEnvEq
, IdeState
, List(..)
, NormalizedFilePath
, Position(Position)
, Range(Range)
, evalGhcEnv
, realSrcSpanToRange
, runAction
, toNormalizedUri
, uriToFilePath'
, use
, use_
)
import Development.IDE.Plugin ( getPid )
import GHC ( DynFlags(importPaths)
, GenLocated(L)
, HsModule(hsmodName)
, ParsedModule(pm_parsed_source)
, SrcSpan(RealSrcSpan)
, unLoc
, getSessionDynFlags
)
import Ide.Types ( CommandFunction
, PluginCommand(..)
, PluginDescriptor(..)
, PluginId(..)
, defaultPluginDescriptor
)
import Language.Haskell.LSP.Core ( LspFuncs
, getVirtualFileFunc
)
import Language.Haskell.LSP.Types ( ApplyWorkspaceEditParams(..)
, CAResult(CACodeAction)
, CodeAction(CodeAction)
, CodeActionKind
( CodeActionQuickFix
)
, CodeLens(CodeLens)
, CodeLensParams(CodeLensParams)
, Command(Command)
, ServerMethod(..)
, TextDocumentIdentifier
( TextDocumentIdentifier
)
, TextEdit(TextEdit)
, Uri
, WorkspaceEdit(..)
, uriToNormalizedFilePath
)
import Language.Haskell.LSP.VFS ( virtualFileText )
import System.FilePath ( splitDirectories
, dropExtension
)
import Ide.Plugin ( mkLspCmdId )
import Development.IDE.Types.Logger
import Development.IDE.Core.Shake
import Data.Text ( pack )
import System.Directory ( canonicalizePath )
import Control.Monad (join)
import Control.Monad.IO.Class (MonadIO (liftIO))
import Control.Monad.Trans.Maybe ()
import Data.Aeson (ToJSON (toJSON), Value (Null))
import Data.Char (isUpper)
import qualified Data.HashMap.Strict as Map
import Data.List
import Data.List (isPrefixOf)
import Data.List.Extra (replace)
import Data.Maybe (listToMaybe)
import Data.String (IsString)
import Data.Text (Text, pack)
import qualified Data.Text as T
import Development.IDE (GetParsedModule (GetParsedModule),
GhcSession (GhcSession),
HscEnvEq, IdeState, List (..),
NormalizedFilePath,
Position (Position),
Range (Range), evalGhcEnv,
hscEnvWithImportPaths,
realSrcSpanToRange, runAction,
toNormalizedUri, uriToFilePath',
use, use_)
import Development.IDE.Core.Shake
import Development.IDE.Plugin (getPid)
import Development.IDE.Types.Logger
import GHC (DynFlags (importPaths),
GenLocated (L),
HsModule (hsmodName),
ParsedModule (pm_parsed_source),
SrcSpan (RealSrcSpan),
getSessionDynFlags, unLoc)
import Ide.Plugin (mkLspCmdId)
import Ide.Types (CommandFunction,
PluginCommand (..),
PluginDescriptor (..),
PluginId (..),
defaultPluginDescriptor)
import Language.Haskell.LSP.Core (LspFuncs, getVirtualFileFunc)
import Language.Haskell.LSP.Types (ApplyWorkspaceEditParams (..),
CAResult (CACodeAction),
CodeAction (CodeAction),
CodeActionKind (CodeActionQuickFix),
CodeLens (CodeLens),
CodeLensParams (CodeLensParams),
Command (Command),
ServerMethod (..),
TextDocumentIdentifier (TextDocumentIdentifier),
TextEdit (TextEdit), Uri,
WorkspaceEdit (..),
uriToNormalizedFilePath)
import Language.Haskell.LSP.VFS (virtualFileText)
import System.Directory (canonicalizePath)
import System.FilePath (dropExtension, splitDirectories,
takeFileName)
-- |Plugin descriptor
descriptor :: PluginId -> PluginDescriptor
descriptor plId = (defaultPluginDescriptor plId)
Expand Down Expand Up @@ -188,20 +162,23 @@ pathModuleName state normFilePath filePath = do
out state ["import paths", show srcPaths]
paths <- mapM canonicalizePath srcPaths
mdlPath <- canonicalizePath filePath
out state ["canonic paths", show paths, "mdlPath", mdlPath]
let maybePrefix = listToMaybe . filter (`isPrefixOf` mdlPath) $ paths
out state ["prefix", show maybePrefix]

let maybeMdlName =
(\prefix ->
intercalate "."
. splitDirectories
. drop (length prefix + 1)
$ dropExtension mdlPath
)
<$> maybePrefix
out state ["mdlName", show maybeMdlName]
return $ T.pack <$> maybeMdlName
if isUpper $ head $ takeFileName mdlPath
then do
out state ["canonic paths", show paths, "mdlPath", mdlPath]
let maybePrefix = listToMaybe . filter (`isPrefixOf` mdlPath) $ paths
out state ["prefix", show maybePrefix]

let maybeMdlName =
(\prefix ->
intercalate "."
. splitDirectories
. drop (length prefix + 1)
$ dropExtension mdlPath
)
<$> maybePrefix
out state ["mdlName", show maybeMdlName]
return $ T.pack <$> maybeMdlName
else return $ Just "Main"

-- | The module name, as stated in the module
codeModuleName :: IdeState -> NormalizedFilePath -> IO (Maybe (Range, Text))
Expand Down
40 changes: 14 additions & 26 deletions test/functional/ModuleName.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,26 @@ module ModuleName
)
where

import Control.Applicative.Combinators
( skipManyTill )
import Control.Monad.IO.Class ( MonadIO(liftIO) )
import qualified Data.Text.IO as T
import Language.Haskell.LSP.Test ( fullCaps
, documentContents
, executeCommand
, getCodeLenses
, openDoc
, runSession
, anyMessage
, message
)
import Language.Haskell.LSP.Types ( ApplyWorkspaceEditRequest
, CodeLens(..)
)
import System.FilePath ( (<.>)
, (</>)
)
import Test.Hls.Util ( hlsCommand )
import Test.Tasty ( TestTree
, testGroup
)
import Test.Tasty.HUnit ( testCase
, (@?=)
)
import Control.Applicative.Combinators (skipManyTill)
import Control.Monad.IO.Class (MonadIO (liftIO))
import qualified Data.Text.IO as T
import Language.Haskell.LSP.Test (anyMessage, documentContents,
executeCommand, fullCaps,
getCodeLenses, message,
openDoc, runSession)
import Language.Haskell.LSP.Types (ApplyWorkspaceEditRequest,
CodeLens (..))
import System.FilePath ((<.>), (</>))
import Test.Hls.Util (hlsCommand)
import Test.Tasty (TestTree, testGroup)
import Test.Tasty.HUnit (testCase, (@?=))

tests :: TestTree
tests = testGroup
"moduleName"
[ testCase "Add module header to empty module" $ goldenTest "TEmptyModule.hs"
, testCase "Fix wrong module name" $ goldenTest "TWrongModuleName.hs"
, testCase "Must infer module name as Main, if the file name starts with a lowercase" $ goldenTest "mainlike.hs"
]

goldenTest :: FilePath -> IO ()
Expand Down
2 changes: 1 addition & 1 deletion test/testdata/moduleName/hie.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
cradle: { direct: { arguments: ["TEmptyModule", "TWrongModuleName"] } }
cradle: { direct: { arguments: ["TEmptyModule", "TWrongModuleName", "mainlike"] } }
Empty file added test/testdata/moduleName/mainlike.hs
View file
Open in desktop
Empty file.
1 change: 1 addition & 0 deletions test/testdata/moduleName/mainlike.hs.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module Main where