Skip to content

Fix -Wall and -Wunused-packages in explicit-record-fields plugin #3996

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 20, 2024
Merged

Fix -Wall and -Wunused-packages in explicit-record-fields plugin #3996

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89a3acb
Fix -Wall and -Wunused-packages in explicit-record-fields plugin
jhrcek Jan 20, 2024
e5089dc
Don't remove -Wwarn=incomplete-record-updates
jhrcek Jan 20, 2024
56db1a7
Merge branch 'master' into jhrcek/unused-packages-explicit-record-fields
mergify[bot] Jan 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions plugins/hls-explicit-record-fields-plugin/hls-explicit-record-fields-plugin.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,13 @@ flag pedantic
manual: True

common warnings
ghc-options: -Wall
ghc-options: -Wall -Wunused-packages -Wincomplete-record-updates

library
import: warnings
exposed-modules: Ide.Plugin.ExplicitFields
-- other-modules:
-- other-extensions:
build-depends:
, base >=4.12 && <5
, ghc
, ghcide == 2.6.0.0
, hls-plugin-api == 2.6.0.0
, lsp
Expand All @@ -43,22 +40,17 @@ library
, text
, syb
, transformers
, ghc-boot-th
, unordered-containers
, containers
, aeson
hs-source-dirs: src
default-language: Haskell2010

if flag(pedantic)
ghc-options: -Werror
-Wwarn=incomplete-record-updates
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jhrcek Now that I look into it, I think the reason it was specified this way was that the plugin is making use of incomplete record updates. The failing test on CI shows where that happens. Off the top of my head I can't think of a straightforward way to eliminate it, as it happens while modifying the AST given by GHC. Maybe you have come across a better way to do this while fixing these warnings for the other plugins?

Copy link
Collaborator

@ozkutuk ozkutuk Jan 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specifically, this section of GHC options means that "We want warnings to be promoted to errors (-Werror), except for the incomplete record updates warning". Unless there is a compelling reason to change this, I think this is a sensible setting for this specific plugin.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GHC options on specific files take priority, so I'd be inclined to put the -Wwarn option on the module with the problem and add a comment

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand the semantic of -Werror and how -Wwarn turns it into warning only. I just wasn't sure why it's here (because cabal build --flag=pedantic for this plugin didn't throw any error.
Let me put it back for now and deal with fixing these kinds of warnings separately later.


test-suite tests
import: warnings
default-language: Haskell2010
-- other-modules:
-- other-extensions:
type: exitcode-stdio-1.0
hs-source-dirs: test
main-is: Main.hs
Expand All @@ -67,5 +59,4 @@ test-suite tests
, filepath
, text
, hls-explicit-record-fields-plugin
, lsp-test
, hls-test-utils
4 changes: 2 additions & 2 deletions plugins/hls-explicit-record-fields-plugin/src/Ide/Plugin/ExplicitFields.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ import Development.IDE.Core.RuleTypes (TcModuleResult (..),
TypeCheck (..))
import qualified Development.IDE.Core.Shake as Shake
import Development.IDE.GHC.Compat (HsConDetails (RecCon),
HsExpansion (HsExpanded),
HsExpr (XExpr),
HsRecFields (..), LPat,
Outputable, getLoc,
recDotDot, unLoc)
Expand Down Expand Up @@ -85,8 +87,6 @@ import Language.LSP.Protocol.Types (CodeAction (..),
WorkspaceEdit (WorkspaceEdit),
type (|?) (InL, InR))

import Development.IDE.GHC.Compat (HsExpansion (HsExpanded),
HsExpr (XExpr))

data Log
= LogShake Shake.Log
Expand Down