mirror of
https://github.com/Garmelon/PFERD.git
synced 2023-12-21 10:23:01 +01:00
Document --debug-transforms
This commit is contained in:
parent
533f75ea71
commit
17207546e9
@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- Crawl uploaded exercise solutions
|
- Crawl uploaded exercise solutions
|
||||||
- Explain what PFERD is doing and why (`--explain`)
|
- Explain what PFERD is doing and why (`--explain`)
|
||||||
- More control over output (`--status`, `--report`)
|
- More control over output (`--status`, `--report`)
|
||||||
|
- Debug transform rules with `--debug-transforms`
|
||||||
- Print report after exiting via Ctrl+C
|
- Print report after exiting via Ctrl+C
|
||||||
- Store crawler reports in `.report` JSON file
|
- Store crawler reports in `.report` JSON file
|
||||||
- Extensive config file documentation (`CONFIG.md`)
|
- Extensive config file documentation (`CONFIG.md`)
|
||||||
|
@ -205,6 +205,9 @@ They are specified line-by-line in a crawler's `transform` option. When a
|
|||||||
crawler needs to apply a rule to a path, it goes through this list top-to-bottom
|
crawler needs to apply a rule to a path, it goes through this list top-to-bottom
|
||||||
and choose the first matching rule.
|
and choose the first matching rule.
|
||||||
|
|
||||||
|
To see this process in action, you can use the `--debug-transforms` or flag or
|
||||||
|
the `--explain` flag.
|
||||||
|
|
||||||
Each line has the format `SOURCE ARROW TARGET` where `TARGET` is optional.
|
Each line has the format `SOURCE ARROW TARGET` where `TARGET` is optional.
|
||||||
`SOURCE` is either a normal path without spaces (e. g. `foo/bar`), or a string
|
`SOURCE` is either a normal path without spaces (e. g. `foo/bar`), or a string
|
||||||
literal delimited by `"` or `'` (e. g. `"foo\" bar/baz"`). Python's string
|
literal delimited by `"` or `'` (e. g. `"foo\" bar/baz"`). Python's string
|
||||||
|
Loading…
Reference in New Issue
Block a user