chore: lint & format w/ pre-commit

foosel · foosel · commit b0af1609fccc · 2025-12-09T16:19:10.000+01:00
diff --git a/.codespell_ignore_words b/.codespell_ignore_words
@@ -0,0 +1,6 @@
+managable
+commitish
+matchs
+medias
+thirdparty
+factorIn
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,55 @@
+default_language_version:
+  python: python3.12
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.20.0
+    hooks:
+      - id: pyupgrade
+        args: ["--py39-plus"]
+        exclude: "setup.py|src/octoprint_setuptools/__init__.py"
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.0
+    hooks:
+      - id: ruff-check
+        args: ["--fix"]
+      - id: ruff-format
+  - repo: https://github.com/djlint/djlint
+    rev: v1.36.4
+    hooks:
+      - id: djlint
+        files: "\\.html$"
+        types: [html]
+      - id: djlint-reformat
+        files: "\\.html$"
+        types: [html]
+      - id: djlint-jinja
+        exclude: ^(octoprint_wrapped/templates/wrapped.svg.jinja2)
+      - id: djlint-reformat-jinja
+        exclude: ^(octoprint_wrapped/templates/wrapped.svg.jinja2)
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: v3.6.0
+    hooks:
+      - id: prettier
+        files: "\\.(js|json|css|less|md|yml|yaml)$"
+  - repo: https://github.com/pre-commit/mirrors-eslint
+    rev: v9.29.0
+    hooks:
+      - id: eslint
+        files: \.js$
+        exclude: ^(octoprint_wrapped/static/pure-snow/)
+        additional_dependencies: ["eslint@9.29.0", "globals@16.2.0"]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        exclude: ^(octoprint_wrapped/static/pure-snow/)
diff --git a/.prettierrc.yaml b/.prettierrc.yaml
@@ -0,0 +1,11 @@
+printWidth: 90
+tabWidth: 4
+semi: true
+trailingComma: "none"
+singleQuote: false
+quoteProps: consistent
+bracketSpacing: false
+overrides:
+  - files: ["*.yaml", "*.yml", "*.json", "*.less"]
+    options:
+      tabWidth: 2
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# OctoPrint-Wrapped 🎁
+# OctoPrint Wrapped! 🎁
 
 Get your yearly OctoPrint stats a shareable "wrapped" picture - and let it snow! ❄️
 
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -3,9 +3,8 @@
 version: "3"
 
 env:
-  LOCALES: []  # list your included locales here, e.g. ["de", "fr"]
-  TRANSLATIONS: octoprint_wrapped/translations  # translations folder, do not touch
-
+  LOCALES: [] # list your included locales here, e.g. ["de", "fr"]
+  TRANSLATIONS: octoprint_wrapped/translations # translations folder, do not touch
 
 tasks:
   install:
@@ -78,4 +77,3 @@ tasks:
 
           echo "Copying translations for locale ${locale} from ${source} to ${target}..."
           cp -r "${source}" "${target}"
-
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,13 @@
+const {defineConfig} = require("eslint/config");
+const globals = require("globals");
+
+module.exports = defineConfig([
+    {
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.jquery
+            }
+        }
+    }
+]);
diff --git a/octoprint_wrapped/__init__.py b/octoprint_wrapped/__init__.py
@@ -71,9 +71,7 @@ def get_svg(self, year):
             flask.abort(404)
 
         response = flask.make_response(
-            flask.render_template(
-                "wrapped.svg.jinja2", **stats.model_dump(by_alias=True)
-            )
+            flask.render_template("wrapped.svg.jinja2", **stats.model_dump(by_alias=True))
         )
         response.headers["Content-Type"] = "image/svg+xml"
         return response
@@ -161,7 +159,7 @@ def _get_available_years(self) -> list[int]:
         if not stats_folder:
             return []
 
-        pattern = re.compile("\d{4}.json")
+        pattern = re.compile(r"\d{4}.json")
 
         years = []
         for entry in os.scandir(stats_folder):
