ghcitui/ghcitui.cabal

cabal-version:      2.4
name:               ghcitui
version:            0.4.1.0
synopsis:           A Terminal User Interface (TUI) for GHCi

description:
  A terminal user interface for GHCi debug mode.
  .
  Features:
  .
  * A source view window, with debug keybindings.
  .
  * Live variable bindings.
  .
  * Live loaded modules.
  .
  * Visible trace history.
  .
  * An GHCi session in the current context.

author:             Jordan 'Crystal' R AW
bug-reports:        https://github.com/CrystalSplitter/ghcitui/issues
category:           Debug
copyright:          Jordan 'Crystal' R AW
homepage:           https://github.com/CrystalSplitter/ghcitui
license-file:       LICENSE
license:            BSD-3-Clause
maintainer:         crystal@crystalwobsite.gay
stability:          experimental
tested-with:        GHC == 9.2.8
                    ||==9.4.7
                    ||==9.4.8
                    ||==9.8.1
                    ||==9.8.2

extra-source-files: LICENSE
                    , assets/splash.txt
                    , gen/MANUAL.txt
extra-doc-files: CHANGELOG.md
                 , MANUAL.rst
                 , README.md
                 , docs/assets/20240116_splash.png

source-repository head
    type:       git
    location:   https://github.com/CrystalSplitter/ghcitui

executable ghcitui
    main-is:            Main.hs
    build-depends:      base >= 4.16 && < 5
                        , ghcitui-brick
                        , optparse-applicative >= 0.17 && < 0.19
                        , ghcitui
                        , text
    hs-source-dirs:     app
    other-modules:      Paths_ghcitui
    autogen-modules:    Paths_ghcitui
    ghc-options:        -rtsopts
                        -threaded
                        -Wall
                        -Wcompat
                        -Wincomplete-record-updates
                        -Wpartial-fields
                        -Wredundant-constraints
    default-language:   Haskell2010
    default-extensions: MonoLocalBinds
                        OverloadedStrings
                        RecordWildCards

library
    hs-source-dirs:     lib/ghcitui-core
    build-depends:      base >= 4.16 && < 5
                        , array ^>= 0.5
                        , containers >= 0.6.8 && < 0.8
                        , errors >= 2.2 && < 2.4
                        -- Needed to limit ghcid compat.
                        , extra >= 1.7.14 && < 1.9
                        , ghcid >= 0.8.8 && < 0.9
                        , regex-base ^>= 0.94.0.2
                        , regex-tdfa >= 1.3.2 && < 1.4
                        , string-interpolate >= 0.3.2.1 && < 0.4
                        -- Pinned to less than 2.1.2, because it breaks
                        -- with FSNotify.
                        , text >= 2.0 && < 2.3
                        , fsnotify ^>= 0.4.1.0
                        , transformers ^>= 0.6.1.0
                        -- Needed to limit string-interpolate compat.
                        , utf8-string >= 1.0.2 && < 1.1
    exposed-modules:    Ghcitui.Ghcid.Daemon
                        , Ghcitui.Ghcid.LogConfig
                        , Ghcitui.Ghcid.ParseContext
                        , Ghcitui.Ghcid.ParseError
                        , Ghcitui.Ghcid.ParseTabCompletions
                        , Ghcitui.Loc
                        , Ghcitui.NameBinding
                        , Ghcitui.Util
    other-modules:      Ghcitui.Ghcid.StartupConfig
    ghc-options:        -Wall
                        -Wcompat
                        -Wincomplete-record-updates
                        -Wpartial-fields
                        -Wredundant-constraints
    default-language:   Haskell2010
    default-extensions: DuplicateRecordFields
                        MonoLocalBinds
                        NamedFieldPuns
                        OverloadedStrings
                        RecordWildCards
                        TupleSections

