Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waddlaw/haskell-stack-trace-plugin
https://github.com/waddlaw/haskell-stack-trace-plugin
compiler-plugin haskell source-plugin
Last synced: about 6 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/waddlaw/haskell-stack-trace-plugin
- Owner: waddlaw
- License: mit
- Created: 2018-12-07T06:06:43.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2022-10-24T21:17:07.000Z (about 2 years ago)
- Last Synced: 2024-04-24T20:28:12.688Z (7 months ago)
- Topics: compiler-plugin, haskell, source-plugin
- Language: Haskell
- Size: 37.1 KB
- Stars: 18
- Watchers: 3
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: Readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# haskell-stack-trace-plugin
[](https://hackage.haskell.org/package/haskell-stack-trace-plugin)
This plugin allow implicitly add `HasCallStack` class to every top-level function for all module. Hence, we can to get completely continuous call stack.
1. (implicitly) Import [GHC.Stack](https://hackage.haskell.org/package/base/docs/GHC-Stack.html) for all modules.
2. Add [HasCallStack](https://hackage.haskell.org/package/base/docs/GHC-Stack.html#t:HasCallStack) constraint for all top-level functions.
3. Other supported syntaxes
- [x] `where` clause
Requirement: (8.6 <= on GHC)
## Synopsis
```haskell
module Main where
import Data.Maybe (fromJust)
main :: IO ()
main = print f1
f1 :: Int
f1 = f2
f2 :: Int
f2 = f3
-- HsQualTy
f3 :: HasCallStack => Int
f3 = f4 0
-- HsQualTy
f4 :: Show a => a -> Int
f4 n = f5 (show n) 0
-- HsFunTy
f5 :: String -> Int -> Int
f5 _ _ = head f6
-- HsListTy
f6 :: [Int]
f6 = [fst f7]
-- HsTupleTy
f7 :: (Int, Int)
f7 = (fromJust f8, fromJust f8)
-- HsAppTy
f8 :: Maybe Int
f8 = Just f9
f9 :: Int
f9 = f10
where
f10 :: Int
f10 = fError
-- HsTyVar
fError :: Int
fError = error "fError"
```
This example get error:
```shell
$ cabal build
example/Main.hs:15:7: error:
Not in scope: type constructor or class ‘HasCallStack’
|
15 | f3 :: HasCallStack => Int
| ^^^^^^^^^^^^
```
Yes, add `import GHC.Stack` to above example.
Fix and rebuild!
```shell
$ cabal run example -v0
example: fError
CallStack (from HasCallStack):
error, called at example/Main.hs:47:10 in main:Main
```
Hmm, it is not useful. But, you will to be happy when enable this plugin.
```cabal
ghc-options:
-fplugin=StackTrace.Plugin
```
```shell
$ cabal run example -v0
example: fError
CallStack (from HasCallStack):
error, called at example/Main.hs:47:10 in main:Main
fError, called at example/Main.hs:43:11 in main:Main
f10, called at example/Main.hs:40:6 in main:Main
f9, called at example/Main.hs:37:11 in main:Main
f8, called at example/Main.hs:33:16 in main:Main
f7, called at example/Main.hs:29:11 in main:Main
f6, called at example/Main.hs:25:15 in main:Main
f5, called at example/Main.hs:21:8 in main:Main
f4, called at example/Main.hs:17:6 in main:Main
f3, called at example/Main.hs:13:6 in main:Main
f2, called at example/Main.hs:10:6 in main:Main
f1, called at example/Main.hs:7:14 in main:Main
main, called at example/Main.hs:7:1 in main:Main
```
Great!!!