diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 7de52ea385..ed8b0fcc4a 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -141,3 +141,10 @@ jobs: HLS_TEST_EXE: hls HLS_WRAPPER_TEST_EXE: hls-wrapper run: cabal test hls-brittany-plugin || cabal test hls-brittany-plugin --test-options="-j1" + + - name: Test stylish-haskell plugin + if: ${{ matrix.test }} + env: + HLS_TEST_EXE: hls + HLS_WRAPPER_TEST_EXE: hls-wrapper + run: cabal test hls-stylish-haskell-plugin || cabal test hls-stylish-haskell-plugin --test-options="-j1" diff --git a/cabal.project b/cabal.project index 1bee6a77f5..0c18e8dd70 100644 --- a/cabal.project +++ b/cabal.project @@ -6,6 +6,7 @@ packages: ./hls-plugin-api ./plugins/hls-tactics-plugin ./plugins/hls-brittany-plugin + ./plugins/hls-stylish-haskell-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 7087f97736..034be3ea7a 100644 --- a/haskell-language-server.cabal +++ b/haskell-language-server.cabal @@ -255,10 +255,7 @@ common ormolu common stylishHaskell if flag(stylishHaskell) || flag(all-formatters) - hs-source-dirs: plugins/default/src - other-modules: Ide.Plugin.StylishHaskell - build-depends: stylish-haskell ^>=0.12 - cpp-options: -DstylishHaskell + build-depends: hls-stylish-haskell-plugin ^>= 1.0.0.0 common brittany if (flag(brittany) || flag(all-formatters)) diff --git a/nix/default.nix b/nix/default.nix index b4ad84068d..2c5c64dc87 100644 --- a/nix/default.nix +++ b/nix/default.nix @@ -29,6 +29,7 @@ let hie-compat = gitignoreSource ../hie-compat; hls-plugin-api = gitignoreSource ../hls-plugin-api; hls-brittany-plugin = gitignoreSource ../plugins/hls-brittany-plugin; + hls-stylish-haskell-plugin = gitignoreSource ../plugins/hls-stylish-haskell-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-stylish-haskell-plugin/LICENSE b/plugins/hls-stylish-haskell-plugin/LICENSE new file mode 100644 index 0000000000..16502c47e2 --- /dev/null +++ b/plugins/hls-stylish-haskell-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-stylish-haskell-plugin/hls-stylish-haskell-plugin.cabal b/plugins/hls-stylish-haskell-plugin/hls-stylish-haskell-plugin.cabal new file mode 100644 index 0000000000..201f610a6b --- /dev/null +++ b/plugins/hls-stylish-haskell-plugin/hls-stylish-haskell-plugin.cabal @@ -0,0 +1,63 @@ +cabal-version: 2.2 +name: hls-stylish-haskell-plugin +version: 1.0.0.0 +synopsis: Integration with the Stylish Haskell code formatter +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 + +library + exposed-modules: Ide.Plugin.StylishHaskell + hs-source-dirs: src + build-depends: base + , stylish-haskell ^>=0.12 + , filepath + , ghc + , ghc-boot-th + , directory + , ghcide ^>= 1.1.0.0 + , lsp-types + , hls-plugin-api >= 1.0 && < 1.2 + , text + , mtl + + default-language: Haskell2010 + +executable test-server + default-language: Haskell2010 + build-depends: + , base + , data-default + , ghcide + , hls-stylish-haskell-plugin + , hls-plugin-api + main-is: Server.hs + hs-source-dirs: test + ghc-options: -threaded + +test-suite tests + type: exitcode-stdio-1.0 + default-language: Haskell2010 + build-tool-depends: + hls-stylish-haskell-plugin:test-server -any, + hs-source-dirs: test + main-is: Main.hs + build-depends: + , aeson + , base + , bytestring + , ghcide ^>= 1.1.0.0 + , hls-stylish-haskell-plugin + , lsp-test + , tasty + , tasty-ant-xml >=1.1.6 + , tasty-hunit + , tasty-golden + , tasty-rerun + , text diff --git a/plugins/default/src/Ide/Plugin/StylishHaskell.hs b/plugins/hls-stylish-haskell-plugin/src/Ide/Plugin/StylishHaskell.hs similarity index 100% rename from plugins/default/src/Ide/Plugin/StylishHaskell.hs rename to plugins/hls-stylish-haskell-plugin/src/Ide/Plugin/StylishHaskell.hs diff --git a/plugins/hls-stylish-haskell-plugin/test/Main.hs b/plugins/hls-stylish-haskell-plugin/test/Main.hs new file mode 100644 index 0000000000..e1b38d0928 --- /dev/null +++ b/plugins/hls-stylish-haskell-plugin/test/Main.hs @@ -0,0 +1,39 @@ +{-# 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.Tasty +import Test.Tasty.Golden +import Test.Tasty.HUnit +import Test.Tasty.Ingredients.Rerun +import Test.Tasty.Runners (consoleTestReporter, + listingTests) +import Test.Tasty.Runners.AntXML + +main :: IO () +main = defaultMainWithIngredients + [antXMLRunner, rerunningTests [listingTests, consoleTestReporter]] + tests + +testCommand = "test-server" + +tests :: TestTree +tests = testGroup "stylish-haskell" [ + goldenVsStringDiff "formats a document" goldenGitDiff "test/testdata/StylishHaskell.formatted_document.hs" $ runSession testCommand fullCaps "test/testdata" $ do + doc <- openDoc "StylishHaskell.hs" "haskell" + formatDoc doc (FormattingOptions 2 True Nothing Nothing Nothing) + BS.fromStrict . T.encodeUtf8 <$> documentContents doc + , goldenVsStringDiff "formats a range" goldenGitDiff "test/testdata/StylishHaskell.formatted_range.hs" $ runSession testCommand fullCaps "test/testdata" $ do + doc <- openDoc "StylishHaskell.hs" "haskell" + formatRange doc (FormattingOptions 2 True Nothing Nothing Nothing) (Range (Position 0 0) (Position 2 21)) + BS.fromStrict . T.encodeUtf8 <$> documentContents doc + ] + +goldenGitDiff :: FilePath -> FilePath -> [String] +goldenGitDiff fRef fNew = ["git", "diff", "--no-index", "--text", "--exit-code", fRef, fNew] diff --git a/plugins/hls-stylish-haskell-plugin/test/Server.hs b/plugins/hls-stylish-haskell-plugin/test/Server.hs new file mode 100644 index 0000000000..0d3389cf69 --- /dev/null +++ b/plugins/hls-stylish-haskell-plugin/test/Server.hs @@ -0,0 +1,18 @@ +{-# LANGUAGE OverloadedStrings #-} +module Main(main) where + +import Data.Default +import Development.IDE.Main +import qualified Development.IDE.Plugin.HLS.GhcIde as Ghcide +import Ide.Plugin.Config +import qualified Ide.Plugin.StylishHaskell as StylishHaskell +import Ide.PluginUtils + +main :: IO () +main = defaultMain def + { argsHlsPlugins = pluginDescToIdePlugins $ + [ StylishHaskell.descriptor "stylish-haskell" + ] <> + Ghcide.descriptors + , argsDefaultHlsConfig = def { formattingProvider = "stylish-haskell" } + } diff --git a/test/testdata/format/StylishHaskell.formatted_document.hs b/plugins/hls-stylish-haskell-plugin/test/testdata/StylishHaskell.formatted_document.hs similarity index 100% rename from test/testdata/format/StylishHaskell.formatted_document.hs rename to plugins/hls-stylish-haskell-plugin/test/testdata/StylishHaskell.formatted_document.hs diff --git a/test/testdata/format/StylishHaskell.formatted_range.hs b/plugins/hls-stylish-haskell-plugin/test/testdata/StylishHaskell.formatted_range.hs similarity index 100% rename from test/testdata/format/StylishHaskell.formatted_range.hs rename to plugins/hls-stylish-haskell-plugin/test/testdata/StylishHaskell.formatted_range.hs diff --git a/test/testdata/format/StylishHaskell.hs b/plugins/hls-stylish-haskell-plugin/test/testdata/StylishHaskell.hs similarity index 100% rename from test/testdata/format/StylishHaskell.hs rename to plugins/hls-stylish-haskell-plugin/test/testdata/StylishHaskell.hs diff --git a/stack-8.10.2.yaml b/stack-8.10.2.yaml index 1eb0d70ccd..6ea4bcd07d 100644 --- a/stack-8.10.2.yaml +++ b/stack-8.10.2.yaml @@ -15,6 +15,7 @@ packages: - ./plugins/hls-splice-plugin - ./plugins/hls-tactics-plugin - ./plugins/hls-brittany-plugin + - ./plugins/hls-stylish-haskell-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.10.3.yaml b/stack-8.10.3.yaml index 9e4840bc42..87475dad5e 100644 --- a/stack-8.10.3.yaml +++ b/stack-8.10.3.yaml @@ -15,6 +15,7 @@ packages: - ./plugins/hls-splice-plugin - ./plugins/hls-tactics-plugin - ./plugins/hls-brittany-plugin + - ./plugins/hls-stylish-haskell-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.10.4.yaml b/stack-8.10.4.yaml index bcea493d2e..d2834baa36 100644 --- a/stack-8.10.4.yaml +++ b/stack-8.10.4.yaml @@ -15,6 +15,7 @@ packages: - ./plugins/hls-splice-plugin - ./plugins/hls-tactics-plugin - ./plugins/hls-brittany-plugin + - ./plugins/hls-stylish-haskell-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.6.4.yaml b/stack-8.6.4.yaml index d28f0c71a9..f29d117d27 100644 --- a/stack-8.6.4.yaml +++ b/stack-8.6.4.yaml @@ -16,6 +16,7 @@ packages: - ./plugins/hls-splice-plugin - ./plugins/hls-tactics-plugin - ./plugins/hls-brittany-plugin + - ./plugins/hls-stylish-haskell-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.6.5.yaml b/stack-8.6.5.yaml index e2dca91958..3f70015339 100644 --- a/stack-8.6.5.yaml +++ b/stack-8.6.5.yaml @@ -15,6 +15,7 @@ packages: - ./plugins/hls-splice-plugin - ./plugins/hls-tactics-plugin - ./plugins/hls-brittany-plugin + - ./plugins/hls-stylish-haskell-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.8.2.yaml b/stack-8.8.2.yaml index d18e4345ff..1800ece1df 100644 --- a/stack-8.8.2.yaml +++ b/stack-8.8.2.yaml @@ -15,6 +15,7 @@ packages: - ./plugins/hls-splice-plugin - ./plugins/hls-tactics-plugin - ./plugins/hls-brittany-plugin + - ./plugins/hls-stylish-haskell-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.8.3.yaml b/stack-8.8.3.yaml index 711287301a..93d8c13d19 100644 --- a/stack-8.8.3.yaml +++ b/stack-8.8.3.yaml @@ -15,6 +15,7 @@ packages: - ./plugins/hls-splice-plugin - ./plugins/hls-tactics-plugin - ./plugins/hls-brittany-plugin + - ./plugins/hls-stylish-haskell-plugin ghc-options: "$everything": -haddock diff --git a/stack-8.8.4.yaml b/stack-8.8.4.yaml index e337242872..2d33fcdecc 100644 --- a/stack-8.8.4.yaml +++ b/stack-8.8.4.yaml @@ -15,6 +15,7 @@ packages: - ./plugins/hls-splice-plugin - ./plugins/hls-tactics-plugin - ./plugins/hls-brittany-plugin + - ./plugins/hls-stylish-haskell-plugin ghc-options: "$everything": -haddock diff --git a/stack.yaml b/stack.yaml index f1283b0007..258d512164 100644 --- a/stack.yaml +++ b/stack.yaml @@ -15,6 +15,7 @@ packages: - ./plugins/hls-splice-plugin - ./plugins/hls-tactics-plugin - ./plugins/hls-brittany-plugin + - ./plugins/hls-stylish-haskell-plugin ghc-options: "$everything": -haddock diff --git a/test/functional/Format.hs b/test/functional/Format.hs index e11ef631e5..8936c666d9 100644 --- a/test/functional/Format.hs +++ b/test/functional/Format.hs @@ -7,7 +7,7 @@ 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 qualified Data.Text.IO as T import Language.LSP.Test import Language.LSP.Types import qualified Language.LSP.Types.Lens as LSP @@ -28,7 +28,6 @@ tests = testGroup "format document" [ BS.fromStrict . T.encodeUtf8 <$> documentContents doc , rangeTests , providerTests - , stylishHaskellTests , ormoluTests , fourmoluTests ] @@ -91,19 +90,6 @@ providerTests = testGroup "formatting provider" [ documentContents doc >>= liftIO . (@?= formattedFloskell) ] -stylishHaskellTests :: TestTree -stylishHaskellTests = testGroup "stylish-haskell" [ - goldenVsStringDiff "formats a document" goldenGitDiff "test/testdata/format/StylishHaskell.formatted_document.hs" $ runSession hlsCommand fullCaps "test/testdata/format" $ do - sendNotification SWorkspaceDidChangeConfiguration (DidChangeConfigurationParams (formatLspConfig "stylish-haskell")) - doc <- openDoc "StylishHaskell.hs" "haskell" - formatDoc doc (FormattingOptions 2 True Nothing Nothing Nothing) - BS.fromStrict . T.encodeUtf8 <$> documentContents doc - , goldenVsStringDiff "formats a range" goldenGitDiff "test/testdata/format/StylishHaskell.formatted_range.hs" $ runSession hlsCommand fullCaps "test/testdata/format" $ do - sendNotification SWorkspaceDidChangeConfiguration (DidChangeConfigurationParams (formatLspConfig "stylish-haskell")) - doc <- openDoc "StylishHaskell.hs" "haskell" - formatRange doc (FormattingOptions 2 True Nothing Nothing Nothing) (Range (Position 0 0) (Position 2 21)) - BS.fromStrict . T.encodeUtf8 <$> documentContents doc - ] ormoluTests :: TestTree ormoluTests = testGroup "ormolu"