feat: Bundle js files, remove jQuery, and static libs

Author: fsbraun

.pre-commit-config.yaml

@@ -20,16 +20,12 @@ repos:
 #      - id: django-upgrade
 #        args: [--target-version, "2.2"]
 
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.0.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.3
     hooks:
-      - id: flake8
-        entry: pflake8
-        additional_dependencies: [pyproject-flake8]
-  - repo: https://github.com/asottile/yesqa
-    rev: v1.5.0
-    hooks:
-      - id: yesqa
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0

eslint.config.js

@@ -0,0 +1,57 @@
+export default [
+    {
+        files: ['**/*.js'],
+        languageOptions: {
+            ecmaVersion: 2015,
+            sourceType: 'script',
+            globals: {
+                // Browser globals
+                window: 'readonly',
+                document: 'readonly',
+                console: 'readonly',
+                alert: 'readonly',
+                // Node.js globals
+                require: 'readonly',
+                module: 'readonly',
+                __dirname: 'readonly',
+                process: 'readonly',
+                // Django globals
+                django: 'readonly',
+                // Third-party library globals
+                Dropzone: 'readonly',
+                Mediator: 'readonly',
+                Class: 'readonly',
+                opener: 'readonly',
+                // Test globals
+                jasmine: 'readonly',
+                describe: 'readonly',
+                it: 'readonly',
+                expect: 'readonly',
+                beforeEach: 'readonly',
+                afterEach: 'readonly'
+            }
+        },
+        rules: {
+            // Code quality
+            'eqeqeq': ['error', 'always'],
+            'curly': ['error', 'all'],
+            'no-unused-vars': ['error', { 'vars': 'all', 'args': 'after-used' }],
+            'no-undef': 'error',
+            'no-bitwise': 'error',
+            'no-caller': 'error',
+
+            // Style
+            'quotes': ['error', 'single', { 'avoidEscape': true }],
+            'indent': ['error', 4, { 'SwitchCase': 1 }],
+            'semi': ['error', 'always'],
+            'no-trailing-spaces': 'error',
+            'no-multiple-empty-lines': ['error', { 'max': 2 }],
+            'max-len': ['error', { 'code': 120, 'ignoreUrls': true, 'ignoreRegExpLiterals': true }],
+
+            // Best practices
+            'strict': ['error', 'global'],
+            'no-implied-eval': 'error',
+            'no-new-func': 'error'
+        }
+    }
+];

filer/fields/file.py

@@ -2,7 +2,6 @@
 import warnings
 
 from django import forms
-from django.conf import settings
 from django.contrib.admin.sites import site
 from django.contrib.admin.widgets import ForeignKeyRawIdWidget
 from django.core.exceptions import ObjectDoesNotExist
@@ -27,52 +26,56 @@ class AdminFileWidget(ForeignKeyRawIdWidget):
 
     def render(self, name, value, attrs=None, renderer=None):
         obj = self.obj_for_value(value)
-        css_id = attrs.get('id', 'id_image_x')
+        css_id = attrs.get("id", "id_image_x")
         related_url = None
-        change_url = ''
+        change_url = ""
         if value:
             try:
                 file_obj = File.objects.get(pk=value)
-                related_url = file_obj.logical_folder.get_admin_directory_listing_url_path()
+                related_url = (
+                    file_obj.logical_folder.get_admin_directory_listing_url_path()
+                )
                 change_url = file_obj.get_admin_change_url()
             except Exception as e:
                 # catch exception and manage it. We can re-raise it for debugging
                 # purposes and/or just logging it, provided user configured
                 # proper logging configuration
                 if filer_settings.FILER_ENABLE_LOGGING:
-                    logger.error('Error while rendering file widget: %s', e)
+                    logger.error("Error while rendering file widget: %s", e)
                 if filer_settings.FILER_DEBUG:
                     raise
         if not related_url:
-            related_url = reverse('admin:filer-directory_listing-last')
+            related_url = reverse("admin:filer-directory_listing-last")
         params = self.url_parameters()
-        params['_pick'] = 'file'
+        params["_pick"] = "file"
         if params:
-            lookup_url = '?' + urlencode(sorted(params.items()))
+            lookup_url = "?" + urlencode(sorted(params.items()))
         else:
-            lookup_url = ''
-        if 'class' not in attrs:
+            lookup_url = ""
+        if "class" not in attrs:
             # The JavaScript looks for this hook.
