File Tree Diff: allow users to ignore files

Add a field to allow users to tell us what files should be ignored when
comparing versions. This is going to be used by the front-end to don't expose
these files in the list of added/modified/deleted files.

Closes #11694

Author: humitos

readthedocs/projects/forms.py

@@ -652,11 +652,36 @@ def __init__(self, *args, **kwargs):
             self.fields.pop("external_builds_privacy_level")
 
 
+class OnePerLineList(forms.Field):
+    widget = forms.Textarea(
+        attrs={
+            "placeholder": "\n".join(
+                [
+                    "/whatsnew.html",
+                    "/guides/getting-started.html",
+                    "/changelog.html",
+                ]
+            ),
+        },
+    )
+
+    def to_python(self, value):
+        """Convert a text area into a list of items (one per line)"""
+        if not value:
+            return []
+        return value.splitlines()
+
+    def prepare_value(self, value):
+        """Convert a list of items into a text area (one per line)"""
+        return "\n".join(value)
+
+
 class AddonsConfigForm(forms.ModelForm):
 
     """Form to opt-in into new addons."""
 
     project = forms.CharField(widget=forms.HiddenInput(), required=False)
+    filetreediff_ignored_files = OnePerLineList(required=False)
 
     class Meta:
         model = AddonsConfig
@@ -666,6 +691,8 @@ class Meta:
             "options_root_selector",
             "analytics_enabled",
             "doc_diff_enabled",
+            "filetreediff_enabled",
+            "filetreediff_ignored_files",
             "flyout_enabled",
             "flyout_sorting",
             "flyout_sorting_latest_stable_at_beginning",
@@ -682,6 +709,8 @@ class Meta:
         labels = {
             "enabled": _("Enable Addons"),
             "doc_diff_enabled": _("Visual diff enabled"),
+            "filetreediff_enabled": _("Enabled"),
+            "filetreediff_ignored_files": _("Ignored files"),
             "notifications_show_on_external": _(
                 "Show a notification on builds from pull requests"
             ),

readthedocs/projects/migrations/0146_addons_filetreediff_ignored_files.py

@@ -0,0 +1,26 @@
+# Generated by Django 4.2.18 on 2025-02-05 11:33
+
+from django.db import migrations, models
+from django_safemigrate import Safe
+
+
+class Migration(migrations.Migration):
+
+    safe = Safe.before_deploy
+
+    dependencies = [
+        ('projects', '0145_alter_importedfile_id'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='addonsconfig',
+            name='filetreediff_ignored_files',
+            field=models.JSONField(blank=True, help_text='List of ignored files. One per line.', null=True),
+        ),
+        migrations.AddField(
+            model_name='historicaladdonsconfig',
+            name='filetreediff_ignored_files',
+            field=models.JSONField(blank=True, help_text='List of ignored files. One per line.', null=True),
+        ),
+    ]

readthedocs/projects/models.py

@@ -195,6 +195,11 @@ class AddonsConfig(TimeStampedModel):
 
     # File Tree Diff
     filetreediff_enabled = models.BooleanField(default=False, null=True, blank=True)
+    filetreediff_ignored_files = models.JSONField(
+        help_text=_("List of ignored files. One per line."),
+        null=True,
+        blank=True,
+    )
 
     # Flyout
     flyout_enabled = models.BooleanField(

readthedocs/proxito/views/hosting.py

@@ -541,6 +541,7 @@ def _v1(self, project, version, build, filename, url, request):
                 },
                 "filetreediff": {
                     "enabled": project.addons.filetreediff_enabled,
+                    "ignored_files": project.addons.filetreediff_ignored_files,
                 },
             },
         }