pkgdown/tests/testthat/test-pkgdownignore.R at ebd804eec7eb91dfe6db951f2f3b1421dfe9cdbe · r-lib/pkgdown · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
test_that("read_pkgdownignore returns empty when no file exists", {
  pkg <- local_pkgdown_site()
  expect_equal(read_pkgdownignore(pkg$src_path), character())
})

test_that("read_pkgdownignore reads from package root", {
  pkg <- local_pkgdown_site()
  write_lines(c("CLAUDE.md", "AGENTS.md"), path(pkg$src_path, ".pkgdownignore"))

  result <- read_pkgdownignore(pkg$src_path)
  expect_equal(result, c("CLAUDE.md", "AGENTS.md"))
})

test_that("read_pkgdownignore reads from pkgdown/ directory", {
  pkg <- local_pkgdown_site()
  dir_create(path(pkg$src_path, "pkgdown"))
  write_lines("INTERNAL.md", path(pkg$src_path, "pkgdown", ".pkgdownignore"))

  result <- read_pkgdownignore(pkg$src_path)
  expect_equal(result, "INTERNAL.md")
})

test_that("read_pkgdownignore reads from _pkgdown/ directory", {
  pkg <- local_pkgdown_site()
  dir_create(path(pkg$src_path, "_pkgdown"))
  write_lines("NOTES.md", path(pkg$src_path, "_pkgdown", ".pkgdownignore"))

  result <- read_pkgdownignore(pkg$src_path)
  expect_equal(result, "NOTES.md")
})

test_that("read_pkgdownignore combines files from multiple locations", {
  pkg <- local_pkgdown_site()

  # Root

  write_lines("CLAUDE.md", path(pkg$src_path, ".pkgdownignore"))

  # pkgdown/
  dir_create(path(pkg$src_path, "pkgdown"))
  write_lines("AGENTS.md", path(pkg$src_path, "pkgdown", ".pkgdownignore"))

  result <- read_pkgdownignore(pkg$src_path)
  expect_setequal(result, c("CLAUDE.md", "AGENTS.md"))
})

test_that("read_pkgdownignore ignores comments and empty lines", {
  pkg <- local_pkgdown_site()
  write_lines(
    c(
      "# This is a comment",
      "CLAUDE.md",
      "",
      "  # Indented comment",
      "AGENTS.md",
      "   ",
      "INTERNAL.md"
    ),
    path(pkg$src_path, ".pkgdownignore")
  )

  result <- read_pkgdownignore(pkg$src_path)
  expect_equal(result, c("CLAUDE.md", "AGENTS.md", "INTERNAL.md"))
})

test_that("read_pkgdownignore trims whitespace", {
  pkg <- local_pkgdown_site()
  write_lines(
    c("  CLAUDE.md  ", "\tAGENTS.md\t"),
    path(pkg$src_path, ".pkgdownignore")
  )

  result <- read_pkgdownignore(pkg$src_path)
  expect_equal(result, c("CLAUDE.md", "AGENTS.md"))
})

test_that("read_pkgdownignore deduplicates entries", {
  pkg <- local_pkgdown_site()

  # Same file in root and pkgdown/

  write_lines("CLAUDE.md", path(pkg$src_path, ".pkgdownignore"))
  dir_create(path(pkg$src_path, "pkgdown"))
  write_lines("CLAUDE.md", path(pkg$src_path, "pkgdown", ".pkgdownignore"))

  result <- read_pkgdownignore(pkg$src_path)
  expect_equal(result, "CLAUDE.md")
})

test_that("package_mds excludes files listed in .pkgdownignore", {
  pkg <- local_pkgdown_site()

  # Create test markdown files
  write_lines("# CLAUDE", path(pkg$src_path, "CLAUDE.md"))
  write_lines("# AGENTS", path(pkg$src_path, "AGENTS.md"))
  write_lines("# ROADMAP", path(pkg$src_path, "ROADMAP.md"))

  # Create .pkgdownignore

  write_lines(c("CLAUDE.md", "AGENTS.md"), path(pkg$src_path, ".pkgdownignore"))

  result <- package_mds(pkg$src_path)
  result_files <- path_file(result)

  expect_false("CLAUDE.md" %in% result_files)
  expect_false("AGENTS.md" %in% result_files)
  expect_true("ROADMAP.md" %in% result_files)
})

test_that("package_mds excludes .github files listed in .pkgdownignore", {
  pkg <- local_pkgdown_site()

  # Create .github directory with markdown files
  dir_create(path(pkg$src_path, ".github"))
  write_lines("# Internal", path(pkg$src_path, ".github", "INTERNAL.md"))
  write_lines(
    "# Contributing",
    path(pkg$src_path, ".github", "CONTRIBUTING.md")
  )

  # Ignore the internal one
  write_lines("INTERNAL.md", path(pkg$src_path, ".pkgdownignore"))

  result <- package_mds(pkg$src_path)
  result_files <- path_file(result)

  expect_false("INTERNAL.md" %in% result_files)
  expect_true("CONTRIBUTING.md" %in% result_files)
})

test_that("package_mds works when .pkgdownignore is empty", {
  pkg <- local_pkgdown_site()

  # Create test file
  write_lines("# ROADMAP", path(pkg$src_path, "ROADMAP.md"))

  # Empty ignore file
  file_create(path(pkg$src_path, ".pkgdownignore"))

  result <- package_mds(pkg$src_path)
  result_files <- path_file(result)

  expect_true("ROADMAP.md" %in% result_files)
})

test_that("package_mds works when .pkgdownignore has only comments", {
  pkg <- local_pkgdown_site()

  # Create test file
  write_lines("# ROADMAP", path(pkg$src_path, "ROADMAP.md"))

  # Ignore file with only comments
  write_lines(
    c("# comment 1", "# comment 2"),
    path(pkg$src_path, ".pkgdownignore")
  )

  result <- package_mds(pkg$src_path)
  result_files <- path_file(result)

  expect_true("ROADMAP.md" %in% result_files)
})