library ghcitui-brick
    hs-source-dirs:     lib/ghcitui-brick
    build-depends:      base >= 4.16 && < 5
                        , brick >= 2.2 && < 2.5
                        , containers
                        , errors
                        , file-embed ^>= 0.0.15
                        , ghcitui
                        , microlens >= 0.4.0.1 && < 0.5
                        , microlens-th ^>= 0.4
                        , text
                        , text-zipper ^>= 0.13
                        , vector >= 0.10 && < 0.14
                        , vty >= 5.38 && < 6.3
                        , word-wrap ^>= 0.5
    exposed-modules:    Ghcitui.Brick
    other-modules:      Ghcitui.Brick.AppConfig
                        , Ghcitui.Brick.AppInterpState
                        , Ghcitui.Brick.AppState
                        , Ghcitui.Brick.AppTopLevel
                        , Ghcitui.Brick.BrickUI
                        , Ghcitui.Brick.DrawSourceViewer
                        , Ghcitui.Brick.Events
                        , Ghcitui.Brick.EventUtils
                        , Ghcitui.Brick.HelpText
                        , Ghcitui.Brick.InterpWindowEvents
                        , Ghcitui.Brick.SourceWindow
                        , Ghcitui.Brick.SourceWindowEvents
                        , Ghcitui.Brick.SplashTextEmbed
    ghc-options:        -Wall
                        -Wcompat
                        -Wincomplete-record-updates
                        -Wpartial-fields
                        -Wredundant-constraints
    default-language:   Haskell2010
    default-extensions: DuplicateRecordFields
                        LambdaCase
                        MonoLocalBinds
                        NamedFieldPuns
                        OverloadedStrings
                        RecordWildCards
                        TupleSections


test-suite spec
    hs-source-dirs:     test
    main-is:            Spec.hs
    type:               exitcode-stdio-1.0
    build-depends:      base >= 4.16 && < 5
                        , text
                        , ghcitui
                        , hspec ^>= 2.11.5
    other-modules:      LocSpec
                        , ParseContextSpec
                        , UtilSpec
    default-language:   Haskell2010
Initial commit 2023-06-01 06:26:13 +03:00			`cabal-version: 2.4`
			`name: ghcitui`
Force upgrade fsnotify This breaks for whatever reason only on hackage. It appears ghcid depends on fsnotify as an executable, but not as a library. We're not using it as an executable, but perhaps the documentation is breaking on it. I'm uncertain why we're building the executable dependencies, but until that's fixed we can't do anything except either downgrade text or force upgrade fsnotify. 2024-11-17 06:11:38 +03:00			`version: 0.4.1.0`
Clear revisions that are already restricted by the library 2023-10-08 12:12:55 +03:00			`synopsis: A Terminal User Interface (TUI) for GHCi`
Initial commit 2023-06-01 06:26:13 +03:00
Update cabal file 2023-10-09 04:25:22 +03:00			`description:`
Reorganise modules, clean up formatting This moves the ghcitui libs which don't require Brick to ghcitui-core, and the other library files to ghcitui-brick. 2024-01-15 09:20:47 +03:00			`A terminal user interface for GHCi debug mode.`
			`.`
Update cabal file 2023-10-09 04:25:22 +03:00			`Features:`
Reorganise modules, clean up formatting This moves the ghcitui libs which don't require Brick to ghcitui-core, and the other library files to ghcitui-brick. 2024-01-15 09:20:47 +03:00			`.`
			`* A source view window, with debug keybindings.`
			`.`
			`* Live variable bindings.`
			`.`
			`* Live loaded modules.`
			`.`
			`* Visible trace history.`
			`.`
			`* An GHCi session in the current context.`
Initial commit 2023-06-01 06:26:13 +03:00
Update cabal file with more correct version bounds This uses the --prefer-oldest flag to find what the correct bottom bounds should be for some package versions. 2024-01-21 06:46:47 +03:00			`author: Jordan 'Crystal' R AW`
Update ghcitui.cabal with version change, metadata This prepares version 0.1.0.0. 2024-01-22 04:49:21 +03:00			`bug-reports: https://github.com/CrystalSplitter/ghcitui/issues`
Reorganise modules, clean up formatting This moves the ghcitui libs which don't require Brick to ghcitui-core, and the other library files to ghcitui-brick. 2024-01-15 09:20:47 +03:00			`category: Debug`
Update ghcitui.cabal with version change, metadata This prepares version 0.1.0.0. 2024-01-22 04:49:21 +03:00			`copyright: Jordan 'Crystal' R AW`
			`homepage: https://github.com/CrystalSplitter/ghcitui`
			`license-file: LICENSE`
			`license: BSD-3-Clause`
			`maintainer: crystal@crystalwobsite.gay`
Mark package as experimental 2024-01-22 05:08:14 +03:00			`stability: experimental`
Update for 0.2.0.0 This updates: - The CHANGELOG.md. - The cabal version number. 2024-02-12 01:14:21 +03:00			`tested-with: GHC == 9.2.8`
			`\|\|==9.4.7`
			`\|\|==9.4.8`
			`\|\|==9.8.1`
