Merge remote-tracking branch 'upstream/master'

Author: kuruk-mm

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: pawel_lampe

.github/workflows/deploy.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.7'
+          python-version: '3.8'
 
       - name: Install pypa/build
         run: >-

.github/workflows/tests.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.8, 3.9, '3.10', '3.11', '3.12']
+        python-version: [3.9, '3.10', '3.11', '3.12']
         os: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:

CHANGELOG.md

@@ -2,14 +2,39 @@
 
 ## [master]
 
+### Added
+ - Added support for @abstract functions
+
+### Changed
+ - Fixed formatting of `@warning_ignore_start` and `@warning_ignore_restore`
+ - Fixed formatting of `shadowed_variable*` ignore annotations
+
+## [4.3.4] 2025-06-29
+
+### Changed
+ - Fixed linter problem reports when global scope is used
+ - Fixed formatting of certain `@warning_ignore` annotations
+
+## [4.3.3] 2024-11-02
+
+### Changed
+ - Fixed false-positive `expression-not-assigned` linter check on lambdas
+ - Fixed erroneous DedentError raised in case of inline lambas
+
+## [4.3.2] 2024-10-20
+
 ### Added
  - Added support for multi-statement lambdas (#191)
+ - Added support for typed dictionaries (#322)
 
 ### Changed
  - Removed `private-method-call` linter check due to false positives when calling `super._foo()`
  - Fixed support for `get_node` syntax to accommodate for `$/(...)`
+ - Fixed `gd2py` and `gdradon` to support latest GDScript
  - Changed formatting of some uni-statement lambdas
  - Changed formatting of multi-statement, inline lambdas
+ - Changed formatting of dot-chains containing a lambda(s)
+ - Changed linter check `class-definitions-order` in a way that static class variables are recommended to be placed just after constants
 
 ## [4.3.1] 2024-08-24
 

README.md

@@ -1,7 +1,8 @@
 # GDScript Toolkit
-[![](https://github.com/Scony/godot-gdscript-toolkit/workflows/Tests/badge.svg?branch=master)](https://github.com/Scony/godot-gdscript-toolkit/actions)
+[![](https://github.com/Scony/godot-gdscript-toolkit/workflows/Tests/badge.svg)](https://github.com/Scony/godot-gdscript-toolkit/actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Buy me a coffe](https://img.shields.io/badge/Buy%20me%20a%20coffe-FF5E5B?logo=ko-fi&logoColor=white)](https://ko-fi.com/pawel_lampe)
 
 This project provides a set of tools for daily work with `GDScript`. At the moment it provides:
 
@@ -165,6 +166,34 @@ jobs:
 
 See the discussion in https://github.com/Scony/godot-gdscript-toolkit/issues/239 for more details.
 
+## Using gdtookit in pre-commit
+
+To add gdtookit as a pre-commit hook check the latest GitHub version (eg `4.2.2`) and add the followingto your `pre-commit-config.yaml` with the latest version.
+
+```Yaml
+repos:
+  # GDScript Toolkit
+  - repo: https://github.com/Scony/godot-gdscript-toolkit
+    rev: 4.2.2
+    hooks:
+      - id: gdlint
+        name: gdlint
+        description: "gdlint - linter for GDScript"
+        entry: gdlint
+        language: python
+        language_version: python3
+        require_serial: true
+        types: [gdscript]
+      - id: gdformat
+        name: gdformat
+        description: "gdformat - formatter for GDScript"
+        entry: gdformat
+        language: python
+        language_version: python3
+        require_serial: true
+        types: [gdscript]
+```
+
 ## Development [(more)](https://github.com/Scony/godot-gdscript-toolkit/wiki/5.-Development)
 
 Everyone is free to fix bugs or introduce new features. For that, however, please refer to existing issue or create one before starting implementation.

gdtoolkit/common/ast.py

@@ -3,7 +3,7 @@
 
 from lark import Tree
 
-from ..formatter.annotation import STANDALONE_ANNOTATIONS
+from ..formatter.annotation import is_non_standalone_annotation
 
 from .utils import find_name_token_among_children, find_tree_among_children
 from .exceptions import GDToolkitError
@@ -39,6 +39,9 @@ def _load_sub_statements(self):
             raise NotImplementedError
         if self.kind in ["func_def", "static_func_def"]:
             self.sub_statements = [Statement(n) for n in self.lark_node.children[1:]]
+        elif self.kind == "abstract_func_def":
+            # Abstract functions don't have a body, so no sub-statements
+            pass
         elif self.kind == "if_stmt":
             for branch in self.lark_node.children:
                 if branch.data in ["if_branch", "elif_branch"]:
@@ -114,6 +117,7 @@ def __init__(self, parse_tree: Tree):
         if parse_tree.data == "start":
             start = parse_tree
             self._load_data_from_node_children(start)
+            self.name = "global scope"
         elif parse_tree.data == "class_def":
             self._load_data_from_class_def(parse_tree)
         else:
@@ -123,9 +127,7 @@ def _load_data_from_node_children(self, node: Tree) -> None:
         offset = 1 if node.data == "class_def" else 0
         annotations = []
         for stmt in node.children[offset:]:
-            if stmt.data == "annotation" and not _is_annotation_standalone(
-                Annotation(stmt)
-            ):
+            if stmt.data == "annotation" and is_non_standalone_annotation(stmt):
                 annotations.append(Annotation(stmt))
                 continue
             if stmt.data == "property_body_def":
@@ -142,6 +144,10 @@ def _load_data_from_node_children(self, node: Tree) -> None:
                 function = Function(stmt)
                 self.functions.append(function)
                 self.all_functions.append(function)
+            if stmt.data == "abstract_func_def":
+                function = Function(stmt)
+                self.functions.append(function)
+                self.all_functions.append(function)
 
     def _load_data_from_class_def(self, class_def: Tree) -> None:
         name_token = find_name_token_among_children(class_def)
@@ -158,7 +164,3 @@ def __init__(self, parse_tree: Tree):
         self.root_class = Class(parse_tree)
         self.all_classes = [self.root_class] + self.root_class.all_sub_classes
         self.all_functions = self.root_class.all_functions
-
-
-def _is_annotation_standalone(annotation: Annotation) -> bool:
-    return annotation.name in STANDALONE_ANNOTATIONS

gdtoolkit/formatter/__init__.py

@@ -15,11 +15,16 @@
 DEFAULT_CONFIG = MappingProxyType(
     {
         "excluded_directories": {".git"},
+        "safety_checks": None,
+        "use_spaces": None,
+        "line_length": 100,
     }
 )
 
 
 # pylint: disable-next=too-many-arguments
+# pylint: disable=too-many-positional-arguments
+# pylint: disable=too-many-arguments
 def check_formatting_safety(
     given_code: str,
     formatted_code: str,

gdtoolkit/formatter/__main__.py

@@ -16,7 +16,6 @@
                              (implies --check).
   -f --fast                  Skip safety checks.
   -l --line-length=<int>     How many characters per line to allow.
-                             [default: 100]
   -s --use-spaces=<int>      Use spaces for indent instead of tabs.
   -h --help                  Show this screen.
   --version                  Show version.
@@ -25,14 +24,15 @@
 Examples:
   echo 'pass' | gdformat -   # reads from STDIN
 """
+
 import sys
 import os
 import logging
 import pathlib
 import difflib
 from typing import List, Tuple, Optional
 from types import MappingProxyType
-import pkg_resources
+from importlib.metadata import version as pkg_version
 
 from docopt import docopt
 import lark
@@ -58,9 +58,7 @@ def main():
     sys.stdout.reconfigure(encoding="utf-8")
     arguments = docopt(
         __doc__,
-        version="gdformat {} (kuruk-mm fork)".format(
-            pkg_resources.get_distribution("gdtoolkit").version
-        ),
+        version="gdformat {} (kuruk-mm fork)".format(pkg_version("gdtoolkit")),
     )
 
     if arguments["--dump-default-config"]:
@@ -69,14 +67,6 @@ def main():
     if arguments["--diff"]:
         arguments["--check"] = True
 
-    line_length = int(arguments["--line-length"])
-    spaces_for_indent = (
-        int(arguments["--use-spaces"])
-        if arguments["--use-spaces"] is not None
-        else None
-    )
-    safety_checks = not arguments["--fast"]
-
     config_file_path = _find_config_file()
     config = _load_config_file_or_default(config_file_path)
     _log_config_entries(config)
@@ -86,6 +76,24 @@ def main():
         arguments["<path>"], excluded_directories=set(config["excluded_directories"])
     )
 
+    line_length = (
+        int(arguments["--line-length"])
+        if arguments["--line-length"]
+        else config.get("line_length", DEFAULT_CONFIG["line_length"])
+    )
+
+    spaces_for_indent = (
+        int(arguments["--use-spaces"])
+        if arguments["--use-spaces"]
+        else config.get("use_spaces", DEFAULT_CONFIG["use_spaces"])
+    )
+
+    safety_checks = (
+        not arguments["--fast"]
+        if arguments.get("--fast")
+        else config.get("safety_checks", DEFAULT_CONFIG["safety_checks"])
+    )
+
     if files == ["-"]:
         _format_stdin(line_length, spaces_for_indent, safety_checks)
     elif arguments["--check"]:
@@ -312,6 +320,14 @@ def _format_code(
             sep="\n",
             file=sys.stderr,
         )
+    except lark.indenter.DedentError as exception:
+        success = False
+        print(
+            f"{file_path}:\n",
+            str(exception),
+            sep="\n",
+            file=sys.stderr,
+        )
     except TreeInvariantViolation:
         success = False
         print(