[英]How to debug with PureScript?
以下是一个最小的人为示例:
read :: FilePath -> Aff String
read f = do
log ("File: " <> f) -- (1)
readTextFile UTF8 f -- (2)
在(2)
发生潜在错误之前,我想在(1)
中进行一些调试日志记录。 到目前为止,在 Spago REPL 中执行以下代码适用于成功案例:
$ spago repl
> launchAff_ $ read "test/data/tree/root.txt"
File: test/data/tree/root.txt
unit
问题:如果(2)
有错误 - file is directory here -, (1)
似乎根本没有执行:
$ spago repl
> launchAff_ $ read "test/data/tree"
~/purescript-book/exercises/chapter9/.psci_modules/node_modules/Effect.Aff/foreign.js:532
throw util.fromLeft(step);
^
[Error: EISDIR: illegal operation on a directory, read] {
errno: -21,
code: 'EISDIR',
syscall: 'read'
}
最初的问题更复杂,包括几层递归(参见电子书练习 3 ),我需要记录以调试上述错误。
首先,您观察到的症状并不意味着第一行没有执行。 它总是执行,由于控制台在 PureScript REPL 中的工作方式,您只是看不到 output 。 output 被吞下。 可悲的是,这不是 REPL 的唯一问题。
您可以通过将log
替换为throwError
并观察始终抛出错误来验证第一行是否始终执行。 或者,您可以让第一行修改可变单元格而不是写入控制台,然后检查单元格的内容。
最后,这只发生在 REPL 中。 如果将launchAff_
调用放在main
中并运行程序,您将始终得到控制台 output。
现在到手头的实际问题:如何调试跟踪。
如果您负担得起,登录到控制台是可以的,但有一种更优雅的方式: Debug.Trace.trace
。
这个 function 有一个隐藏的效果 - 即它的类型说它是纯的,但它在调用时确实会产生效果。 这个小谎言让您可以在纯设置中使用trace
,从而调试纯代码。 不需要Effect
,只要用于调试就可以了。 但不要把它放在生产代码中。
它的工作方式是它需要两个参数:第一个打印到控制台,第二个是打印后调用的 function,整个事情的结果是 function 返回的任何内容。 例如:
calculateSomething :: Int -> Int -> Int
calculateSomething x y =
trace ("x = " <> show x) \_ ->
x + y
main :: Effect Unit
main =
log $ show $ calculateSomething 37 5
> npx spago run
'x = 37'
42
第一个参数可以是任何东西,而不仅仅是一个字符串。 这使您可以轻松打印很多东西:
calculateSomething :: Int -> Int -> Int
calculateSomething x y =
trace { x, y } \_ ->
x + y
> npx spago run
{ x: 37, y: 5 }
42
或者,将其应用于您的代码:
read :: FilePath -> Aff String
read f = trace ("File: " <> f) \_ -> do
readTextFile UTF8 f
但这里有一个微妙的细节:一旦你调用read
,这个跟踪就会发生,即使结果Aff
永远不会真正执行。 如果您需要在有效执行时进行跟踪,则需要将trace
调用作为操作的一部分,并注意不要使其成为序列中的第一个操作:
read :: FilePath -> Aff String
read f = do
pure unit
trace ("File: " <> f) \_ -> pure unit
readTextFile UTF8 f
当然,每次您需要在有效的上下文中进行跟踪时都执行此操作有点不方便,因此有一个特殊的 function 可以为您执行此操作 - 它称为traceM
:
read :: FilePath -> Aff String
read f = do
traceM ("File: " <> f)
readTextFile UTF8 f
如果您查看它的源代码,您会发现它与我在上面的示例中所做的完全一样。
可悲的是,当异常发生时, trace
在 REPL 中对您没有帮助,因为它仍在打印到控制台,因此出于相同的原因它仍然会被吞没。
但即使它没有被吞下,output 也有点乱码,因为trace
实际上以颜色输出(以帮助您在其他输出中分辨出来),而 PureScript REPL 与颜色有复杂的关系:
> calculateSomething 37 5
←[32m'x = 37'←[39m
42
除了Fyodor Soikin's great answer之外,我还发现了一个使用 VS Code 调试视图的变体。
1.) 确保使用 sourcemaps 构建:
spago build --purs-args "-g sourcemaps"
2.) 将调试配置添加到 VS Code launch.json
:
{
"version": "0.2.0",
"configurations": [
{
"type": "pwa-node",
"request": "launch",
"name": "Launch Program",
"skipFiles": ["<node_internals>/**"],
"runtimeArgs": ["-e", "require('./output/Main/index.js').main()"],
"smartStep": true // skips files without (valid) source map
}
]
}
将"./output/Main/index.js"
/. .main()
替换为编译好的.js
文件/function 进行调试。
3.) 设置断点并通过 sourcemap 支持单步执行.purs
文件。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.