Update brick version 2024-08-16 05:00:40 +03:00			`\|\|==9.8.2`
Update ghcitui.cabal with version change, metadata This prepares version 0.1.0.0. 2024-01-22 04:49:21 +03:00
Fix cabal check warnings 2024-01-16 00:15:21 +03:00			`extra-source-files: LICENSE`
Embed splash text directly 2024-01-17 09:50:39 +03:00			`, assets/splash.txt`
Add MANUAL generation This is pretty hacky, but does produce very pretty results. 2024-01-15 10:06:34 +03:00			`, gen/MANUAL.txt`
Fix cabal check warnings 2024-01-16 00:15:21 +03:00			`extra-doc-files: CHANGELOG.md`
			`, MANUAL.rst`
			`, README.md`
Fix cabal check warnings, update workflow 2024-01-17 12:07:22 +03:00			`, docs/assets/20240116_splash.png`
Initial commit 2023-06-01 06:26:13 +03:00
Add basic HSpec testing 2023-10-13 10:13:42 +03:00			`source-repository head`
			`type: git`
			`location: https://github.com/CrystalSplitter/ghcitui`

Initial commit 2023-06-01 06:26:13 +03:00			`executable ghcitui`
Some more early development 2023-06-07 08:19:12 +03:00			`main-is: Main.hs`
Update cabal file with more correct version bounds This uses the --prefer-oldest flag to find what the correct bottom bounds should be for some package versions. 2024-01-21 06:46:47 +03:00			`build-depends: base >= 4.16 && < 5`
Reorganise modules, clean up formatting This moves the ghcitui libs which don't require Brick to ghcitui-core, and the other library files to ghcitui-brick. 2024-01-15 09:20:47 +03:00			`, ghcitui-brick`
Update cabal file with more correct version bounds This uses the --prefer-oldest flag to find what the correct bottom bounds should be for some package versions. 2024-01-21 06:46:47 +03:00			`, optparse-applicative >= 0.17 && < 0.19`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`, ghcitui`
Make package dependencies DRY This removes all the duplicate version numbers for the executable/non-base libraries. 2024-01-22 05:31:03 +03:00			`, text`
Some more early development 2023-06-07 08:19:12 +03:00			`hs-source-dirs: app`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`other-modules: Paths_ghcitui`
Mark Paths_ghcitui as autogen 2024-01-15 10:25:40 +03:00			`autogen-modules: Paths_ghcitui`
Some more early development 2023-06-07 08:19:12 +03:00			`ghc-options: -rtsopts`
			`-threaded`
			`-Wall`
			`-Wcompat`
			`-Wincomplete-record-updates`
			`-Wpartial-fields`
			`-Wredundant-constraints`
			`default-language: Haskell2010`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`default-extensions: MonoLocalBinds`
Some more early development 2023-06-07 08:19:12 +03:00			`OverloadedStrings`
			`RecordWildCards`
Initial commit 2023-06-01 06:26:13 +03:00
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`library`
Reorganise modules, clean up formatting This moves the ghcitui libs which don't require Brick to ghcitui-core, and the other library files to ghcitui-brick. 2024-01-15 09:20:47 +03:00			`hs-source-dirs: lib/ghcitui-core`
Update cabal file with more correct version bounds This uses the --prefer-oldest flag to find what the correct bottom bounds should be for some package versions. 2024-01-21 06:46:47 +03:00			`build-depends: base >= 4.16 && < 5`
			`, array ^>= 0.5`
			`, containers >= 0.6.8 && < 0.8`
			`, errors >= 2.2 && < 2.4`
			`-- Needed to limit ghcid compat.`
