diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/hls-explicit-imports-plugin.cabal b/hls-explicit-imports-plugin.cabal new file mode 100644 --- /dev/null +++ b/hls-explicit-imports-plugin.cabal @@ -0,0 +1,31 @@ +cabal-version: 2.2 +name: hls-explicit-imports-plugin +version: 0.1.0.0 +synopsis: Explicit imports plugin for Haskell Language Server +license: Apache-2.0 +license-file: LICENSE +author: Pepe Iborra +maintainer: pepeiborra@gmail.com +category: Development +build-type: Simple +extra-source-files: + LICENSE + include/ghc-api-version.h + +library + exposed-modules: Ide.Plugin.ExplicitImports + hs-source-dirs: src + build-depends: aeson + , base >=4.12 && <5 + , containers + , deepseq + , haskell-lsp-types + , hls-plugin-api + , ghc + , ghcide + , shake + , text + , unordered-containers + + default-language: Haskell2010 + include-dirs: include diff --git a/include/ghc-api-version.h b/include/ghc-api-version.h new file mode 100644 --- /dev/null +++ b/include/ghc-api-version.h @@ -0,0 +1,10 @@ +#ifndef GHC_API_VERSION_H +#define GHC_API_VERSION_H + +#ifdef GHC_LIB +#define MIN_GHC_API_VERSION(x,y,z) MIN_VERSION_ghc_lib(x,y,z) +#else +#define MIN_GHC_API_VERSION(x,y,z) MIN_VERSION_ghc(x,y,z) +#endif + +#endif diff --git a/src/Ide/Plugin/ExplicitImports.hs b/src/Ide/Plugin/ExplicitImports.hs new file mode 100644 --- /dev/null +++ b/src/Ide/Plugin/ExplicitImports.hs @@ -0,0 +1,264 @@ +{-# LANGUAGE CPP #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE DerivingStrategies #-} +{-# LANGUAGE DuplicateRecordFields #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE ViewPatterns #-} + +#include "ghc-api-version.h" + +module Ide.Plugin.ExplicitImports (descriptor) where + +import Control.DeepSeq +import Control.Monad.IO.Class +import Data.Aeson (ToJSON (toJSON), Value (Null)) +import Data.Aeson.Types (FromJSON) +import qualified Data.HashMap.Strict as HashMap +import Data.IORef (readIORef) +import qualified Data.Map.Strict as Map +import Data.Maybe (catMaybes, fromMaybe) +import qualified Data.Text as T +import Development.IDE +import Development.IDE.Core.PositionMapping +import Development.IDE.GHC.Compat +import Development.Shake.Classes +import GHC.Generics (Generic) +import Ide.PluginUtils ( mkLspCommand ) +import Ide.Types +import Language.Haskell.LSP.Types +import PrelNames (pRELUDE) +import RnNames + ( findImportUsage, + getMinimalImports, + ) +import TcRnMonad (initTcWithGbl) +import TcRnTypes (TcGblEnv (tcg_used_gres)) + +importCommandId :: CommandId +importCommandId = "ImportLensCommand" + +-- | The "main" function of a plugin +descriptor :: PluginId -> PluginDescriptor IdeState +descriptor plId = + (defaultPluginDescriptor plId) + { -- This plugin provides code lenses + pluginCodeLensProvider = Just lensProvider, + -- This plugin provides a command handler + pluginCommands = [importLensCommand], + -- This plugin provides code actions + pluginCodeActionProvider = Just codeActionProvider, + -- This plugin defines a new rule + pluginRules = minimalImportsRule + } + +-- | The command descriptor +importLensCommand :: PluginCommand IdeState +importLensCommand = + PluginCommand importCommandId "Explicit import command" runImportCommand + +-- | The type of the parameters accepted by our command +data ImportCommandParams = ImportCommandParams WorkspaceEdit + deriving (Generic) + deriving anyclass (FromJSON, ToJSON) + +-- | The actual command handler +runImportCommand :: CommandFunction IdeState ImportCommandParams +runImportCommand _lspFuncs _state (ImportCommandParams edit) = do + -- This command simply triggers a workspace edit! + return (Right Null, Just (WorkspaceApplyEdit, ApplyWorkspaceEditParams edit)) + +-- | For every implicit import statement, return a code lens of the corresponding explicit import +-- Example - for the module below: +-- +-- > import Data.List +-- > +-- > f = intercalate " " . sortBy length +-- +-- the provider should produce one code lens associated to the import statement: +-- +-- > import Data.List (intercalate, sortBy) +lensProvider :: CodeLensProvider IdeState +lensProvider + _lspFuncs -- LSP functions, not used + state -- ghcide state, used to retrieve typechecking artifacts + pId -- plugin Id + CodeLensParams {_textDocument = TextDocumentIdentifier {_uri}} + -- VSCode uses URIs instead of file paths + -- haskell-lsp provides conversion functions + | Just nfp <- uriToNormalizedFilePath $ toNormalizedUri _uri = + do + mbMinImports <- runAction "" state $ useWithStale MinimalImports nfp + case mbMinImports of + -- Implement the provider logic: + -- for every import, if it's lacking a explicit list, generate a code lens + Just (MinimalImportsResult minImports, posMapping) -> do + commands <- + sequence + [ generateLens pId _uri edit + | (imp, Just minImport) <- minImports, + Just edit <- [mkExplicitEdit posMapping imp minImport] + ] + return $ Right (List $ catMaybes commands) + _ -> + return $ Right (List []) + | otherwise = + return $ Right (List []) + +-- | If there are any implicit imports, provide one code action to turn them all +-- into explicit imports. +codeActionProvider :: CodeActionProvider IdeState +codeActionProvider _lspFuncs ideState _pId docId range _context + | TextDocumentIdentifier {_uri} <- docId, + Just nfp <- uriToNormalizedFilePath $ toNormalizedUri _uri = + do + pm <- runIde ideState $ use GetParsedModule nfp + let insideImport = case pm of + Just ParsedModule {pm_parsed_source} + | locImports <- hsmodImports (unLoc pm_parsed_source), + rangesImports <- map getLoc locImports -> + any (within range) rangesImports + _ -> False + if not insideImport + then return (Right (List [])) + else do + minImports <- runAction "MinimalImports" ideState $ use MinimalImports nfp + let edits = + [ e + | (imp, Just explicit) <- + maybe [] getMinimalImportsResult minImports, + Just e <- [mkExplicitEdit zeroMapping imp explicit] + ] + caExplicitImports = CACodeAction CodeAction {..} + _title = "Make all imports explicit" + _kind = Just CodeActionQuickFix + _command = Nothing + _edit = Just WorkspaceEdit {_changes, _documentChanges} + _changes = Just $ HashMap.singleton _uri $ List edits + _documentChanges = Nothing + _diagnostics = Nothing + return $ Right $ List [caExplicitImports | not (null edits)] + | otherwise = + return $ Right $ List [] + +-------------------------------------------------------------------------------- + +data MinimalImports = MinimalImports + deriving (Show, Generic, Eq, Ord) + +instance Hashable MinimalImports + +instance NFData MinimalImports + +instance Binary MinimalImports + +type instance RuleResult MinimalImports = MinimalImportsResult + +newtype MinimalImportsResult = MinimalImportsResult + {getMinimalImportsResult :: [(LImportDecl GhcRn, Maybe T.Text)]} + +instance Show MinimalImportsResult where show _ = "" + +instance NFData MinimalImportsResult where rnf = rwhnf + +minimalImportsRule :: Rules () +minimalImportsRule = define $ \MinimalImports nfp -> do + -- Get the typechecking artifacts from the module + tmr <- use TypeCheck nfp + -- We also need a GHC session with all the dependencies + hsc <- use GhcSessionDeps nfp + -- Use the GHC api to extract the "minimal" imports + (imports, mbMinImports) <- liftIO $ extractMinimalImports hsc tmr + let importsMap = + Map.fromList + [ (srcSpanStart l, T.pack (prettyPrint i)) + | L l i <- fromMaybe [] mbMinImports + ] + res = + [ (i, Map.lookup (srcSpanStart (getLoc i)) importsMap) + | i <- imports + ] + return ([], MinimalImportsResult res <$ mbMinImports) + +-------------------------------------------------------------------------------- + +-- | Use the ghc api to extract a minimal, explicit set of imports for this module +extractMinimalImports :: + Maybe (HscEnvEq) -> + Maybe (TcModuleResult) -> + IO ([LImportDecl GhcRn], Maybe [LImportDecl GhcRn]) +extractMinimalImports (Just (hsc)) (Just (TcModuleResult {..})) = do + -- extract the original imports and the typechecking environment + let tcEnv = tmrTypechecked + (_, imports, _, _) = tmrRenamed + ParsedModule {pm_parsed_source = L loc _} = tmrParsed + span = fromMaybe (error "expected real") $ realSpan loc + + -- GHC is secretly full of mutable state + gblElts <- readIORef (tcg_used_gres tcEnv) + + -- call findImportUsage does exactly what we need + -- GHC is full of treats like this + let usage = findImportUsage imports gblElts + (_, minimalImports) <- initTcWithGbl (hscEnv hsc) tcEnv span $ getMinimalImports usage + + -- return both the original imports and the computed minimal ones + return (imports, minimalImports) +extractMinimalImports _ _ = return ([], Nothing) + +mkExplicitEdit :: PositionMapping -> LImportDecl pass -> T.Text -> Maybe TextEdit +mkExplicitEdit posMapping (L src imp) explicit + -- Explicit import list case + | ImportDecl {ideclHiding = Just (False, _)} <- imp = + Nothing + | not (isQualifiedImport imp), + RealSrcSpan l <- src, + L _ mn <- ideclName imp, + -- (almost) no one wants to see an explicit import list for Prelude + mn /= moduleName pRELUDE, + Just rng <- toCurrentRange posMapping $ realSrcSpanToRange l = + Just $ TextEdit rng explicit + | otherwise = + Nothing + +-- | Given an import declaration, generate a code lens unless it has an +-- explicit import list or it's qualified +generateLens :: PluginId -> Uri -> TextEdit -> IO (Maybe CodeLens) +generateLens pId uri importEdit@TextEdit {_range} = do + -- The title of the command is just the minimal explicit import decl + let title = _newText importEdit + -- the code lens has no extra data + _xdata = Nothing + -- an edit that replaces the whole declaration with the explicit one + edit = WorkspaceEdit (Just editsMap) Nothing + editsMap = HashMap.fromList [(uri, List [importEdit])] + -- the command argument is simply the edit + _arguments = Just [toJSON $ ImportCommandParams edit] + -- create the command + _command <- Just <$> mkLspCommand pId importCommandId title _arguments + -- create and return the code lens + return $ Just CodeLens {..} + +-- | A helper to run ide actions +runIde :: IdeState -> Action a -> IO a +runIde state = runAction "importLens" state + +-------------------------------------------------------------------------------- + +isQualifiedImport :: ImportDecl a -> Bool +#if MIN_GHC_API_VERSION(8,10,0) +isQualifiedImport ImportDecl{ideclQualified = NotQualified} = False +isQualifiedImport ImportDecl{} = True +#else +isQualifiedImport ImportDecl{ideclQualified} = ideclQualified +#endif +isQualifiedImport _ = False + +within :: Range -> SrcSpan -> Bool +within (Range start end) span = + isInsideSrcSpan start span || isInsideSrcSpan end span