diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 3b394f74dc..714be66cc6 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -170,6 +170,10 @@ jobs: name: Test hls-stylish-haskell-plugin run: cabal test hls-stylish-haskell-plugin --test-options="-j1 --rerun-update" || cabal test hls-stylish-haskell-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-stylish-haskell-plugin --test-options="-j1 --rerun" + - if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }} + name: Test hls-fourmolu-plugin + run: cabal test hls-fourmolu-plugin --test-options="-j1 --rerun-update" || cabal test hls-fourmolu-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-fourmolu-plugin --test-options="-j1 --rerun" + - if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }} name: Test hls-tactics-plugin test suite run: cabal test hls-tactics-plugin --test-options="-j1 --rerun-update" || cabal test hls-tactics-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-tactics-plugin --test-options="-j1 --rerun" diff --git a/cabal.project b/cabal.project index 2648934145..b6666ff273 100644 --- a/cabal.project +++ b/cabal.project @@ -9,6 +9,7 @@ packages: ./plugins/hls-tactics-plugin ./plugins/hls-brittany-plugin ./plugins/hls-stylish-haskell-plugin + ./plugins/hls-fourmolu-plugin ./plugins/hls-class-plugin ./plugins/hls-eval-plugin ./plugins/hls-explicit-imports-plugin diff --git a/haskell-language-server.cabal b/haskell-language-server.cabal index d6f842fc60..8f82ad05a0 100644 --- a/haskell-language-server.cabal +++ b/haskell-language-server.cabal @@ -256,9 +256,7 @@ common floskell common fourmolu if flag(fourmolu) || flag(all-formatters) - hs-source-dirs: plugins/default/src - other-modules: Ide.Plugin.Fourmolu - build-depends: fourmolu ^>=0.3 + build-depends: hls-fourmolu-plugin ^>= 1.0.0.0 cpp-options: -Dfourmolu common ormolu diff --git a/nix/default.nix b/nix/default.nix index 37c8290c49..9e2f0a92c1 100644 --- a/nix/default.nix +++ b/nix/default.nix @@ -32,6 +32,7 @@ let hls-test-utils = gitignoreSource ../hls-test-utils; hls-brittany-plugin = gitignoreSource ../plugins/hls-brittany-plugin; hls-stylish-haskell-plugin = gitignoreSource ../plugins/hls-stylish-haskell-plugin; + hls-fourmolu-plugin = gitignoreSource ../plugins/hls-fourmolu-plugin; hls-class-plugin = gitignoreSource ../plugins/hls-class-plugin; hls-haddock-comments-plugin = gitignoreSource ../plugins/hls-haddock-comments-plugin; hls-eval-plugin = gitignoreSource ../plugins/hls-eval-plugin; diff --git a/plugins/hls-fourmolu-plugin/LICENSE b/plugins/hls-fourmolu-plugin/LICENSE new file mode 100644 index 0000000000..16502c47e2 --- /dev/null +++ b/plugins/hls-fourmolu-plugin/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 2021 The Haskell IDE team + + 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/plugins/hls-fourmolu-plugin/hls-fourmolu-plugin.cabal b/plugins/hls-fourmolu-plugin/hls-fourmolu-plugin.cabal new file mode 100644 index 0000000000..b4cdf3d8ea --- /dev/null +++ b/plugins/hls-fourmolu-plugin/hls-fourmolu-plugin.cabal @@ -0,0 +1,60 @@ +cabal-version: 2.4 +name: hls-fourmolu-plugin +version: 1.0.0.0 +synopsis: Integration with the Fourmolu code formatter +description: + Please see the README on GitHub at + +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 + +library + exposed-modules: Ide.Plugin.Fourmolu + hs-source-dirs: src + build-depends: + , base >=4.12 && <5 + , extra + , fourmolu ^>=0.3 + , filepath + , ghc + , ghc-boot-th + , ghcide >=1.2 && <1.4 + , hls-plugin-api ^>=1.1 + , lens + , lsp + , lsp-types + , text + + 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 + , bytestring + , hls-fourmolu-plugin + , text + , data-default + , hspec-expectations + , lens + , ghcide + , filepath + , hls-test-utils ^>= 1.0 + , lsp-types + , aeson + , hls-plugin-api + , lsp-test + , containers + , unordered-containers diff --git a/plugins/default/src/Ide/Plugin/Fourmolu.hs b/plugins/hls-fourmolu-plugin/src/Ide/Plugin/Fourmolu.hs similarity index 100% rename from plugins/default/src/Ide/Plugin/Fourmolu.hs rename to plugins/hls-fourmolu-plugin/src/Ide/Plugin/Fourmolu.hs diff --git a/plugins/hls-fourmolu-plugin/test/Main.hs b/plugins/hls-fourmolu-plugin/test/Main.hs new file mode 100644 index 0000000000..5ef9ac8c44 --- /dev/null +++ b/plugins/hls-fourmolu-plugin/test/Main.hs @@ -0,0 +1,36 @@ +{-# LANGUAGE OverloadedStrings #-} +module Main(main) where + +import Control.Monad.IO.Class +import Data.Aeson +import qualified Data.ByteString.Lazy as BS +import qualified Data.Text.Encoding as T +import qualified Data.Text.IO as T +import Language.LSP.Test +import Language.LSP.Types +import Test.Hls +import qualified Ide.Plugin.Fourmolu as Fourmolu +import System.FilePath + +main :: IO () +main = defaultTestRunner tests + +plugin :: PluginDescriptor IdeState +plugin = Fourmolu.descriptor "fourmolu" + +testDataDir :: FilePath +testDataDir = "test/testdata/" + +tests :: TestTree +tests = testGroup "fourmolu" + [ goldenGitDiff "formats correctly" (testDataDir "Format.fourmolu.formatted.hs") $ + runSessionWithServerFormatter plugin "fourmolu" testDataDir $ do + doc <- openDoc "Format.hs" "haskell" + formatDoc doc (FormattingOptions 4 True Nothing Nothing Nothing) + BS.fromStrict . T.encodeUtf8 <$> documentContents doc + , goldenGitDiff "formats imports correctly" (testDataDir "Format2.fourmolu.formatted.hs") $ + runSessionWithServerFormatter plugin "fourmolu" testDataDir $ do + doc <- openDoc "Format2.hs" "haskell" + formatDoc doc (FormattingOptions 4 True Nothing Nothing Nothing) + BS.fromStrict . T.encodeUtf8 <$> documentContents doc + ] diff --git a/test/testdata/format/Format.fourmolu.formatted.hs b/plugins/hls-fourmolu-plugin/test/testdata/Format.fourmolu.formatted.hs similarity index 100% rename from test/testdata/format/Format.fourmolu.formatted.hs rename to plugins/hls-fourmolu-plugin/test/testdata/Format.fourmolu.formatted.hs diff --git a/plugins/hls-fourmolu-plugin/test/testdata/Format.hs b/plugins/hls-fourmolu-plugin/test/testdata/Format.hs new file mode 100644 index 0000000000..b8bb374e2e --- /dev/null +++ b/plugins/hls-fourmolu-plugin/test/testdata/Format.hs @@ -0,0 +1,15 @@ +module Format where +import Data.List + +import Prelude +import Data.Int +foo :: Int -> Int +foo 3 = 2 +foo x = x +bar :: String -> IO String +bar s = do + x <- return "hello" + return "asdf" + +data Baz = Baz { a :: Int, b :: String } + diff --git a/test/testdata/format/Format2.fourmolu.formatted.hs b/plugins/hls-fourmolu-plugin/test/testdata/Format2.fourmolu.formatted.hs similarity index 100% rename from test/testdata/format/Format2.fourmolu.formatted.hs rename to plugins/hls-fourmolu-plugin/test/testdata/Format2.fourmolu.formatted.hs diff --git a/plugins/hls-fourmolu-plugin/test/testdata/Format2.hs b/plugins/hls-fourmolu-plugin/test/testdata/Format2.hs new file mode 100644 index 0000000000..bb011b5638 --- /dev/null +++ b/plugins/hls-fourmolu-plugin/test/testdata/Format2.hs @@ -0,0 +1,5 @@ +import Data.Char +import Data.Either +import Data.Int +import Data.Data +import Data.Bool diff --git a/stack-8.10.2.yaml b/stack-8.10.2.yaml index 27978cb09d..eee5e16672 100644 --- a/stack-8.10.2.yaml +++ b/stack-8.10.2.yaml @@ -20,6 +20,7 @@ packages: - ./plugins/hls-brittany-plugin - ./plugins/hls-stylish-haskell-plugin - ./plugins/hls-floskell-plugin + - ./plugins/hls-fourmolu-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.10.3.yaml b/stack-8.10.3.yaml index 2fc0b368c4..04957ff3ae 100644 --- a/stack-8.10.3.yaml +++ b/stack-8.10.3.yaml @@ -20,6 +20,7 @@ packages: - ./plugins/hls-brittany-plugin - ./plugins/hls-stylish-haskell-plugin - ./plugins/hls-floskell-plugin + - ./plugins/hls-fourmolu-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.10.4.yaml b/stack-8.10.4.yaml index cc49d4ee56..a02346ae5b 100644 --- a/stack-8.10.4.yaml +++ b/stack-8.10.4.yaml @@ -20,6 +20,7 @@ packages: - ./plugins/hls-brittany-plugin - ./plugins/hls-stylish-haskell-plugin - ./plugins/hls-floskell-plugin + - ./plugins/hls-fourmolu-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.6.4.yaml b/stack-8.6.4.yaml index d2578a9e03..cf92e8810e 100644 --- a/stack-8.6.4.yaml +++ b/stack-8.6.4.yaml @@ -21,6 +21,7 @@ packages: - ./plugins/hls-brittany-plugin - ./plugins/hls-stylish-haskell-plugin - ./plugins/hls-floskell-plugin + - ./plugins/hls-fourmolu-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.6.5.yaml b/stack-8.6.5.yaml index a0b6014613..94be6ebf8b 100644 --- a/stack-8.6.5.yaml +++ b/stack-8.6.5.yaml @@ -20,6 +20,7 @@ packages: - ./plugins/hls-brittany-plugin - ./plugins/hls-stylish-haskell-plugin - ./plugins/hls-floskell-plugin + - ./plugins/hls-fourmolu-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.8.2.yaml b/stack-8.8.2.yaml index a9d5f7c486..82e34bff3d 100644 --- a/stack-8.8.2.yaml +++ b/stack-8.8.2.yaml @@ -20,6 +20,7 @@ packages: - ./plugins/hls-brittany-plugin - ./plugins/hls-stylish-haskell-plugin - ./plugins/hls-floskell-plugin + - ./plugins/hls-fourmolu-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.8.3.yaml b/stack-8.8.3.yaml index 6ee68a84ef..78d46b7089 100644 --- a/stack-8.8.3.yaml +++ b/stack-8.8.3.yaml @@ -20,6 +20,7 @@ packages: - ./plugins/hls-brittany-plugin - ./plugins/hls-stylish-haskell-plugin - ./plugins/hls-floskell-plugin + - ./plugins/hls-fourmolu-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.8.4.yaml b/stack-8.8.4.yaml index de4e71ccf9..33838beffb 100644 --- a/stack-8.8.4.yaml +++ b/stack-8.8.4.yaml @@ -20,6 +20,7 @@ packages: - ./plugins/hls-brittany-plugin - ./plugins/hls-stylish-haskell-plugin - ./plugins/hls-floskell-plugin + - ./plugins/hls-fourmolu-plugin ghc-options: "$everything": -haddock diff --git a/stack.yaml b/stack.yaml index 213eb920f8..90df02f69c 100644 --- a/stack.yaml +++ b/stack.yaml @@ -20,6 +20,7 @@ packages: - ./plugins/hls-brittany-plugin - ./plugins/hls-stylish-haskell-plugin - ./plugins/hls-floskell-plugin + - ./plugins/hls-fourmolu-plugin ghc-options: "$everything": -haddock diff --git a/test/functional/Format.hs b/test/functional/Format.hs index 215652648f..39a6f0c093 100644 --- a/test/functional/Format.hs +++ b/test/functional/Format.hs @@ -27,7 +27,6 @@ tests = testGroup "format document" [ , rangeTests , providerTests , ormoluTests - , fourmoluTests ] rangeTests :: TestTree @@ -97,19 +96,6 @@ ormoluTests = testGroup "ormolu" BS.fromStrict . T.encodeUtf8 <$> documentContents doc ] -fourmoluTests :: TestTree -fourmoluTests = testGroup "fourmolu" - [ goldenGitDiff "formats correctly" "test/testdata/format/Format.fourmolu.formatted.hs" $ runSession hlsCommand fullCaps "test/testdata/format" $ do - sendNotification SWorkspaceDidChangeConfiguration (DidChangeConfigurationParams (formatLspConfig "fourmolu")) - doc <- openDoc "Format.hs" "haskell" - formatDoc doc (FormattingOptions 4 True Nothing Nothing Nothing) - BS.fromStrict . T.encodeUtf8 <$> documentContents doc - , goldenGitDiff "formats imports correctly" "test/testdata/format/Format2.fourmolu.formatted.hs" $ runSession hlsCommand fullCaps "test/testdata/format" $ do - sendNotification SWorkspaceDidChangeConfiguration (DidChangeConfigurationParams (formatLspConfig "fourmolu")) - doc <- openDoc "Format2.hs" "haskell" - formatDoc doc (FormattingOptions 4 True Nothing Nothing Nothing) - BS.fromStrict . T.encodeUtf8 <$> documentContents doc - ] formatLspConfig :: Value -> Value formatLspConfig provider = object [ "haskell" .= object ["formattingProvider" .= (provider :: Value)] ]