@@ -180,7 +178,7 @@ def _get_year_stats(self, year: int) -> Optional[YearStats]:
             return None
 
         try:
-            with open(stats_file, "r") as f:
+            with open(stats_file) as f:
                 stats = json.load(f)
         except Exception:
             self._logger.exception(
diff --git a/octoprint_wrapped/static/js/ko.src.svgtopng.js b/octoprint_wrapped/static/js/ko.src.svgtopng.js
@@ -1,11 +1,5 @@
 ko.bindingHandlers["src.svgtopng"] = {
-    init: (
-        element,
-        valueAccessor,
-        allBindingsAccessor,
-        viewModel,
-        bindingContext
-    ) => {
+    init: (element, valueAccessor, allBindingsAccessor, viewModel, bindingContext) => {
         const value = valueAccessor();
         const valueUnwrapped = ko.unwrap(value);
         if (!valueUnwrapped) return;
@@ -16,7 +10,7 @@ ko.bindingHandlers["src.svgtopng"] = {
             const svgString = xhr.responseText;
 
             const svg = new Blob([svgString], {
-                type: "image/svg+xml;charset=utf-8",
+                type: "image/svg+xml;charset=utf-8"
             });
 
             const url = URL.createObjectURL(svg);
@@ -37,7 +31,6 @@ ko.bindingHandlers["src.svgtopng"] = {
             };
             img.src = url;
         });
-    },
+    }
 };
