Add infos missing_spdx_copyright and missing_spdx_license

flashcode · flashcode · commit ecfeb0d509f4 · 2025-04-20T12:52:45.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 ### Added
 
 - Add warnings `hook_process_url` and `hook_process_hashtable_url`
+- Add infos `missing_spdx_copyright` and `missing_spdx_license`
 
 ### Changed
 
diff --git a/README.md b/README.md
@@ -150,6 +150,22 @@ outside WeeChat, which is rare.
 **How to fix**: replace the URL by the official one: [https://weechat.org](https://weechat.org)
 (`https` and no `www`).
 
+### Info: missing_spdx_copyright
+
+**Issue**: the copyright tag "SPDX-FileCopyrightText" is missing in the script header.
+
+**How to fix**: add the [SPDX](https://spdx.dev/) copyright tag "SPDX-FileCopyrightText"
+in the script header
+(see [Scripting contributing guide](https://github.com/weechat/scripts/blob/main/CONTRIBUTING.md#copyright-and-license)).
+
+### Info: missing_spdx_license
+
+**Issue**: the license tag "SPDX-License-Identifier" is missing in the script header.
+
+**How to fix**: add the [SPDX](https://spdx.dev/) license tag "SPDX-License-Identifier"
+in the script header
+(see [Scripting contributing guide](https://github.com/weechat/scripts/blob/main/CONTRIBUTING.md#copyright-and-license)).
+
 ## Example
 
 Default output:
diff --git a/tests/scripts/script_deprecated_hook_completion_get_string.py b/tests/scripts/script_deprecated_hook_completion_get_string.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_deprecated_hook_completion_list_add.py b/tests/scripts/script_deprecated_hook_completion_list_add.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_deprecated_with_condition_hook_completion_get_string.py b/tests/scripts/script_deprecated_with_condition_hook_completion_get_string.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_deprecated_with_condition_hook_completion_list_add.py b/tests/scripts/script_deprecated_with_condition_hook_completion_list_add.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_hook_process.py b/tests/scripts/script_hook_process.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_hook_process_hashtable.py b/tests/scripts/script_hook_process_hashtable.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_missing_email.py b/tests/scripts/script_missing_email.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu
 #
-# Author: Sébastien Helleu
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_missing_infolist_free.py b/tests/scripts/script_missing_infolist_free.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_missing_spdx_copyright.py b/tests/scripts/script_missing_spdx_copyright.py
@@ -0,0 +1,11 @@
+# Author: Sébastien Helleu <flashcode@flashtux.org>
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+"""A WeeChat script."""
+
+import weechat
+
+if __name__ == "__main__":
+    if weechat.register("script", "author", "0.1", "GPL3", "desc", "", ""):
+        pass
diff --git a/tests/scripts/script_missing_spdx_license.py b/tests/scripts/script_missing_spdx_license.py
@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
+
+"""A WeeChat script."""
+
+import weechat
+
+if __name__ == "__main__":
+    if weechat.register("script", "author", "0.1", "GPL3", "desc", "", ""):
+        pass
diff --git a/tests/scripts/script_mixed_tabs_spaces.py b/tests/scripts/script_mixed_tabs_spaces.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_mixed_tabs_spaces_2.py b/tests/scripts/script_mixed_tabs_spaces_2.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_modifier_irc_in.py b/tests/scripts/script_modifier_irc_in.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_python2_bin.py b/tests/scripts/script_python2_bin.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_signal_irc_out.py b/tests/scripts/script_signal_irc_out.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_signal_irc_outtags.py b/tests/scripts/script_signal_irc_outtags.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_sys_exit.py b/tests/scripts/script_sys_exit.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_unneeded_shebang.py b/tests/scripts/script_unneeded_shebang.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_url_weechat.py b/tests/scripts/script_url_weechat.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/scripts/script_valid.py b/tests/scripts/script_valid.py
@@ -1,6 +1,6 @@
+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <flashcode@flashtux.org>
 #
-# Author: Sébastien Helleu <flashcode@flashtux.org>
-#
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """A WeeChat script."""
 
diff --git a/tests/test_script.py b/tests/test_script.py
@@ -43,6 +43,8 @@
     ("warning", 26, "hook_process_hashtable_url"),
     ("info", 1, "unneeded_shebang"),
     ("info", 13, "url_weechat"),
+    ("info", 1, "missing_spdx_copyright"),
+    ("info", 1, "missing_spdx_license"),
 ]
 
 
@@ -83,7 +85,7 @@ def test_script_all_errors() -> None:
     assert str(script)
     assert len(str(script).split("\n")) == len(ALL_ERRORS)
     print(script.count)
-    assert script.count == {"error": 4, "warning": 8, "info": 2}
+    assert script.count == {"error": 4, "warning": 8, "info": 4}
     errors = [(msg.level, msg.line, msg.msg_name) for msg in script.messages]
     assert errors == ALL_ERRORS
     assert len(script.get_report(False).split("\n")) == len(ALL_ERRORS)
@@ -102,7 +104,7 @@ def test_script_all_errors() -> None:
     script.check()
     assert str(script)
     assert len(str(script).split("\n")) == len(ALL_ERRORS) - 2
-    assert script.count == {"error": 3, "warning": 7, "info": 2}
+    assert script.count == {"error": 3, "warning": 7, "info": 4}
     assert len(script.get_report(False).split("\n")) == len(ALL_ERRORS) - 2
     assert script.get_report(True) == "script_all_errors.py"
 
@@ -121,6 +123,6 @@ def test_script_empty_file() -> None:
     assert script.script == ""
     script.check()
     assert str(script)
-    assert script.count == {"error": 1, "warning": 0, "info": 0}
-    assert len(script.get_report(False).split("\n")) == 1
+    assert script.count == {"error": 1, "warning": 0, "info": 2}
+    assert len(script.get_report(False).split("\n")) == 3
     assert script.get_report(True) == "script_empty.py"
diff --git a/weechat_script_lint/script.py b/weechat_script_lint/script.py
@@ -110,6 +110,14 @@
             -1,
             "URL {link} should be changed to https://weechat.org",
         ),
+        "missing_spdx_copyright": (
+            -1,
+            "copyright tag \"SPDX-FileCopyrightText\" is missing",
+        ),
+        "missing_spdx_license": (
+            -1,
+            "license tag \"SPDX-License-Identifier\" is missing",
+        ),
     },
 }
 
@@ -402,6 +410,13 @@ def _check_weechat_site(self) -> None:
                 "info", "url_weechat", line=line_no, link=m.group()
             )
 
+    def _check_spdx_tags(self) -> None:
+        """Check if SPDX tags are present."""
+        if not self.search_regex(r"SPDX-FileCopyrightText:"):
+            self.message("info", "missing_spdx_copyright")
+        if not self.search_regex(r"SPDX-License-Identifier:"):
+            self.message("info", "missing_spdx_license")
+
     # run all checks, display report
 
     def check(self) -> None:

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
	`1`	`+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu <[email protected]>`
`1`	`2`	`#`
`2`		`-# Author: Sébastien Helleu <[email protected]>`
`3`		`-#`
	`3`	`+# SPDX-License-Identifier: GPL-3.0-or-later`
`4`	`4`
`5`	`5`	`"""A WeeChat script."""`
`6`	`6`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
	`1`	`+# SPDX-FileCopyrightText: 2021-2025 Sébastien Helleu`
`1`	`2`	`#`
`2`		`-# Author: Sébastien Helleu`
`3`		`-#`
	`3`	`+# SPDX-License-Identifier: GPL-3.0-or-later`
`4`	`4`
`5`	`5`	`"""A WeeChat script."""`
`6`	`6`