hls-module-name-plugin (empty) → 1.0.0.0
raw patch · 11 files changed
+454/−0 lines, 11 filesdep +aesondep +basedep +directory
Dependencies added: aeson, base, directory, filepath, ghcide, hls-module-name-plugin, hls-plugin-api, hls-test-utils, lsp, text, transformers, unordered-containers
Files
- LICENSE +201/−0
- hls-module-name-plugin.cabal +47/−0
- src/Ide/Plugin/ModuleName.hs +139/−0
- test/Main.hs +41/−0
- test/testdata/TEmptyModule.expected.hs +3/−0
- test/testdata/TEmptyModule.hs +2/−0
- test/testdata/TWrongModuleName.expected.hs +7/−0
- test/testdata/TWrongModuleName.hs +7/−0
- test/testdata/hie.yaml +6/−0
- test/testdata/mainlike.expected.hs +1/−0
- test/testdata/mainlike.hs +0/−0
+ LICENSE view
@@ -0,0 +1,201 @@+ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright [yyyy] [name of copyright owner]++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ hls-module-name-plugin.cabal view
@@ -0,0 +1,47 @@+cabal-version: 2.4+name: hls-module-name-plugin+version: 1.0.0.0+synopsis: Module name plugin for Haskell Language Server+description:+ Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>++license: Apache-2.0+license-file: LICENSE+author: The Haskell IDE Team+copyright: The Haskell IDE Team+maintainer: alan.zimm@gmail.com+category: Development+build-type: Simple+extra-source-files:+ LICENSE+ test/testdata/*.hs+ test/testdata/*.yaml++library+ exposed-modules: Ide.Plugin.ModuleName+ hs-source-dirs: src+ build-depends:+ , aeson+ , base >=4.12 && <5+ , directory+ , filepath+ , ghcide >=1.2 && <1.5+ , hls-plugin-api ^>=1.1+ , lsp+ , text+ , transformers+ , unordered-containers++ default-language: Haskell2010++test-suite tests+ type: exitcode-stdio-1.0+ default-language: Haskell2010+ hs-source-dirs: test+ main-is: Main.hs+ ghc-options: -threaded -rtsopts -with-rtsopts=-N+ build-depends:+ , base+ , filepath+ , hls-module-name-plugin+ , hls-test-utils ^>=1.0
+ src/Ide/Plugin/ModuleName.hs view
@@ -0,0 +1,139 @@+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE PatternSynonyms #-}+{-# LANGUAGE RecordWildCards #-}+{-# OPTIONS_GHC -Wall -Wwarn -fno-warn-type-defaults #-}++{- | Keep the module name in sync with its file path.++Provide CodeLenses to:+* Add a module header ("module /moduleName/ where") to empty Haskell files+* Fix the module name if incorrect+-}+module Ide.Plugin.ModuleName (+ descriptor,+) where++import Control.Monad (forM_, void)+import Control.Monad.IO.Class (liftIO)+import Control.Monad.Trans.Class (lift)+import Control.Monad.Trans.Maybe+import Data.Aeson (Value (Null), toJSON)+import Data.Char (isLower)+import qualified Data.HashMap.Strict as HashMap+import Data.List (find, intercalate, isPrefixOf)+import Data.Maybe (maybeToList)+import Data.String (IsString)+import qualified Data.Text as T+import Development.IDE (GetParsedModule (GetParsedModule),+ GhcSession (GhcSession), IdeState,+ evalGhcEnv, hscEnvWithImportPaths,+ realSrcSpanToRange, runAction,+ uriToFilePath', use, use_)+import Development.IDE.GHC.Compat (GenLocated (L), getSessionDynFlags,+ hsmodName, importPaths,+ pattern OldRealSrcSpan,+ pm_parsed_source, unLoc)+import Ide.Types+import Language.LSP.Server+import Language.LSP.Types+import Language.LSP.VFS (virtualFileText)+import System.Directory (canonicalizePath)+import System.FilePath (dropExtension, splitDirectories,+ takeFileName)++-- |Plugin descriptor+descriptor :: PluginId -> PluginDescriptor IdeState+descriptor plId =+ (defaultPluginDescriptor plId)+ { pluginHandlers = mkPluginHandler STextDocumentCodeLens codeLens+ , pluginCommands = [PluginCommand updateModuleNameCommand "set name of module to match with file path" command]+ }++updateModuleNameCommand :: IsString p => p+updateModuleNameCommand = "updateModuleName"++-- | Generate code lenses+codeLens :: PluginMethodHandler IdeState 'TextDocumentCodeLens+codeLens state pluginId CodeLensParams{_textDocument=TextDocumentIdentifier uri} =+ Right . List . maybeToList . (asCodeLens <$>) <$> action state uri+ where+ asCodeLens :: Action -> CodeLens+ asCodeLens Replace{..} = CodeLens aRange (Just cmd) Nothing+ where+ cmd = mkLspCommand pluginId updateModuleNameCommand aTitle (Just [toJSON aUri])++-- | (Quasi) Idempotent command execution: recalculate action to execute on command request+command :: CommandFunction IdeState Uri+command state uri = do+ actMaybe <- action state uri+ forM_ actMaybe $ \Replace{..} ->+ let+ -- | Convert an Action to the corresponding edit operation+ edit = WorkspaceEdit (Just . HashMap.singleton aUri $ List [TextEdit aRange aCode]) Nothing Nothing+ in+ void $ sendRequest SWorkspaceApplyEdit (ApplyWorkspaceEditParams Nothing edit) (const (pure ()))+ pure $ Right Null++-- | A source code change+data Action = Replace+ { aUri :: Uri+ , aRange :: Range+ , aTitle :: T.Text+ , aCode :: T.Text+ }+ deriving (Show)++-- | Required action (that can be converted to either CodeLenses or CodeActions)+action :: IdeState -> Uri -> LspM c (Maybe Action)+action state uri =+ traceAs "action" <$> runMaybeT $ do+ nfp <- MaybeT . pure . uriToNormalizedFilePath $ toNormalizedUri uri+ fp <- MaybeT . pure $ uriToFilePath' uri++ contents <- lift . getVirtualFile $ toNormalizedUri uri+ let emptyModule = maybe True (T.null . T.strip . virtualFileText) contents++ correctName <- MaybeT . liftIO $ traceAs "correctName" <$> pathModuleName state nfp fp++ statedNameMaybe <- liftIO $ traceAs "statedName" <$> codeModuleName state nfp+ case statedNameMaybe of+ Just (nameRange, statedName)+ | correctName /= statedName ->+ pure $ Replace uri nameRange ("Set module name to " <> correctName) correctName+ Nothing+ | emptyModule ->+ let code = "module " <> correctName <> " where\n"+ in pure $ Replace uri (Range (Position 0 0) (Position 0 0)) code code+ _ -> MaybeT $ pure Nothing++-- | The module name, as derived by the position of the module in its source directory+pathModuleName :: IdeState -> NormalizedFilePath -> String -> IO (Maybe T.Text)+pathModuleName state normFilePath filePath+ | isLower . head $ takeFileName filePath = return $ Just "Main"+ | otherwise = do+ session <- runAction "ModuleName.ghcSession" state $ use_ GhcSession normFilePath+ srcPaths <- evalGhcEnv (hscEnvWithImportPaths session) $ importPaths <$> getSessionDynFlags+ paths <- mapM canonicalizePath srcPaths+ mdlPath <- canonicalizePath filePath+ pure $ do+ prefix <- find (`isPrefixOf` mdlPath) paths+ pure+ . T.pack+ . intercalate "."+ . splitDirectories+ . drop (length prefix + 1)+ $ dropExtension mdlPath++-- | The module name, as stated in the module+codeModuleName :: IdeState -> NormalizedFilePath -> IO (Maybe (Range, T.Text))+codeModuleName state nfp = runMaybeT $ do+ pm <- MaybeT . runAction "ModuleName.GetParsedModule" state $ use GetParsedModule nfp+ L (OldRealSrcSpan l) m <- MaybeT . pure . hsmodName . unLoc $ pm_parsed_source pm+ pure (realSrcSpanToRange l, T.pack $ show m)++-- traceAs :: Show a => String -> a -> a+-- traceAs lbl a = trace (lbl ++ " = " ++ show a) a++traceAs :: b -> a -> a+traceAs _ a = a
+ test/Main.hs view
@@ -0,0 +1,41 @@+{-# LANGUAGE DuplicateRecordFields #-}+{-# LANGUAGE OverloadedStrings #-}+module Main+ ( main+ ) where++import Control.Monad (void)+import qualified Ide.Plugin.ModuleName as ModuleName+import System.FilePath+import Test.Hls++main :: IO ()+main = defaultTestRunner tests++moduleNamePlugin :: PluginDescriptor IdeState+moduleNamePlugin = ModuleName.descriptor "moduleName"++tests :: TestTree+tests =+ testGroup "moduleName"+ [ goldenWithModuleName "Add module header to empty module" "TEmptyModule" $ \doc -> do+ [CodeLens { _command = Just c }] <- getCodeLenses doc+ executeCommand c+ void $ skipManyTill anyMessage (message SWorkspaceApplyEdit)++ , goldenWithModuleName "Fix wrong module name" "TWrongModuleName" $ \doc -> do+ [CodeLens { _command = Just c }] <- getCodeLenses doc+ executeCommand c+ void $ skipManyTill anyMessage (message SWorkspaceApplyEdit)++ , goldenWithModuleName "Must infer module name as Main, if the file name starts with a lowercase" "mainlike" $ \doc -> do+ [CodeLens { _command = Just c }] <- getCodeLenses doc+ executeCommand c+ void $ skipManyTill anyMessage (message SWorkspaceApplyEdit)+ ]++goldenWithModuleName :: TestName -> FilePath -> (TextDocumentIdentifier -> Session ()) -> TestTree+goldenWithModuleName title path = goldenWithHaskellDoc moduleNamePlugin title testDataDir path "expected" "hs"++testDataDir :: FilePath+testDataDir = "test" </> "testdata"
+ test/testdata/TEmptyModule.expected.hs view
@@ -0,0 +1,3 @@+module TEmptyModule where++
+ test/testdata/TEmptyModule.hs view
@@ -0,0 +1,2 @@++
+ test/testdata/TWrongModuleName.expected.hs view
@@ -0,0 +1,7 @@+module TWrongModuleName+ ( x+ )+where++x :: Integer+x = 11
+ test/testdata/TWrongModuleName.hs view
@@ -0,0 +1,7 @@+module BadName+ ( x+ )+where++x :: Integer+x = 11
+ test/testdata/hie.yaml view
@@ -0,0 +1,6 @@+cradle:+ direct:+ arguments:+ - "TEmptyModule"+ - "TWrongModuleName"+ - "mainlike"
+ test/testdata/mainlike.expected.hs view
@@ -0,0 +1,1 @@+module Main where
+ test/testdata/mainlike.hs view