Skip to content
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

Work with absolute paths #41

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Work with absolute paths #41

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
beeb417
Work with absolute paths
krlmlr Sep 3, 2020
8c5be2d
Home-grown path_abs()
krlmlr Sep 3, 2020
5f23d47
Merge branch 'master' into b-pandoc-convert-abs-path
krlmlr Sep 4, 2020
231277c
Add withr dependency, tidy
krlmlr Sep 4, 2020
93c1a84
Add tests
krlmlr Sep 4, 2020
f318f74
One more test
krlmlr Sep 4, 2020
30a9ab7
Merge branch 'master' into b-pandoc-convert-abs-path
krlmlr Sep 25, 2020
1727b87
Merge branch 'master' into b-pandoc-convert-abs-path
krlmlr Oct 28, 2020
c9f9b28
Merge branch 'master' into b-pandoc-convert-abs-path
krlmlr May 24, 2021
e30fbdf
Parens are hard
krlmlr May 24, 2021
0a60be4
Skip test on Windows
krlmlr May 24, 2021
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
1 change: 1 addition & 0 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Imports:
digest,
evaluate,
fansi,
fs,
rlang,
vctrs,
yaml
Expand Down
11 changes: 7 additions & 4 deletions R/downlit-md.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ downlit_md_path <- function(in_path, out_path, format = NULL) {
ast_path <- tempfile()
on.exit(unlink(ast_path))

in_path <- fs::path_abs(in_path)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason not to use normalizePath() here? I'd prefer to keep the dependencies lighter.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file must exist, this is generally not true for out_path:

normalizePath("bogus")
#> Warning in normalizePath("bogus"): path[1]="bogus": No such file or directory
#> [1] "bogus"

Created on 2020-09-03 by the reprex package (v0.3.0)

Same with mustWork = FALSE sans warning.

We can work around if you think it's worth it, or copy code from fs.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the other option is to require/document that the user supply absolute paths? That might be easier given that I expect relatively few people to be calling this function.

out_path <- fs::path_abs(out_path)

md2ast(in_path, ast_path, format = format)

ast <- jsonlite::read_json(ast_path)
Expand Down Expand Up @@ -58,8 +61,8 @@ downlit_md_string <- function(x, format = NULL) {
md2ast <- function(path, out_path, format = NULL) {
format <- format %||% md_format()
rmarkdown::pandoc_convert(
input = normalizePath(path, mustWork = FALSE),
output = normalizePath(out_path, mustWork = FALSE),
input = path,
output = out_path,
from = format,
to = "json"
)
Expand All @@ -75,8 +78,8 @@ ast2md <- function(path, out_path, format = NULL) {
)

rmarkdown::pandoc_convert(
input = normalizePath(path, mustWork = FALSE),
output = normalizePath(out_path, mustWork = FALSE),
input = path,
output = out_path,
from = "json",
to = format,
options = options
Expand Down