chore: add docstring formatting + linting (#139)

Co-authored-by: Claude <svc-devxp-claude@slack-corp.com>

Author: WilliamBergamin

pyproject.toml

@@ -45,7 +45,24 @@ dependencies = { file = ["requirements.txt"] }
 line-length = 125
 
 [tool.ruff.lint]
-select = ["E", "W", "F"]
+select = ["E", "W", "F", "D"]
+ignore = [
+	# missing-docstring: do not add docstrings where none exist
+	"D100",
+	"D101",
+	"D102",
+	"D103",
+	"D104",
+	"D105",
+	"D106",
+	"D107",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.format]
+docstring-code-format = true
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

slack_cli_hooks/__init__.py

@@ -1,5 +1,4 @@
-"""
-A Slack CLI hooks implementation in Python to build Bolt Slack apps leveraging the full power of the [Slack CLI](https://tools.slack.dev/slack-cli/). Read the [quickstart](https://tools.slack.dev/bolt-python/getting-started/) to learn how to build apps using the Slack CLI and Bolt.
+"""A Slack CLI hooks implementation in Python to build Bolt Slack apps leveraging the full power of the [Slack CLI](https://tools.slack.dev/slack-cli/). Read the [quickstart](https://tools.slack.dev/bolt-python/getting-started/) to learn how to build apps using the Slack CLI and Bolt.
 
 * Slack CLI: https://tools.slack.dev/slack-cli/
 * Bolt Website: https://slack.dev/bolt-python/

slack_cli_hooks/error/__init__.py

@@ -1,6 +1,6 @@
 class CliError(Exception):
-    """General class for cli error"""
+    """General class for cli error."""
 
 
 class PypiError(Exception):
-    """General class for PyPI package info retrieval error"""
+    """General class for PyPI package info retrieval error."""

slack_cli_hooks/protocol/default_protocol.py

@@ -5,19 +5,19 @@ class DefaultProtocol(Protocol):
     name: str = "default"
 
     def debug(self, msg: str, *args, **kwargs):
-        """Nothing will be logged here"""
+        """Nothing will be logged here."""
         pass
 
     def info(self, msg: str, *args, **kwargs):
-        """Nothing will be logged here"""
+        """Nothing will be logged here."""
         pass
 
     def warning(self, msg: str, *args, **kwargs):
-        """Nothing will be logged here"""
+        """Nothing will be logged here."""
         pass
 
     def error(self, msg: str, *args, **kwargs):
-        """Nothing will be logged here"""
+        """Nothing will be logged here."""
         pass
 
     def respond(self, data: str):

slack_cli_hooks/protocol/protocol.py

@@ -20,25 +20,25 @@ def __subclasshook__(cls, subclass):
 
     @abc.abstractmethod
     def debug(self, msg: str, *args, **kwargs):
-        """Logs a message with level DEBUG"""
+        """Logs a message with level DEBUG."""
         raise NotImplementedError
 
     @abc.abstractmethod
     def info(self, msg: str, *args, **kwargs):
-        """Logs a message with level INFO"""
+        """Logs a message with level INFO."""
         raise NotImplementedError
 
     @abc.abstractmethod
     def warning(self, msg: str, *args, **kwargs):
-        """Logs a message with level WARNING"""
+        """Logs a message with level WARNING."""
         raise NotImplementedError
 
     @abc.abstractmethod
     def error(self, msg: str, *args, **kwargs):
-        """Logs a message with level ERROR on the root logger"""
+        """Logs a message with level ERROR on the root logger."""
         raise NotImplementedError
 
     @abc.abstractmethod
     def respond(self, data: str):
-        """Utility method for responding to CLI hook invocations"""
+        """Utility method for responding to CLI hook invocations."""
         raise NotImplementedError

slack_cli_hooks/version.py

@@ -1,3 +1,3 @@
-"""Check the latest version at https://pypi.org/project/slack-cli-hooks/"""
+"""Check the latest version at https://pypi.org/project/slack-cli-hooks/."""
 
 __version__ = "0.3.0"

tests/mock_protocol.py

@@ -4,27 +4,27 @@
 
 
 def debug(self, msg: str, *args, **kwargs):
-    """This is a mock"""
+    """This is a mock."""
     pass
 
 
 def info(self, msg: str, *args, **kwargs):
-    """This is a mock"""
+    """This is a mock."""
     pass
 
 
 def warning(self, msg: str, *args, **kwargs):
-    """This is a mock"""
+    """This is a mock."""
     pass
 
 
 def error(self, msg: str, *args, **kwargs):
-    """This is a mock"""
+    """This is a mock."""
     pass
 
 
 def respond(self, data: str):
-    """This is a mock"""
+    """This is a mock."""
     pass