Update revision, add changelog, update dependencies This is readies us for the release for 0.4.0.0 2024-11-16 07:34:58 +03:00			`, extra >= 1.7.14 && < 1.9`
Update cabal file with more correct version bounds This uses the --prefer-oldest flag to find what the correct bottom bounds should be for some package versions. 2024-01-21 06:46:47 +03:00			`, ghcid >= 0.8.8 && < 0.9`
Support multiline source ranges 2023-09-20 11:23:52 +03:00			`, regex-base ^>= 0.94.0.2`
Update cabal file with more correct version bounds This uses the --prefer-oldest flag to find what the correct bottom bounds should be for some package versions. 2024-01-21 06:46:47 +03:00			`, regex-tdfa >= 1.3.2 && < 1.4`
Update revision, add changelog, update dependencies This is readies us for the release for 0.4.0.0 2024-11-16 07:34:58 +03:00			`, string-interpolate >= 0.3.2.1 && < 0.4`
Force upgrade fsnotify This breaks for whatever reason only on hackage. It appears ghcid depends on fsnotify as an executable, but not as a library. We're not using it as an executable, but perhaps the documentation is breaking on it. I'm uncertain why we're building the executable dependencies, but until that's fixed we can't do anything except either downgrade text or force upgrade fsnotify. 2024-11-17 06:11:38 +03:00			`-- Pinned to less than 2.1.2, because it breaks`
			`-- with FSNotify.`
			`, text >= 2.0 && < 2.3`
			`, fsnotify ^>= 0.4.1.0`
Module box + more 2023-10-02 08:43:10 +03:00			`, transformers ^>= 0.6.1.0`
Update cabal file with more correct version bounds This uses the --prefer-oldest flag to find what the correct bottom bounds should be for some package versions. 2024-01-21 06:46:47 +03:00			`-- Needed to limit string-interpolate compat.`
			`, utf8-string >= 1.0.2 && < 1.1`
Add submodule Ghcitui for all library components Potentially, we should re-export the important bits. But for now this seems to work fine. 2023-12-31 07:59:58 +03:00			`exposed-modules: Ghcitui.Ghcid.Daemon`
Clean up Daemon start up and messaging 2024-01-11 09:46:00 +03:00			`, Ghcitui.Ghcid.LogConfig`
Fix cabal check warnings 2024-01-16 00:15:21 +03:00			`, Ghcitui.Ghcid.ParseContext`
Implement tab completion This provides the GHCi Repl inside GHCiTUI with basic tab completion. This is slightly more advanced than the standard GHCi tab completion, but not by much. This commit also moves around some error and parsing code to help in this effort. Co-authored-by: CrystalSplitter <crystal@crystalwobsite.gay> 2024-02-03 12:00:58 +03:00			`, Ghcitui.Ghcid.ParseError`
			`, Ghcitui.Ghcid.ParseTabCompletions`
Add submodule Ghcitui for all library components Potentially, we should re-export the important bits. But for now this seems to work fine. 2023-12-31 07:59:58 +03:00			`, Ghcitui.Loc`
			`, Ghcitui.NameBinding`
Fix cabal check warnings 2024-01-16 00:15:21 +03:00			`, Ghcitui.Util`
Clean up Daemon start up and messaging 2024-01-11 09:46:00 +03:00			`other-modules: Ghcitui.Ghcid.StartupConfig`
Add basic HSpec testing 2023-10-13 10:13:42 +03:00			`ghc-options: -Wall`
Support multiline source ranges 2023-09-20 11:23:52 +03:00			`-Wcompat`
			`-Wincomplete-record-updates`
			`-Wpartial-fields`
			`-Wredundant-constraints`
Some more early development 2023-06-07 08:19:12 +03:00			`default-language: Haskell2010`
Fix cabal check warnings 2024-01-16 00:15:21 +03:00			`default-extensions: DuplicateRecordFields`
			`MonoLocalBinds`
			`NamedFieldPuns`
Some more early development 2023-06-07 08:19:12 +03:00			`OverloadedStrings`
			`RecordWildCards`
Update cabal file 2023-08-03 08:45:17 +03:00			`TupleSections`
Add NamedFieldPuns to default extensions 2024-01-13 23:43:37 +03:00
Reorganise modules, clean up formatting This moves the ghcitui libs which don't require Brick to ghcitui-core, and the other library files to ghcitui-brick. 2024-01-15 09:20:47 +03:00			`library ghcitui-brick`
			`hs-source-dirs: lib/ghcitui-brick`
Make package dependencies DRY This removes all the duplicate version numbers for the executable/non-base libraries. 2024-01-22 05:31:03 +03:00			`build-depends: base >= 4.16 && < 5`
Update brick version 2024-08-16 05:00:40 +03:00			`, brick >= 2.2 && < 2.5`
Make package dependencies DRY This removes all the duplicate version numbers for the executable/non-base libraries. 2024-01-22 05:31:03 +03:00			`, containers`
			`, errors`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`, file-embed ^>= 0.0.15`
			`, ghcitui`