-            attrs['class'] = 'vForeignKeyRawIdAdminField'
+            attrs["class"] = "vForeignKeyRawIdAdminField"
         # rendering the super for ForeignKeyRawIdWidget on purpose here because
         # we only need the input and none of the other stuff that
         # ForeignKeyRawIdWidget adds
-        hidden_input = super(ForeignKeyRawIdWidget, self).render(name, value, attrs)  # grandparent super
+        hidden_input = super(ForeignKeyRawIdWidget, self).render(
+            name, value, attrs
+        )  # grandparent super
         context = {
-            'hidden_input': hidden_input,
-            'lookup_url': f'{related_url}{lookup_url}',
-            'change_url': change_url,
-            'object': obj,
-            'lookup_name': name,
-            'id': css_id,
-            'admin_icon_delete': ('admin/img/icon-deletelink.svg'),
+            "hidden_input": hidden_input,
+            "lookup_url": f"{related_url}{lookup_url}",
+            "change_url": change_url,
+            "object": obj,
+            "lookup_name": name,
+            "id": css_id,
+            "admin_icon_delete": ("admin/img/icon-deletelink.svg"),
         }
-        html = render_to_string('admin/filer/widgets/admin_file.html', context)
+        html = render_to_string("admin/filer/widgets/admin_file.html", context)
         return mark_safe(html)
 
     def label_for_value(self, value):
         obj = self.obj_for_value(value)
-        return '&nbsp;<strong>%s</strong>' % truncate_words(obj, 14)
+        return "&nbsp;<strong>%s</strong>" % truncate_words(obj, 14)
 
     def obj_for_value(self, value):
         if value:
@@ -87,20 +90,10 @@ def obj_for_value(self, value):
         return obj
 
     class Media:
-        extra = '' if settings.DEBUG else '.min'
         css = {
-            'all': (
-                'filer/css/admin_filer.css',
-            ) + ICON_CSS_LIB,
+            "all": ("filer/css/admin_filer.css",) + ICON_CSS_LIB,
         }
-        js = (
-            'admin/js/vendor/jquery/jquery%s.js' % extra,
-            'admin/js/jquery.init.js',
-            'filer/js/libs/dropzone.min.js',
-            'filer/js/addons/dropzone.init.js',
-            'filer/js/addons/popup_handling.js',
-            'filer/js/addons/widget.js',
-        )
+        js = ("filer/js/dist/admin-file-widget.bundle.js",)
 
 
 class AdminFileFormField(forms.ModelChoiceField):
@@ -112,7 +105,7 @@ def __init__(self, rel, queryset, to_field_name, *args, **kwargs):
         self.to_field_name = to_field_name
         self.max_value = None
         self.min_value = None
-        kwargs.pop('widget', None)
+        kwargs.pop("widget", None)
         super().__init__(queryset, widget=self.widget(rel, site), *args, **kwargs)
 
     def widget_attrs(self, widget):
@@ -125,18 +118,18 @@ class FilerFileField(models.ForeignKey):
     default_model_class = File
 
     def __init__(self, **kwargs):
-        to = kwargs.pop('to', None)
+        to = kwargs.pop("to", None)
         dfl = get_model_label(self.default_model_class)
         if to and get_model_label(to).lower() != dfl.lower():
             msg = "In {}: ForeignKey must point to {}; instead passed {}"
             warnings.warn(msg.format(self.__class__.__name__, dfl, to), SyntaxWarning)
-        kwargs['to'] = dfl  # hard-code `to` to model `filer.File`
+        kwargs["to"] = dfl  # hard-code `to` to model `filer.File`
         super().__init__(**kwargs)
 
     def formfield(self, **kwargs):
         defaults = {
-            'form_class': self.default_form_class,
-            'rel': self.remote_field,
+            "form_class": self.default_form_class,
+            "rel": self.remote_field,
         }
         defaults.update(kwargs)
         return super().formfield(**defaults)

filer/fields/folder.py

@@ -18,12 +18,12 @@
 
 class AdminFolderWidget(ForeignKeyRawIdWidget):
     choices = None
-    input_type = 'hidden'
+    input_type = "hidden"
     is_hidden = False
 
     def render(self, name, value, attrs=None, renderer=None):
         obj = self.obj_for_value(value)
-        css_id = attrs.get('id')
+        css_id = attrs.get("id")
         css_id_folder = "%s_folder" % css_id
         css_id_description_txt = "%s_description_txt" % css_id
         if attrs is None:
