Skip to content

Plugin tutorial, more changes #4570

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 8 commits into from
May 23, 2025
Merged

Plugin tutorial, more changes #4570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8e02780
Plugin tutorial, more changes
dschrempf Apr 23, 2025
f2cd897
Update Nix Flake lock (this makes GHC 9.8 the default)
dschrempf May 18, 2025
985f726
Review comments and other improvments, thanks @VeryMilkyJoe.
dschrempf May 18, 2025
db128ec
Compile plugin-tutorial using markdown-unlit
fendor May 19, 2025
8ed60a0
Remove out-of-date references
fendor May 19, 2025
21f5f62
Add plugin-tutorial to CI
fendor May 19, 2025
4aff2f3
Only build the plugin-tutorial with GHC 9.6 and 9.8
fendor May 20, 2025
6c22e2c
Add explanation for preamble
fendor May 20, 2025
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
6 changes: 6 additions & 0 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,12 @@ jobs:
name: Test hls-notes-plugin test suite
run: cabal test hls-notes-plugin-tests || cabal test hls-notes-plugin-tests

# The plugin tutorial is only compatible with 9.6 and 9.8.
# No particular reason, just to avoid excessive CPP.
- if: matrix.test && matrix.ghc != '9.4' && matrix.ghc != '9.10' && matrix.ghc != '9.12'
name: Compile the plugin-tutorial
run: cabal build plugin-tutorial

test_post_job:
if: always()
runs-on: ubuntu-latest
Expand Down
1 change: 1 addition & 0 deletions docs/contributing/plugin-tutorial.lhs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
plugin-tutorial.md
520 changes: 272 additions & 248 deletions docs/contributing/plugin-tutorial.md
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions flake.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions ghcide/src/Development/IDE/GHC/Compat/Core.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,7 @@
SrcLoc.noSrcSpan,
SrcLoc.noSrcLoc,
SrcLoc.noLoc,
SrcLoc.srcSpanToRealSrcSpan,
mapLoc,
-- * Finder
FindResult(..),
Expand Down Expand Up @@ -488,8 +489,8 @@
moduleUnit, toUnitId)
import qualified GHC.Unit.Module as Module
import GHC.Unit.State (ModuleOrigin (..))
import GHC.Utils.Error (Severity (..), emptyMessages)

Check warning on line 492 in ghcide/src/Development/IDE/GHC/Compat/Core.hs

View workflow job for this annotation

GitHub Actions / Hlint check run 

Warning in module Development.IDE.GHC.Compat.Core: Use fewer imports ▫︎ Found: "import GHC.Utils.Error ( Severity(..), emptyMessages )\nimport GHC.Utils.Error ( mkPlainErrorMsgEnvelope )\n" ▫︎ Perhaps: "import GHC.Utils.Error\n ( Severity(..), emptyMessages, mkPlainErrorMsgEnvelope )\n"
import GHC.Utils.Panic hiding (try)

Check warning on line 493 in ghcide/src/Development/IDE/GHC/Compat/Core.hs

View workflow job for this annotation

GitHub Actions / Hlint check run 

Warning in module Development.IDE.GHC.Compat.Core: Use fewer imports ▫︎ Found: "import GHC.Utils.Panic hiding ( try )\nimport GHC.Utils.Panic\n" ▫︎ Perhaps: "import GHC.Utils.Panic\n"
import qualified GHC.Utils.Panic.Plain as Plain


Expand Down
25 changes: 25 additions & 0 deletions haskell-language-server.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2265,3 +2265,28 @@ test-suite ghcide-bench-test
OverloadedStrings
RecordWildCards
ViewPatterns

executable plugin-tutorial
import: defaults
-- The plugin tutorial is only compatible with 9.6 and 9.8.
-- No particular reason, just to avoid excessive CPP.
if (impl(ghc >= 9.6) && impl(ghc < 9.10))
buildable: True
else
buildable: False
ghc-options: -pgmL markdown-unlit
main-is: docs/contributing/plugin-tutorial.lhs
build-tool-depends: markdown-unlit:markdown-unlit
build-depends:
base,
ghcide,
hls-plugin-api,
aeson,
lsp,
lsp-types,
markdown-unlit,
text,
unordered-containers,
containers,
transformers,
ghc,
2 changes: 0 additions & 2 deletions plugins/hls-refactor-plugin/src/Development/IDE/Plugin/CodeAction.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,15 +121,13 @@ import GHC (AddEpAnn (Ad
EpaLocation,
EpaLocation' (..),
HasLoc (..))
import GHC.Types.SrcLoc (srcSpanToRealSrcSpan)
#endif
#if MIN_VERSION_ghc(9,11,0)
import GHC (EpaLocation,
AnnsModule (am_where),
EpaLocation' (..),
HasLoc (..),
EpToken (..))
import GHC.Types.SrcLoc (srcSpanToRealSrcSpan)
#endif


Expand Down
Loading