Fix linter support for docstrings, fixes Scony#233

Author: Scony

CHANGELOG.md

@@ -10,6 +10,7 @@
  - Fixed `max-public-methods` linter check disabling (#222)
  - Default regex for names of constants now allows underscore as a prefix to denote private contants (#223)
  - Fixed parsing of files without newline at the end of file ending with comment (#237)
+ - Fixed linter support for docstrings (#233)
 
 ## [4.1.0] 2023-07-06
 

gdtoolkit/linter/__init__.py

@@ -61,6 +61,7 @@
  "tools",
  "classnames",
  "extends",
+ "docstrings",
  "signals",
  "enums",
  "consts",

gdtoolkit/linter/class_checks.py

@@ -141,6 +141,8 @@ def _map_statement_to_section(statement: Statement) -> str:
  return "others"
  if statement.kind == "static_func_def":
  return "others"
+ if statement.kind == "docstr_stmt":
+ return "docstrings"
  raise NotImplementedError
 
 

tests/linter/test_basic_corner_cases.py

@@ -9,3 +9,8 @@ def test_newlineless_code():
  code = """func foo():
  pass"""
  lint_code(code)
+
+
+def test_docstring():
+ code = '"""\nhello world!\n"""'
+ lint_code(code)

tests/linter/test_class_checks.py

@@ -36,6 +36,7 @@ def test_private_method_call_nok(code):
 pass
 class_name Foo
 extends Node
+"docstring"
 signal s
 enum { A, B, C }
 const X = 1
@@ -90,6 +91,9 @@ class X: var x;extends Node
 """static func foo(): pass
 var x
 """,
+"""'docstring'
+extends Node
+""",
 ])
 def test_class_definitions_order_nok(code):
  simple_nok_check(code, 'class-definitions-order')