@@ -37,38 +37,40 @@ def render(self, name, value, attrs=None, renderer=None):
             except Exception:
                 pass
         if not related_url:
-            related_url = reverse('admin:filer-directory_listing-last')
+            related_url = reverse("admin:filer-directory_listing-last")
         params = self.url_parameters()
-        params['_pick'] = 'folder'
+        params["_pick"] = "folder"
         if params:
-            url = '?' + urlencode(sorted(params.items()))
+            url = "?" + urlencode(sorted(params.items()))
         else:
-            url = ''
-        if 'class' not in attrs:
+            url = ""
+        if "class" not in attrs:
             # The JavaScript looks for this hook.
-            attrs['class'] = 'vForeignKeyRawIdAdminField'
+            attrs["class"] = "vForeignKeyRawIdAdminField"
         super_attrs = attrs.copy()
-        hidden_input = super(ForeignKeyRawIdWidget, self).render(name, value, super_attrs)  # grandparent super
+        hidden_input = super(ForeignKeyRawIdWidget, self).render(
+            name, value, super_attrs
+        )  # grandparent super
 
         # TODO: "id_" is hard-coded here. This should instead use the correct
         # API to determine the ID dynamically.
         context = {
-            'hidden_input': hidden_input,
-            'lookup_url': f'{related_url}{url}',
-            'lookup_name': name,
-            'span_id': css_id_description_txt,
-            'object': obj,
-            'clear_id': '%s_clear' % css_id,
-            'descid': css_id_description_txt,
-            'foldid': css_id_folder,
-            'id': css_id,
+            "hidden_input": hidden_input,
+            "lookup_url": f"{related_url}{url}",
+            "lookup_name": name,
+            "span_id": css_id_description_txt,
+            "object": obj,
+            "clear_id": "%s_clear" % css_id,
+            "descid": css_id_description_txt,
+            "foldid": css_id_folder,
+            "id": css_id,
         }
-        html = render_to_string('admin/filer/widgets/admin_folder.html', context)
+        html = render_to_string("admin/filer/widgets/admin_folder.html", context)
         return mark_safe(html)
 
     def label_for_value(self, value):
         obj = self.obj_for_value(value)
-        return '&nbsp;<strong>%s</strong>' % truncate_words(obj, 14)
+        return "&nbsp;<strong>%s</strong>" % truncate_words(obj, 14)
 
     def obj_for_value(self, value):
         if not value:
@@ -81,8 +83,11 @@ def obj_for_value(self, value):
         return obj
 
     class Media:
-        css = {"all": ('filer/css/admin_filer.css',) + ICON_CSS_LIB}
-        js = ('filer/js/addons/popup_handling.js',)
+        css = {"all": ("filer/css/admin_filer.css",) + ICON_CSS_LIB}
+        js = (
+            "filer/js/addons/popup_handling.js",
+            "filer/js/widgets/admin-folder-widget.js",
+        )
 
 
 class AdminFolderFormField(forms.ModelChoiceField):
@@ -91,12 +96,12 @@ class AdminFolderFormField(forms.ModelChoiceField):
     def __init__(self, rel, queryset, to_field_name, *args, **kwargs):
         self.rel = rel
         self.queryset = queryset
-        self.limit_choices_to = kwargs.pop('limit_choices_to', None)
+        self.limit_choices_to = kwargs.pop("limit_choices_to", None)
         self.to_field_name = to_field_name
         self.max_value = None
         self.min_value = None
-        kwargs.pop('widget', None)
-        kwargs.pop('blank', None)
+        kwargs.pop("widget", None)
+        kwargs.pop("blank", None)
         forms.Field.__init__(self, widget=self.widget(rel, site), *args, **kwargs)
 
     def widget_attrs(self, widget):
@@ -118,13 +123,13 @@ def __init__(self, **kwargs):
                     self.__class__.__name__, dfl, old_to
                 )
                 warnings.warn(msg, SyntaxWarning)
-        kwargs['to'] = dfl
+        kwargs["to"] = dfl
         super().__init__(**kwargs)
 
     def formfield(self, **kwargs):
         defaults = {
-            'form_class': self.default_form_class,
-            'rel': self.remote_field,
+            "form_class": self.default_form_class,
+            "rel": self.remote_field,
         }
         defaults.update(kwargs)
         return super().formfield(**defaults)