Update cabal file with more correct version bounds This uses the --prefer-oldest flag to find what the correct bottom bounds should be for some package versions. 2024-01-21 06:46:47 +03:00			`, microlens >= 0.4.0.1 && < 0.5`
			`, microlens-th ^>= 0.4`
Make package dependencies DRY This removes all the duplicate version numbers for the executable/non-base libraries. 2024-01-22 05:31:03 +03:00			`, text`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`, text-zipper ^>= 0.13`
Update cabal file with more correct version bounds This uses the --prefer-oldest flag to find what the correct bottom bounds should be for some package versions. 2024-01-21 06:46:47 +03:00			`, vector >= 0.10 && < 0.14`
Update vty dependency 2024-02-12 00:48:15 +03:00			`, vty >= 5.38 && < 6.3`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`, word-wrap ^>= 0.5`
			`exposed-modules: Ghcitui.Brick`
			`other-modules: Ghcitui.Brick.AppConfig`
			`, Ghcitui.Brick.AppInterpState`
			`, Ghcitui.Brick.AppState`
			`, Ghcitui.Brick.AppTopLevel`
			`, Ghcitui.Brick.BrickUI`
			`, Ghcitui.Brick.DrawSourceViewer`
			`, Ghcitui.Brick.Events`
Restructure Brick.Events This moves a lot of the logic out of Brick.Events, to make it easier to isolate which module parts are shared, and which parts are specific to individual event handlers. 2024-11-09 10:07:11 +03:00			`, Ghcitui.Brick.EventUtils`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`, Ghcitui.Brick.HelpText`
Restructure Brick.Events This moves a lot of the logic out of Brick.Events, to make it easier to isolate which module parts are shared, and which parts are specific to individual event handlers. 2024-11-09 10:07:11 +03:00			`, Ghcitui.Brick.InterpWindowEvents`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`, Ghcitui.Brick.SourceWindow`
Restructure Brick.Events This moves a lot of the logic out of Brick.Events, to make it easier to isolate which module parts are shared, and which parts are specific to individual event handlers. 2024-11-09 10:07:11 +03:00			`, Ghcitui.Brick.SourceWindowEvents`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`, Ghcitui.Brick.SplashTextEmbed`
Reorganise modules, clean up formatting This moves the ghcitui libs which don't require Brick to ghcitui-core, and the other library files to ghcitui-brick. 2024-01-15 09:20:47 +03:00			`ghc-options: -Wall`
			`-Wcompat`
			`-Wincomplete-record-updates`
			`-Wpartial-fields`
			`-Wredundant-constraints`
			`default-language: Haskell2010`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`default-extensions: DuplicateRecordFields`
			`LambdaCase`
Reorganise modules, clean up formatting This moves the ghcitui libs which don't require Brick to ghcitui-core, and the other library files to ghcitui-brick. 2024-01-15 09:20:47 +03:00			`MonoLocalBinds`
			`NamedFieldPuns`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`OverloadedStrings`
			`RecordWildCards`
			`TupleSections`

Add basic HSpec testing 2023-10-13 10:13:42 +03:00
			`test-suite spec`
			`hs-source-dirs: test`
			`main-is: Spec.hs`
			`type: exitcode-stdio-1.0`
Update cabal file with more correct version bounds This uses the --prefer-oldest flag to find what the correct bottom bounds should be for some package versions. 2024-01-21 06:46:47 +03:00			`build-depends: base >= 4.16 && < 5`
Match on functions that have apostraphes Apostraphes are of course valid haskell characters in function names. The current ParseContext did not understand this. Fixes #38 hopefully 2024-03-05 09:03:41 +03:00			`, text`
Reorganise modules to create the Ghcitui.Brick module 2024-01-19 12:27:45 +03:00			`, ghcitui`
Fix cabal check warnings 2024-01-16 00:15:21 +03:00			`, hspec ^>= 2.11.5`
Add basic HSpec testing 2023-10-13 10:13:42 +03:00			`other-modules: LocSpec`
Match on functions that have apostraphes Apostraphes are of course valid haskell characters in function names. The current ParseContext did not understand this. Fixes #38 hopefully 2024-03-05 09:03:41 +03:00			`, ParseContextSpec`
Rename StringUtil.hs to Util.hs 2023-10-15 07:41:43 +03:00			`, UtilSpec`
Add basic HSpec testing 2023-10-13 10:13:42 +03:00			`default-language: Haskell2010`