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.

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

Respect DESCRIPTION language. #2808

Merged
merged 3 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# pkgdown (development version)

* The language of the site is set from the first `Language:` in the `DESCRIPTION` if it is available and no other language is specified (@jonthegeek, #2808).

# pkgdown 2.1.1

* Added keyboard shortcut, `/`, to focus search bar (#2423)
Expand Down
25 changes: 20 additions & 5 deletions R/package.R
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ as_pkgdown <- function(pkg = ".", override = list()) {
if (!is.null(pkg$meta$url)) {
pkg$meta$url <- sub("/$", "", pkg$meta$url)
}

pkg$development <- meta_development(pkg)
pkg$prefix <- pkg$development$prefix

Expand All @@ -85,7 +85,7 @@ as_pkgdown <- function(pkg = ".", override = list()) {
pkg$dst_path <- path(pkg$dst_path, pkg$development$destination)
}

pkg$lang <- pkg$meta$lang %||% "en"
pkg$lang <- get_pkg_lang(pkg)
pkg$install_metadata <- config_pluck_bool(pkg, "deploy.install_metadata", FALSE)
pkg$figures <- meta_figures(pkg)
pkg$repo <- package_repo(pkg)
Expand All @@ -106,6 +106,21 @@ read_desc <- function(path = ".") {
desc::description$new(path)
}

get_pkg_lang <- function(pkg) {
if (!is.null(pkg$meta$lang)) {
return(pkg$meta$lang)
jonthegeek marked this conversation as resolved.
Show resolved Hide resolved
}

if (pkg$desc$has_fields("Language")) {
field <- pkg$desc$get_field("Language")
if (length(field) && nchar(field) > 0) {
return(regmatches(field, regexpr("[^,]+", field)))
jonthegeek marked this conversation as resolved.
Show resolved Hide resolved
}
}

return("en")
}

get_bootstrap_version <- function(pkg,
template,
template_package = NULL,
Expand Down Expand Up @@ -270,7 +285,7 @@ extract_lifecycle <- function(x) {
fig <- extract_figure(desc)

if (!is.null(fig) && length(fig) > 0 && length(fig[[1]]) > 0) {
path <- as.character(fig[[1]][[1]])
path <- as.character(fig[[1]][[1]])
if (grepl("lifecycle", path)) {
name <- gsub("lifecycle-", "", path)
name <- path_ext_remove(name)
Expand Down Expand Up @@ -351,12 +366,12 @@ article_metadata <- function(path) {
if (path_ext(path) == "qmd") {
inspect <- quarto::quarto_inspect(path)
meta <- inspect$formats[[1]]$metadata

out <- list(
title = meta$title %||% "UNKNOWN TITLE",
desc = meta$description %||% NA_character_,
ext = path_ext(inspect$formats[[1]]$pandoc$`output-file`) %||% "html"
)
)
} else {
yaml <- rmarkdown::yaml_front_matter(path)
out <- list(
Expand Down
7 changes: 7 additions & 0 deletions tests/testthat/assets/reference-language/one/DESCRIPTION
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Package: testpackage
Version: 1.0.0
Title: A test package
Description: A test package
Authors@R: person("Hadley Wickham")
RoxygenNote: 7.3.1
Language: fr
7 changes: 7 additions & 0 deletions tests/testthat/assets/reference-language/two/DESCRIPTION
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Package: testpackage
Version: 1.0.0
Title: A test package
Description: A test package
Authors@R: person("Hadley Wickham")
RoxygenNote: 7.3.1
Language: en-US, fr
29 changes: 29 additions & 0 deletions tests/testthat/test-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,32 @@ test_that("malformed figures fail gracefully", {
expect_null(rd_lifecycle("{\\figure{deprecated.svg}}"))
expect_null(rd_lifecycle("{\\figure{}}"))
})

# language ---------------------------------------------------------------------

test_that("as_pkgdown sets language", {
# Default
pkg <- as_pkgdown(test_path("assets/reference"))
expect_equal(
pkg$lang,
"en"
)
# Single language specified in DESCRIPTION
pkg <- as_pkgdown(test_path("assets/reference-language/one"))
expect_equal(
pkg$lang,
"fr"
)
# Two languages specified in DESCRIPTION
pkg <- as_pkgdown(test_path("assets/reference-language/two"))
expect_equal(
pkg$lang,
"en-US"
)
# Language specified in _pkgdown.yml or override.
pkg <- as_pkgdown(test_path("assets/reference-language/two"), override = list(lang = "en-GB"))
expect_equal(
pkg$lang,
"en-GB"
)
})
Loading