Amend vignette-name rule for "Get Started"?

[ijlyttle]

This question was spurred by this vignette naming discussion at r-lib/usethis#830 - the gist was:

If a package name has a dot, e.g. acme.data, we cannot have a vignette with the same name because vignette names cannot contain dots. The motivation was to have a "Get Started" article on a pkgdown site.

As far as I know, the dot is the only legal delimiter character (non alphanumeric) in a package name.

To get around this, could the pkgdown rule be amended to "strip" any dots from package names?

This way, a package acme.data could have a pkgdown "Get Started" vignette named acmedata.Rmd.

Here's (what I think is) the operative line:

pkgdown/R/navbar.R

Line 71 in d1d10cf

pkg_intro <- vignettes$name == pkg$package

Could something like this be useful?

# strip dots to allow matching for packages with dots in the name
pkg_intro <- vignettes$name == gsub("[.]", "", pkg$package) 

If so, happy to make a PR. Thanks!

[hadley]

Yes, that sounds reasonable, and a PR would be helpful, thanks!

[maelle]

A related question/feature request (hence my asking here): could the "Get started" rule also apply to article names i.e. if there's a non-vignette article called pkg.Rmd, could it be detected?

[hadley]

@maelle from a quick look at the code, I think should already be the case? Specifically, how is your article not a vignette?

[maelle]

Sorry if I'm missing something. It's under vignettes/articles (website)

[maelle]

I'm now also wondering whether it'd make sense to have these live under articles/filename.html instead of articles/articles/filename.html. 🤔 but this is getting off topic for this issue. For info I used usethis::use_article().

[hadley]

Oh now I remembered; the vignette "name" includes the path, so you get article/packagename which doesn't match.

[maelle]

Thank you 😺

[k-tatgenhorst]

As I am researching another naming issue for vignettes I stumbled on this. I can see how this solution could lead to naming collisions: acme.data could some perhaps later create an acmedata package?
Just a thought, I see this is closed.