diff --git a/.github/workflows/hackage.yml b/.github/workflows/hackage.yml
index 34e6b8b62..cf00ef0ee 100644
--- a/.github/workflows/hackage.yml
+++ b/.github/workflows/hackage.yml
@@ -29,7 +29,7 @@ jobs:
package: ["hie-compat", "hls-graph", "shake-bench",
"hls-plugin-api", "ghcide", "hls-test-utils",
"hls-cabal-plugin",
- "hls-brittany-plugin", "hls-floskell-plugin", "hls-fourmolu-plugin",
+ "hls-floskell-plugin", "hls-fourmolu-plugin",
"hls-ormolu-plugin", "hls-stylish-haskell-plugin",
"hls-class-plugin", "hls-eval-plugin", "hls-explicit-imports-plugin",
"hls-haddock-comments-plugin", "hls-hlint-plugin", "hls-stan-plugin",
@@ -106,14 +106,11 @@ jobs:
# These tweaks are already in cabal-901.project but we dont want to use the entire file,
# Only the tricks needed by the solver which we know will not make the hackage build fail.
# The solver takes in account all project packages, even if they are not gonna be effectively built
- # (like brittany or stylish-haskell for ghc-9.0)
+ # (like stylish-haskell for ghc-9.0)
- name: "Add temporary needed allow-newer for ghc-9.0"
if: steps.get-hackage-version.outputs.exists != 'true' && matrix.ghc == '9.0.2'
run: |
cd $(ls -d ./incoming/${{ matrix.package }}-*)
- # For brittany
- echo "allow-newer:" >> cabal.project
- echo " butcher:base, multistate:base, data-tree-print:base," >> cabal.project
# For stylish-haskell
echo " stylish-haskell:Cabal,stylish-haskell:ghc-lib-parser,stylish-haskell:aeson" >> cabal.project
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index bfbe8382a..d75a54dc3 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -165,10 +165,6 @@ jobs:
HLS_WRAPPER_TEST_EXE: hls-wrapper
run: cabal test wrapper-test --test-options="$TEST_OPTS --rerun-log-file .tasty-rerun-log-wrapper"
- - if: matrix.test && matrix.ghc != '9.2.4' && matrix.ghc != '9.2.5' && matrix.ghc != '9.4.2' && matrix.ghc != '9.4.3'
- name: Test hls-brittany-plugin
- run: cabal test hls-brittany-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-brittany-plugin --test-options="$TEST_OPTS"
-
- if: matrix.test
name: Test hls-refactor-plugin
run: cabal test hls-refactor-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-refactor-plugin --test-options="$TEST_OPTS"
diff --git a/CODEOWNERS b/CODEOWNERS
index dbe8495fb..a48cb33c4 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -8,7 +8,6 @@
# Plugins
/plugins/hls-alternate-number-format-plugin @drsooch
-/plugins/hls-brittany-plugin @fendor
/plugins/hls-cabal-plugin @fendor
/plugins/hls-cabal-fmt-plugin @VeryMilkyJoe @fendor
/plugins/hls-call-hierarchy-plugin @July541
diff --git a/bench/config.yaml b/bench/config.yaml
index 9e49ed636..08811a58d 100644
--- a/bench/config.yaml
+++ b/bench/config.yaml
@@ -144,7 +144,6 @@ configurations:
- rename
- stylish-haskell
# - alternateNumberFormat
-# # - brittany
# - callHierarchy
# - changeTypeSignature
# - class
diff --git a/cabal.project b/cabal.project
index efab6d710..732330cb3 100644
--- a/cabal.project
+++ b/cabal.project
@@ -11,7 +11,6 @@ packages:
./plugins/hls-cabal-plugin
./plugins/hls-cabal-fmt-plugin
./plugins/hls-tactics-plugin
- ./plugins/hls-brittany-plugin
./plugins/hls-stylish-haskell-plugin
./plugins/hls-fourmolu-plugin
./plugins/hls-class-plugin
diff --git a/configuration-ghc-90.nix b/configuration-ghc-90.nix
index 8979f6bd3..1757a7bf4 100644
--- a/configuration-ghc-90.nix
+++ b/configuration-ghc-90.nix
@@ -1,7 +1,7 @@
{ pkgs, inputs }:
let
- disabledPlugins = [ "hls-brittany-plugin" "hls-stylish-haskell-plugin" ];
+ disabledPlugins = [ "hls-stylish-haskell-plugin" ];
hpkgsOverride = hself: hsuper:
with pkgs.haskell.lib;
@@ -34,7 +34,7 @@ let
# Re-generate HLS drv excluding some plugins
haskell-language-server =
hself.callCabal2nixWithOptions "haskell-language-server" ./.
- (pkgs.lib.concatStringsSep " " [ "-f-brittany" "-f-stylishhaskell" ])
+ (pkgs.lib.concatStringsSep " " [ "-f-stylishhaskell" ])
{ };
retrie = hself.retrie_1_1_0_0;
diff --git a/docs/configuration.md b/docs/configuration.md
index 2ff795e54..1b673bd77 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -40,7 +40,7 @@ This option obviously would not make sense for language servers for other langua
Here is a list of the additional settings currently supported by `haskell-language-server`, along with their setting key (you may not need to know this) and default:
-- Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `floskell`, `ormolu`, `fourmolu`, `stylish-haskell`, or `brittany` (if compiled with the brittany plugin).
+- Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `floskell`, `ormolu`, `fourmolu`, or `stylish-haskell`.
- Max completions (`haskell.maxCompletions`, default 40): maximum number of completions sent to the LSP client.
- Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on initial load. As it is activated by default could drive to bad performance in large projects.
- Check parents (`haskell.checkParents`, default `CheckOnSave`): when to typecheck reverse dependencies of a file; one of `NeverCheck`, `CheckOnSave` (means dependent/parent modules will only be checked when you save), or `AlwaysCheck` (means re-typechecking them on every change).
diff --git a/docs/contributing/plugin-tutorial.md b/docs/contributing/plugin-tutorial.md
index 56f1765af..81608122e 100644
--- a/docs/contributing/plugin-tutorial.md
+++ b/docs/contributing/plugin-tutorial.md
@@ -77,7 +77,7 @@ The HLS codebase includes several plugins under the namespace `Ide.Plugin.*`, th
- The ghcide plugin, which embeds ghcide as a plugin (ghcide is also the engine under HLS).
- The example and example2 plugins, offering a dubious welcome to new contributors
-- The Brittany, ormolu, fourmolu, floskell and stylish-haskell plugins, a testament to the code formatting wars of our community.
+- The ormolu, fourmolu, floskell and stylish-haskell plugins, a testament to the code formatting wars of our community.
- The eval plugin, a code lens provider to evaluate code in comments
- The retrie plugin, a code actions provider to execute retrie commands
@@ -96,7 +96,6 @@ idePlugins = pluginDescToIdePlugins allPlugins
, Ormolu.descriptor "ormolu"
, StylishHaskell.descriptor "stylish-haskell"
, Retrie.descriptor "retrie"
- , Brittany.descriptor "brittany"
, Eval.descriptor "eval"
]
```
diff --git a/docs/features.md b/docs/features.md
index c032848ab..b74ec7a1d 100644
--- a/docs/features.md
+++ b/docs/features.md
@@ -107,7 +107,6 @@ Format your code with various Haskell code formatters.
| Formatter | Provided by |
| --------------- | ---------------------------- |
-| Brittany | `hls-brittany-plugin` |
| Floskell | `hls-floskell-plugin` |
| Fourmolu | `hls-fourmolu-plugin` |
| Ormolu | `hls-ormolu-plugin` |
diff --git a/docs/support/plugin-support.md b/docs/support/plugin-support.md
index bfe7ce143..464893a44 100644
--- a/docs/support/plugin-support.md
+++ b/docs/support/plugin-support.md
@@ -63,7 +63,6 @@ For example, a plugin to provide a formatter which has itself been abandoned has
| `hls-refine-imports-plugin` | 2 | |
| `hls-stylish-haskell-plugin` | 2 | 9.4 |
| `hls-tactics-plugin` | 2 | 9.2, 9.4 |
-| `hls-brittany-plugin` | 3 | 9.2, 9.4 |
| `hls-haddock-comments-plugin` | 3 | 9.2, 9.4 |
| `hls-stan-plugin` | 3 | 8.6, 9.0, 9.2, 9.4 |
| `hls-retrie-plugin` | 3 | |
diff --git a/flake.nix b/flake.nix
index 6ec991301..9f2315bec 100644
--- a/flake.nix
+++ b/flake.nix
@@ -59,10 +59,6 @@
url = "https://hackage.haskell.org/package/aeson-1.5.2.0/aeson-1.5.2.0.tar.gz";
flake = false;
};
- brittany-01312 = {
- url = "https://hackage.haskell.org/package/brittany-0.13.1.2/brittany-0.13.1.2.tar.gz";
- flake = false;
- };
fourmolu = {
url = "https://hackage.haskell.org/package/fourmolu-0.10.1.0/fourmolu-0.10.1.0.tar.gz";
flake = false;
diff --git a/haskell-language-server.cabal b/haskell-language-server.cabal
index c0c7f67a8..63bdff7ab 100644
--- a/haskell-language-server.cabal
+++ b/haskell-language-server.cabal
@@ -196,11 +196,6 @@ flag stylishHaskell
default: True
manual: True
-flag brittany
- description: Enable brittany plugin
- default: True
- manual: True
-
flag refactor
description: Enable refactor plugin
default: True
@@ -353,11 +348,6 @@ common stylishHaskell
build-depends: hls-stylish-haskell-plugin ^>= 1.0
cpp-options: -Dhls_stylishHaskell
-common brittany
- if flag(brittany) && (impl(ghc < 9.0.2) || flag(ignore-plugins-ghc-bounds))
- build-depends: hls-brittany-plugin ^>= 1.1
- cpp-options: -Dhls_brittany
-
common refactor
if flag(refactor)
build-depends: hls-refactor-plugin ^>= 1.1
@@ -396,7 +386,6 @@ library
, fourmolu
, ormolu
, stylishHaskell
- , brittany
, refactor
exposed-modules:
diff --git a/hls-plugin-api/src/Ide/Types.hs b/hls-plugin-api/src/Ide/Types.hs
index ab355d833..031158c35 100644
--- a/hls-plugin-api/src/Ide/Types.hs
+++ b/hls-plugin-api/src/Ide/Types.hs
@@ -59,7 +59,7 @@ import System.Posix.Signals
#endif
import Control.Applicative ((<|>))
import Control.Arrow ((&&&))
-import Control.Lens ((^.), (.~))
+import Control.Lens ((.~), (^.))
import Data.Aeson hiding (defaultOptions)
import Data.Default
import Data.Dependent.Map (DMap)
@@ -89,7 +89,6 @@ import Language.LSP.Types hiding
SemanticTokensEdit (_start))
import Language.LSP.Types.Capabilities (ClientCapabilities (ClientCapabilities),
TextDocumentClientCapabilities (_codeAction, _documentSymbol))
-import qualified Language.LSP.Types.Lens as J
import Language.LSP.Types.Lens as J (HasChildren (children),
HasCommand (command),
HasContents (contents),
@@ -102,6 +101,7 @@ import Language.LSP.Types.Lens as J (HasChildren (children),
HasTextDocument (..),
HasTitle (title),
HasUri (..))
+import qualified Language.LSP.Types.Lens as J
import Language.LSP.VFS
import Numeric.Natural
import OpenTelemetry.Eventlog
@@ -196,7 +196,6 @@ instance Default Config where
def = Config
{ checkParents = CheckOnSave
, checkProject = True
- -- , formattingProvider = "brittany"
, formattingProvider = "ormolu"
-- , formattingProvider = "floskell"
-- , formattingProvider = "stylish-haskell"
diff --git a/plugins/hls-brittany-plugin/LICENSE b/plugins/hls-brittany-plugin/LICENSE
deleted file mode 100644
index dba13ed2d..000000000
--- a/plugins/hls-brittany-plugin/LICENSE
+++ /dev/null
@@ -1,661 +0,0 @@
- GNU AFFERO GENERAL PUBLIC LICENSE
- Version 3, 19 November 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The GNU Affero General Public License is a free, copyleft license for
-software and other kinds of works, specifically designed to ensure
-cooperation with the community in the case of network server software.
-
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-our General Public Licenses are intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
- Developers that use our General Public Licenses protect your rights
-with two steps: (1) assert copyright on the software, and (2) offer
-you this License which gives you legal permission to copy, distribute
-and/or modify the software.
-
- A secondary benefit of defending all users' freedom is that
-improvements made in alternate versions of the program, if they
-receive widespread use, become available for other developers to
-incorporate. Many developers of free software are heartened and
-encouraged by the resulting cooperation. However, in the case of
-software used on network servers, this result may fail to come about.
-The GNU General Public License permits making a modified version and
-letting the public access it on a server without ever releasing its
-source code to the public.
-
- The GNU Affero General Public License is designed specifically to
-ensure that, in such cases, the modified source code becomes available
-to the community. It requires the operator of a network server to
-provide the source code of the modified version running there to the
-users of that server. Therefore, public use of a modified version, on
-a publicly accessible server, gives the public access to the source
-code of the modified version.
-
- An older license, called the Affero General Public License and
-published by Affero, was designed to accomplish similar goals. This is
-a different license, not a version of the Affero GPL, but Affero has
-released a new version of the Affero GPL which permits relicensing under
-this license.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- TERMS AND CONDITIONS
-
- 0. Definitions.
-
- "This License" refers to version 3 of the GNU Affero General Public License.
-
- "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
-"recipients" may be individuals or organizations.
-
- To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
- A "covered work" means either the unmodified Program or a work based
-on the Program.
-
- To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
- An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
- 1. Source Code.
-
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
-form of a work.
-
- A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
- The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
- The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
- The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
- The Corresponding Source for a work in source code form is that
-same work.
-
- 2. Basic Permissions.
-
- All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
- You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
-makes it unnecessary.
-
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
- No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
- When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
- 4. Conveying Verbatim Copies.
-
- You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
- You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
- 5. Conveying Modified Source Versions.
-
- You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
- a) The work must carry prominent notices stating that you modified
- it, and giving a relevant date.
-
- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under section
- 7. This requirement modifies the requirement in section 4 to
- "keep intact all notices".
-
- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
- License will therefore apply, along with any applicable section 7
- additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
- permission to license the work in any other way, but it does not
- invalidate such permission if you have separately received it.
-
- d) If the work has interactive user interfaces, each must display
- Appropriate Legal Notices; however, if the Program has interactive
- interfaces that do not display Appropriate Legal Notices, your
- work need not make them do so.
-
- A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
- 6. Conveying Non-Source Forms.
-
- You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
- a) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by the
- Corresponding Source fixed on a durable physical medium
- customarily used for software interchange.
-
- b) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by a
- written offer, valid for at least three years and valid for as
- long as you offer spare parts or customer support for that product
- model, to give anyone who possesses the object code either (1) a
- copy of the Corresponding Source for all the software in the
- product that is covered by this License, on a durable physical
- medium customarily used for software interchange, for a price no
- more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the
- Corresponding Source from a network server at no charge.
-
- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
- alternative is allowed only occasionally and noncommercially, and
- only if you received the object code with such an offer, in accord
- with subsection 6b.
-
- d) Convey the object code by offering access from a designated
- place (gratis or for a charge), and offer equivalent access to the
- Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
- copy the object code is a network server, the Corresponding Source
- may be on a different server (operated by you or a third party)
- that supports equivalent copying facilities, provided you maintain
- clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
- Corresponding Source, you remain obligated to ensure that it is
- available for as long as needed to satisfy these requirements.
-
- e) Convey the object code using peer-to-peer transmission, provided
- you inform other peers where the object code and Corresponding
- Source of the work are being offered to the general public at no
- charge under subsection 6d.
-
- A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
- A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
- "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
- If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
- The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
- Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
- 7. Additional Terms.
-
- "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
- When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
- Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
- a) Disclaiming warranty or limiting liability differently from the
- terms of sections 15 and 16 of this License; or
-
- b) Requiring preservation of specified reasonable legal notices or
- author attributions in that material or in the Appropriate Legal
- Notices displayed by works containing it; or
-
- c) Prohibiting misrepresentation of the origin of that material, or
- requiring that modified versions of such material be marked in
- reasonable ways as different from the original version; or
-
- d) Limiting the use for publicity purposes of names of licensors or
- authors of the material; or
-
- e) Declining to grant rights under trademark law for use of some
- trade names, trademarks, or service marks; or
-
- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions of
- it) with contractual assumptions of liability to the recipient, for
- any liability that these contractual assumptions directly impose on
- those licensors and authors.
-
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
- If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
- Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
- 8. Termination.
-
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
- However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
- Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
- Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
- 9. Acceptance Not Required for Having Copies.
-
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
-nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
- 10. Automatic Licensing of Downstream Recipients.
-
- Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
-for enforcing compliance by third parties with this License.
-
- An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
- 11. Patents.
-
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
-work thus licensed is called the contributor's "contributor version".
-
- A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
- Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
- In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
- If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
- If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
- A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
- Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
- 12. No Surrender of Others' Freedom.
-
- If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
- 13. Remote Network Interaction; Use with the GNU General Public License.
-
- Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your version
-supports such interaction) an opportunity to receive the Corresponding
-Source of your version by providing access to the Corresponding Source
-from a network server at no charge, through some standard or customary
-means of facilitating copying of software. This Corresponding Source
-shall include the Corresponding Source for any work covered by version 3
-of the GNU General Public License that is incorporated pursuant to the
-following paragraph.
-
- Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU General Public License into a single
-combined work, and to convey the resulting work. The terms of this
-License will continue to apply to the part which is the covered work,
-but the work with which it is combined will remain governed by version
-3 of the GNU General Public License.
-
- 14. Revised Versions of this License.
-
- The Free Software Foundation may publish revised and/or new versions of
-the GNU Affero General Public License from time to time. Such new versions
-will be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Program specifies that a certain numbered version of the GNU Affero General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU Affero General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
- If the Program specifies that a proxy can decide which future
-versions of the GNU Affero General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
- 15. Disclaimer of Warranty.
-
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. Limitation of Liability.
-
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
- 17. Interpretation of Sections 15 and 16.
-
- If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-
- Copyright (C)
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see .
-
-Also add information on how to contact you by electronic and paper mail.
-
- If your software can interact with users remotely through a computer
-network, you should also make sure that it provides a way for users to
-get its source. For example, if your program is a web application, its
-interface could display a "Source" link that leads users to an archive
-of the code. There are many ways you could offer source, and different
-solutions will be better for different programs; see section 13 for the
-specific requirements.
-
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU AGPL, see
-.
diff --git a/plugins/hls-brittany-plugin/hls-brittany-plugin.cabal b/plugins/hls-brittany-plugin/hls-brittany-plugin.cabal
deleted file mode 100644
index df701ab05..000000000
--- a/plugins/hls-brittany-plugin/hls-brittany-plugin.cabal
+++ /dev/null
@@ -1,63 +0,0 @@
-cabal-version: 2.4
-name: hls-brittany-plugin
-version: 1.1.0.0
-synopsis: Integration with the Brittany code formatter
-description:
- Please see the README on GitHub at
-
-license: AGPL-3.0-only
-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
-
-source-repository head
- type: git
- location: https://github.com/haskell/haskell-language-server.git
-
-library
- if impl(ghc >= 9.2)
- buildable: False
- else
- buildable: True
- exposed-modules: Ide.Plugin.Brittany
- hs-source-dirs: src
- build-depends:
- , base >=4.12 && <5
- -- see https://github.com/lspitzner/brittany/issues/364
- , brittany >=0.13.1.0 && < 0.14.0.1 || > 0.14.0.1
- , filepath
- , ghc-boot-th
- , ghcide ^>= 1.6 || ^>= 1.7 || ^>= 1.8 || ^>= 1.9
- , hls-plugin-api ^>= 1.3 || ^>= 1.4 || ^>= 1.5 || ^>= 1.6
- , lens
- , lsp-types
- , text
- , transformers
- -- TODO: remove these when GH issue #2005 is resolved
- , extra
- , ghc-exactprint
- , czipwith
-
- default-language: Haskell2010
-
-test-suite tests
- if impl(ghc >= 9.2)
- buildable: False
- else
- buildable: True
- 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-brittany-plugin
- , hls-test-utils ^>=1.5
diff --git a/plugins/hls-brittany-plugin/src/Ide/Plugin/Brittany.hs b/plugins/hls-brittany-plugin/src/Ide/Plugin/Brittany.hs
deleted file mode 100644
index 9cb142164..000000000
--- a/plugins/hls-brittany-plugin/src/Ide/Plugin/Brittany.hs
+++ /dev/null
@@ -1,279 +0,0 @@
-{-# LANGUAGE CPP #-}
-{-# LANGUAGE LambdaCase #-}
-{-# LANGUAGE MultiWayIf #-}
-{-# LANGUAGE PolyKinds #-}
-{-# LANGUAGE TypeFamilies #-}
-module Ide.Plugin.Brittany where
-
-import Control.Exception (bracket_)
-import Control.Lens
-import Control.Monad.IO.Class
-import Control.Monad.Trans.Maybe (MaybeT,
- runMaybeT)
-import Data.Maybe (fromMaybe,
- mapMaybe,
- maybeToList)
-import Data.Semigroup
-import Data.Text (Text)
-import qualified Data.Text as T
-import Development.IDE hiding
- (getExtensions,
- pluginHandlers)
-import qualified Development.IDE.GHC.Compat as GHC hiding
- (Cpp)
-import qualified Development.IDE.GHC.Compat.Util as GHC
-import GHC.LanguageExtensions.Type
-import Ide.PluginUtils
-import Ide.Types hiding (Config)
-import Language.Haskell.Brittany
-import Language.LSP.Types as J
-import qualified Language.LSP.Types.Lens as J
-import System.Environment (setEnv,
- unsetEnv)
-import System.FilePath
-
--- These imports are for the temporary pPrintText & can be removed when
--- issue #2005 is resolved
-import Control.Monad.Trans.Class (lift)
-import qualified Control.Monad.Trans.Except as ExceptT
-import Data.CZipWith
-import qualified Data.List as List
-import qualified Data.Text as Text
-import qualified Data.Text.Lazy as TextL
-import qualified GHC.LanguageExtensions.Type as GHC
-import Language.Haskell.Brittany.Internal
-import Language.Haskell.Brittany.Internal.Config
-import Language.Haskell.Brittany.Internal.Config.Types
-import Language.Haskell.Brittany.Internal.Obfuscation
-import Language.Haskell.Brittany.Internal.Types
-import Language.Haskell.Brittany.Internal.Utils
-import qualified Language.Haskell.GHC.ExactPrint as ExactPrint
-import qualified Language.Haskell.GHC.ExactPrint.Types as ExactPrint
-
-
-descriptor :: PluginId -> PluginDescriptor IdeState
-descriptor plId = (defaultPluginDescriptor plId)
- { pluginHandlers = mkFormattingHandlers provider
- }
-
--- | Formatter provider of Brittany.
--- Formats the given source in either a given Range or the whole Document.
--- If the provider fails an error is returned that can be displayed to the user.
-provider :: FormattingHandler IdeState
-provider ide typ contents nfp opts = liftIO $ do
- confFile <- getConfFile nfp
- let (range, selectedContents) = case typ of
- FormatText -> (fullRange contents, contents)
- FormatRange r -> (normalize r, extractRange r contents)
- modsum <- fmap msrModSummary $ runAction "brittany" ide $ use_ GetModSummaryWithoutTimestamps nfp
- let dflags = GHC.ms_hspp_opts modsum
- let withRuntimeLibdir = bracket_ (setEnv key $ GHC.topDir dflags) (unsetEnv key)
- where key = "GHC_EXACTPRINT_GHC_LIBDIR"
- res <- withRuntimeLibdir $ formatText dflags confFile opts selectedContents
- case res of
- Left err -> return $ Left $ responseError (T.pack $ "brittanyCmd: " ++ unlines (map showErr err))
- Right newText -> return $ Right $ J.List [TextEdit range newText]
-
--- | Primitive to format text with the given option.
--- May not throw exceptions but return a Left value.
--- Errors may be presented to the user.
-formatText
- :: MonadIO m
- => GHC.DynFlags
- -> Maybe FilePath -- ^ Path to configs. If Nothing, default configs will be used.
- -> FormattingOptions -- ^ Options for the formatter such as indentation.
- -> Text -- ^ Text to format
- -> m (Either [BrittanyError] Text) -- ^ Either formatted Text or a error from Brittany.
-formatText df confFile opts text =
- liftIO $ runBrittany tabSize df confFile text
- where tabSize = fromIntegral $ opts ^. J.tabSize
-
--- | Recursively search in every directory of the given filepath for brittany.yaml.
--- If no such file has been found, return Nothing.
-getConfFile :: NormalizedFilePath -> IO (Maybe FilePath)
-getConfFile = findLocalConfigPath . takeDirectory . fromNormalizedFilePath
-
--- | Run Brittany on the given text with the given tab size and
--- a configuration path. If no configuration path is given, a
--- default configuration is chosen. The configuration may overwrite
--- tab size parameter.
---
--- Returns either a list of Brittany Errors or the reformatted text.
--- May not throw an exception.
-runBrittany :: Int -- ^ tab size
- -> GHC.DynFlags
- -> Maybe FilePath -- ^ local config file
- -> Text -- ^ text to format
- -> IO (Either [BrittanyError] Text)
-runBrittany tabSize df confPath text = do
- let cfg = mempty
- { _conf_layout =
- mempty { _lconfig_indentAmount = opt (Last tabSize)
- }
- , _conf_forward =
- (mempty :: CForwardOptions CMaybe)
- { _options_ghc = opt (getExtensions df)
- }
- }
- config <- fromMaybeT (pure staticDefaultConfig)
- (readConfigsWithUserConfig cfg (maybeToList confPath))
- (errsAndWarnings, resultText) <- pPrintText config text
- if any isError errsAndWarnings then
- return $ Left errsAndWarnings
- else
- return $ Right resultText
-
-#if MIN_VERSION_brittany(0,14,0)
-type CMaybe = Maybe
-opt :: a -> Maybe a
-opt = Just
-#else
-type CMaybe = Option
-opt :: a -> Option a
-opt = Option . Just
-#endif
-
-fromMaybeT :: Monad m => m a -> MaybeT m a -> m a
-fromMaybeT def act = runMaybeT act >>= maybe def return
-
-showErr :: BrittanyError -> String
-showErr (ErrorInput s) = s
-showErr (ErrorMacroConfig err input)
- = "Error: parse error in inline configuration: " ++ err ++ " in the string \"" ++ input ++ "\"."
-showErr (ErrorUnusedComment s) = s
-showErr (LayoutWarning s) = s
-showErr (ErrorUnknownNode s _) = s
-showErr ErrorOutputCheck = "Brittany error - invalid output"
-
-showExtension :: Extension -> Maybe String
-showExtension Cpp = Just "-XCPP"
--- Brittany chokes on parsing extensions that produce warnings
-showExtension DatatypeContexts = Nothing
-showExtension RecordPuns = Just "-XNamedFieldPuns"
-showExtension other = Just $ "-X" ++ show other
-
-getExtensions :: GHC.DynFlags -> [String]
-getExtensions = mapMaybe showExtension . GHC.toList . GHC.extensionFlags
-
-
--- | This is a temporary fix that allows us to format the text if brittany
--- throws warnings during pretty printing.
---
--- It should be removed when our PR to brittany is merged + released.
--- See:
--- - https://github.com/haskell/haskell-language-server/issues/2005
--- - https://github.com/lspitzner/brittany/pull/351
-pPrintText
- :: Config -- ^ global program config
- -> Text -- ^ input text
- -> IO ([BrittanyError], Text) -- ^ list of errors/warnings & result text
-pPrintText config text =
- fmap (either id id) . ExceptT.runExceptT $ do
- let ghcOptions = config & _conf_forward & _options_ghc & runIdentity
- -- there is a good of code duplication between the following code and the
- -- `pureModuleTransform` function. Unfortunately, there are also a good
- -- amount of slight differences: This module is a bit more verbose, and
- -- it tries to use the full-blown `parseModule` function which supports
- -- CPP (but requires the input to be a file..).
- let cppMode = config & _conf_preprocessor & _ppconf_CPPMode & confUnpack
- -- the flag will do the following: insert a marker string
- -- ("-- BRITANY_INCLUDE_HACK ") right before any lines starting with
- -- "#include" before processing (parsing) input; and remove that marker
- -- string from the transformation output.
- -- The flag is intentionally misspelled to prevent clashing with
- -- inline-config stuff.
- let hackAroundIncludes =
- config & _conf_preprocessor & _ppconf_hackAroundIncludes & confUnpack
- let exactprintOnly = viaGlobal || viaDebug
- where
- viaGlobal = config & _conf_roundtrip_exactprint_only & confUnpack
- viaDebug =
- config & _conf_debug & _dconf_roundtrip_exactprint_only & confUnpack
-
- let cppCheckFunc dynFlags = if GHC.xopt GHC.Cpp dynFlags
- then case cppMode of
- CPPModeAbort ->
- return $ Left "Encountered -XCPP. Aborting."
- CPPModeWarn ->
- return $ Right True
- CPPModeNowarn ->
- return $ Right True
- else return $ Right False
- parseResult <- do
- -- TODO: refactor this hack to not be mixed into parsing logic
- let hackF s = if "#include" `List.isPrefixOf` s
- then "-- BRITANY_INCLUDE_HACK " ++ s
- else s
- let hackTransform = if hackAroundIncludes && not exactprintOnly
- then List.intercalate "\n" . fmap hackF . lines'
- else id
- liftIO $ parseModuleFromString ghcOptions
- "stdin"
- cppCheckFunc
- (hackTransform $ Text.unpack text)
- case parseResult of
- Left left -> do
- ExceptT.throwE ([ErrorInput left], text)
- Right (anns, parsedSource, hasCPP) -> do
- (inlineConf, perItemConf) <-
- case
- extractCommentConfigs anns (getTopLevelDeclNameMap parsedSource)
- of
- Left (err, input) -> do
- let errMsg =
- "Error: parse error in inline configuration: "
- <> err
- <> " in the string \""
- <> input
- <> "\"."
- ExceptT.throwE ([ErrorInput errMsg], text)
- Right c ->
- pure c
- let moduleConf = cZipWith fromOptionIdentity config inlineConf
- let disableFormatting =
- moduleConf & _conf_disable_formatting & confUnpack
- (errsWarns, outSText, _) <- do
- if
- | disableFormatting -> do
- pure ([], text, False)
- | exactprintOnly -> do
- let r = Text.pack $ ExactPrint.exactPrint parsedSource anns
- pure ([], r, r /= text)
- | otherwise -> do
- (ews, outRaw) <- if hasCPP
- then return
- $ pPrintModule moduleConf perItemConf anns parsedSource
- else liftIO $ pPrintModuleAndCheck moduleConf
- perItemConf
- anns
- parsedSource
- let hackF s = fromMaybe s $ TextL.stripPrefix
- (TextL.pack "-- BRITANY_INCLUDE_HACK ")
- s
- let out = TextL.toStrict $ if hackAroundIncludes
- then
- TextL.intercalate (TextL.pack "\n")
- $ hackF
- <$> TextL.splitOn (TextL.pack "\n") outRaw
- else outRaw
- out' <- if moduleConf & _conf_obfuscate & confUnpack
- then lift $ obfuscate out
- else pure out
- pure (ews, out', out' /= text)
- let customErrOrder ErrorInput{} = 4
- customErrOrder LayoutWarning{} = -1 :: Int
- customErrOrder ErrorOutputCheck{} = 1
- customErrOrder ErrorUnusedComment{} = 2
- customErrOrder ErrorUnknownNode{} = -2 :: Int
- customErrOrder ErrorMacroConfig{} = 5
- hasErrors =
- if config & _conf_errorHandling & _econf_Werror & confUnpack
- then not $ null errsWarns
- else 0 < maximum (-1 : fmap customErrOrder errsWarns)
- return (errsWarns, if hasErrors then text else outSText)
-
-isError :: BrittanyError -> Bool
-isError = \case
- LayoutWarning{} -> False
- ErrorUnknownNode{} -> False
- _ -> True
diff --git a/plugins/hls-brittany-plugin/test/Main.hs b/plugins/hls-brittany-plugin/test/Main.hs
deleted file mode 100644
index 0483ecbab..000000000
--- a/plugins/hls-brittany-plugin/test/Main.hs
+++ /dev/null
@@ -1,37 +0,0 @@
-{-# LANGUAGE OverloadedStrings #-}
-module Main
- ( main
- ) where
-
-import qualified Ide.Plugin.Brittany as Brittany
-import System.FilePath
-import Test.Hls
-
-main :: IO ()
-main = defaultTestRunner tests
-
-brittanyPlugin :: PluginTestDescriptor ()
-brittanyPlugin = mkPluginTestDescriptor' Brittany.descriptor "brittany"
-
-tests :: TestTree
-tests = testGroup "brittany"
- [ brittanyGolden "formats a document with LF endings" "BrittanyLF" "formatted_document" $ \doc -> do
- formatDoc doc (FormattingOptions 4 True Nothing Nothing Nothing)
-
- , brittanyGolden "formats a document with CRLF endings" "BrittanyCRLF" "formatted_document" $ \doc -> do
- formatDoc doc (FormattingOptions 4 True Nothing Nothing Nothing)
-
- , brittanyGolden "formats a range with LF endings" "BrittanyLF" "formatted_range" $ \doc -> do
- let range = Range (Position 1 0) (Position 2 22)
- formatRange doc (FormattingOptions 4 True Nothing Nothing Nothing) range
-
- , brittanyGolden "formats a range with CRLF endings" "BrittanyCRLF" "formatted_range" $ \doc -> do
- let range = Range (Position 1 0) (Position 2 22)
- formatRange doc (FormattingOptions 4 True Nothing Nothing Nothing) range
- ]
-
-brittanyGolden :: TestName -> FilePath -> FilePath -> (TextDocumentIdentifier -> Session ()) -> TestTree
-brittanyGolden title path desc = goldenWithHaskellDocFormatter brittanyPlugin "brittany" def title testDataDir path desc "hs"
-
-testDataDir :: FilePath
-testDataDir = "test" > "testdata"
diff --git a/plugins/hls-brittany-plugin/test/testdata/BrittanyCRLF.formatted_document.hs b/plugins/hls-brittany-plugin/test/testdata/BrittanyCRLF.formatted_document.hs
deleted file mode 100644
index 5db4c2e08..000000000
--- a/plugins/hls-brittany-plugin/test/testdata/BrittanyCRLF.formatted_document.hs
+++ /dev/null
@@ -1,4 +0,0 @@
-foo :: Int -> String -> IO ()
-foo x y = do
- print x
- return 42
diff --git a/plugins/hls-brittany-plugin/test/testdata/BrittanyCRLF.formatted_range.hs b/plugins/hls-brittany-plugin/test/testdata/BrittanyCRLF.formatted_range.hs
deleted file mode 100644
index ac47ea849..000000000
--- a/plugins/hls-brittany-plugin/test/testdata/BrittanyCRLF.formatted_range.hs
+++ /dev/null
@@ -1,4 +0,0 @@
-foo :: Int -> String-> IO ()
-foo x y = do
- print x
- return 42
diff --git a/plugins/hls-brittany-plugin/test/testdata/BrittanyCRLF.hs b/plugins/hls-brittany-plugin/test/testdata/BrittanyCRLF.hs
deleted file mode 100644
index 2ed3293b3..000000000
--- a/plugins/hls-brittany-plugin/test/testdata/BrittanyCRLF.hs
+++ /dev/null
@@ -1,3 +0,0 @@
-foo :: Int -> String-> IO ()
-foo x y = do print x
- return 42
\ No newline at end of file
diff --git a/plugins/hls-brittany-plugin/test/testdata/BrittanyLF.formatted_document.hs b/plugins/hls-brittany-plugin/test/testdata/BrittanyLF.formatted_document.hs
deleted file mode 100644
index 5db4c2e08..000000000
--- a/plugins/hls-brittany-plugin/test/testdata/BrittanyLF.formatted_document.hs
+++ /dev/null
@@ -1,4 +0,0 @@
-foo :: Int -> String -> IO ()
-foo x y = do
- print x
- return 42
diff --git a/plugins/hls-brittany-plugin/test/testdata/BrittanyLF.formatted_range.hs b/plugins/hls-brittany-plugin/test/testdata/BrittanyLF.formatted_range.hs
deleted file mode 100644
index c2b791456..000000000
--- a/plugins/hls-brittany-plugin/test/testdata/BrittanyLF.formatted_range.hs
+++ /dev/null
@@ -1,4 +0,0 @@
-foo :: Int -> String-> IO ()
-foo x y = do
- print x
- return 42
diff --git a/plugins/hls-brittany-plugin/test/testdata/BrittanyLF.hs b/plugins/hls-brittany-plugin/test/testdata/BrittanyLF.hs
deleted file mode 100644
index 4662d9b5a..000000000
--- a/plugins/hls-brittany-plugin/test/testdata/BrittanyLF.hs
+++ /dev/null
@@ -1,3 +0,0 @@
-foo :: Int -> String-> IO ()
-foo x y = do print x
- return 42
\ No newline at end of file
diff --git a/plugins/hls-brittany-plugin/test/testdata/hie.yaml b/plugins/hls-brittany-plugin/test/testdata/hie.yaml
deleted file mode 100644
index 824558147..000000000
--- a/plugins/hls-brittany-plugin/test/testdata/hie.yaml
+++ /dev/null
@@ -1,3 +0,0 @@
-cradle:
- direct:
- arguments: []
diff --git a/src/HlsPlugins.hs b/src/HlsPlugins.hs
index 21f1ec4e9..f341208bf 100644
--- a/src/HlsPlugins.hs
+++ b/src/HlsPlugins.hs
@@ -122,10 +122,6 @@ import qualified Ide.Plugin.Ormolu as Ormolu
import qualified Ide.Plugin.StylishHaskell as StylishHaskell
#endif
-#if hls_brittany
-import qualified Ide.Plugin.Brittany as Brittany
-#endif
-
#if hls_refactor
import qualified Development.IDE.Plugin.CodeAction as Refactor
#endif
@@ -178,9 +174,6 @@ idePlugins recorder = pluginDescToIdePlugins allPlugins
#if hls_retrie
Retrie.descriptor "retrie" :
#endif
-#if hls_brittany
- Brittany.descriptor "brittany" :
-#endif
#if hls_callHierarchy
CallHierarchy.descriptor "callHierarchy" :
#endif
diff --git a/stack-lts19.yaml b/stack-lts19.yaml
index 74d90c336..d30f96d59 100644
--- a/stack-lts19.yaml
+++ b/stack-lts19.yaml
@@ -23,7 +23,6 @@ packages:
- ./plugins/hls-splice-plugin
- ./plugins/hls-tactics-plugin
- ./plugins/hls-qualify-imported-names-plugin
- - ./plugins/hls-brittany-plugin
- ./plugins/hls-stylish-haskell-plugin
- ./plugins/hls-floskell-plugin
- ./plugins/hls-fourmolu-plugin
diff --git a/stack.yaml b/stack.yaml
index b92448278..b303ed245 100644
--- a/stack.yaml
+++ b/stack.yaml
@@ -23,7 +23,6 @@ packages:
# - ./plugins/hls-retrie-plugin
# - ./plugins/hls-splice-plugin
# - ./plugins/hls-tactics-plugin
-# - ./plugins/hls-brittany-plugin
- ./plugins/hls-stylish-haskell-plugin
- ./plugins/hls-floskell-plugin
- ./plugins/hls-fourmolu-plugin
@@ -72,7 +71,6 @@ flags:
pedantic: true
ignore-plugins-ghc-bounds: true
- brittany: false
haddockComments: false
retrie: false
splice: false