Skip to content

Commit 173658e

Browse files
committed
Filetreediff: allow users to ignore some files
Filter the added/modified list of files to filter our "ignored files" coming from the API response. Requires readthedocs/readthedocs.org#11977
1 parent 7d9679d commit 173658e

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

src/data-validation.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ const addons_filetreediff = {
257257
properties: {
258258
filetreediff: {
259259
type: "object",
260-
required: ["enabled", "diff"],
260+
required: ["enabled", "diff", "ignored_files"],
261261
properties: {
262262
enabled: { type: "boolean" },
263263
diff: {
@@ -268,6 +268,7 @@ const addons_filetreediff = {
268268
modified: { type: "array" },
269269
},
270270
},
271+
ignored_files: { type: ["array", "null"] },
271272
},
272273
},
273274
},

src/filetreediff.js

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,15 @@ export class FileTreeDiffElement extends LitElement {
213213
(f) => f.urls.current === currentUrl,
214214
);
215215

216+
// Filter out files that are ignored by this project
217+
const ignoredFiles = this.config.addons.filetreediff.ignored_files || [];
218+
const addedFiles = diffData.added.filter(
219+
(file) => !ignoredFiles.contains(file),
220+
);
221+
const modifiedFiles = diffData.modified.filter(
222+
(file) => !ignoredFiles.contains(file),
223+
);
224+
216225
return html`
217226
<div>
218227
<div>
@@ -221,8 +230,8 @@ export class FileTreeDiffElement extends LitElement {
221230
<option value="" ?selected=${!hasCurrentFile} disabled>
222231
Files changed
223232
</option>
224-
${renderSection(diffData.added, "Added")}
225-
${renderSection(diffData.modified, "Changed")}
233+
${renderSection(addedFiles, "Added")}
234+
${renderSection(modifiedFiles, "Changed")}
226235
</select>
227236
</div>
228237
</div>

0 commit comments

Comments
 (0)