-ko.bindingHandlers["src.svgtopng"].update =
-    ko.bindingHandlers["src.svgtopng"].init;
+ko.bindingHandlers["src.svgtopng"].update = ko.bindingHandlers["src.svgtopng"].init;
diff --git a/octoprint_wrapped/static/js/wrapped.js b/octoprint_wrapped/static/js/wrapped.js
@@ -13,7 +13,7 @@ $(function () {
     const SNOWFALL_LOCAL_STORAGE_KEY = "plugin.wrapped.snowfall";
     const snowfallToLocalStorage = (value) => {
         saveToLocalStorage(SNOWFALL_LOCAL_STORAGE_KEY, {
-            enabled: value,
+            enabled: value
         });
     };
 
@@ -117,15 +117,13 @@ $(function () {
 
                     const styleSnow = document.createElement("link");
                     styleSnow.href =
-                        BASEURL +
-                        "plugin/wrapped/static/pure-snow/pure-snow.css";
+                        BASEURL + "plugin/wrapped/static/pure-snow/pure-snow.css";
                     styleSnow.rel = "stylesheet";
                     head.appendChild(styleSnow);
 
                     const scriptSnow = document.createElement("script");
                     scriptSnow.src =
-                        BASEURL +
-                        "plugin/wrapped/static/pure-snow/pure-snow.js";
+                        BASEURL + "plugin/wrapped/static/pure-snow/pure-snow.js";
                     scriptSnow.defer = true;
                     scriptSnow.onload = () => {
                         setTimeout(() => {
@@ -161,15 +159,11 @@ $(function () {
 
     OCTOPRINT_VIEWMODELS.push({
         construct: WrappedViewModel,
-        dependencies: [
-            "loginStateViewModel",
-            "accessViewModel",
-            "aboutViewModel",
-        ],
+        dependencies: ["loginStateViewModel", "accessViewModel", "aboutViewModel"],
         elements: [
             "#about_plugin_wrapped",
             "#navbar_plugin_wrapped",
-            "#navbar_plugin_wrapped_2",
-        ],
+            "#navbar_plugin_wrapped_2"
+        ]
     });
 });
diff --git a/octoprint_wrapped/static/pure-snow/pure-snow.css b/octoprint_wrapped/static/pure-snow/pure-snow.css
@@ -1,10 +1,10 @@
 .snowflake {
-  z-index: 32768;
-  position: absolute;
-  width: 10px;
-  height: 10px;
-  background: linear-gradient(white, white);
-  /* Workaround for Chromium's selective color inversion */
-  border-radius: 50%;
-  filter: drop-shadow(0 0 10px black);
+    z-index: 32768;
+    position: absolute;
+    width: 10px;
+    height: 10px;
+    background: linear-gradient(white, white);
+    /* Workaround for Chromium's selective color inversion */
+    border-radius: 50%;
+    filter: drop-shadow(0 0 10px black);
 }
diff --git a/octoprint_wrapped/static/pure-snow/pure-snow.js b/octoprint_wrapped/static/pure-snow/pure-snow.js
@@ -126,7 +126,7 @@ window.addEventListener("resize", createSnow);
 if (typeof module !== "undefined") {
     module.exports = {
         createSnow,
-        showSnow,
+        showSnow
     };
 } else {
     window.onload = createSnow;
diff --git a/octoprint_wrapped/templates/wrapped_about.jinja2 b/octoprint_wrapped/templates/wrapped_about.jinja2
@@ -2,16 +2,23 @@
 
 <div data-bind="visible: withinWrappedSeason">
     <div data-bind="visible: currentWrappedAvailable">
-        <img data-bind="src.svgtopng: currentSvgUrl()" width=400 height=400 />
+        <img data-bind="src.svgtopng: currentSvgUrl()"
+             alt="OctoPrint Wrapped sharepic"
+             width="400"
+             height="400" />
     </div>
 
-    <p data-bind="visible: !currentWrappedAvailable()">{% trans %}
-        Sadly, there are no stats available to generate your current OctoPrint Wrapped for you. 
+    <p data-bind="visible: !currentWrappedAvailable()">
+        {% trans %}
+        Sadly, there are no stats available to generate your current OctoPrint Wrapped for you.
         OctoPrint Wrapped depends on the stats collection done by the Achievements plugin,
         so if you disabled that, that would explain it. Make sure to enable the Achievements
         plugin if you want to get your OctoPrint Wrapped next time!
-    {% endtrans %}</p>
+    {% endtrans %}
+</p>
 </div>
-<p data-bind="visible: !withinWrappedSeason()">{% trans %}
+<p data-bind="visible: !withinWrappedSeason()">
+    {% trans %}
     Nothing to see here at the moment! Come back between December 1st and January 10th!
-{% endtrans %}</p>
+{% endtrans %}
+</p>
diff --git a/pyproject.toml b/pyproject.toml
@@ -38,3 +38,101 @@ Homepage = "https://github.com/OctoPrint/OctoPrint-Wrapped"
 develop = [
     "go-task-bin"
 ]
+
+[tool.ruff]
+exclude = [
+    # repo specific
+    "src/octoprint/vendor",
+
+    # standard stuff
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+line-length = 90
+indent-width = 4
+
+# Assume Python 3.9
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["B", "C", "E", "F", "I", "W", "B9"]
+ignore = [
+    "E203",
+    "E231",
+    "E265",
+    "E266",
+    "E402",
+    "E501",
+    "E731",
+    "E741",
+    "W605",
+    "C901",
+]
+fixable = ["I", "C4", "E"]
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.lint.isort]
+known-first-party = [
+    "octoprint_wrapped",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "lf"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[tool.djlint]
+ignore="H005,H007,H019,H021,H023,H030,H031,T002"
+max_blank_lines=1
+use_gitignore=true
+
+[tool.codespell]
+skip = '*.po,*.min.js,.git,*/vendor/*,*/lib/*,*/bootstrap/*,*/node_modules/*,*/translations/*,*/venv*,*/.*,*/build/*,*/_build/*,setup.cfg,AUTHORS.md'
+ignore-words = '.codespell_ignore_words'
+quiet-level = 3
+count = true
+
+[tool.check-wheel-contents]
+ignore = 'W002,W004,W009'

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# OctoPrint-Wrapped 🎁`
	`1`	`+# OctoPrint Wrapped! 🎁`
`2`	`2`
`3`	`3`	`Get your yearly OctoPrint stats a shareable "wrapped" picture - and let it snow! ❄️`
`4`	`4`