add git commit flag, refactor write_project_files

Author: kguzek

README.md

@@ -24,13 +24,13 @@ python -m pip install ./dist/lpg-*-py3-none-any.whl
 ### Installed package
 
 ```sh
-lpg (--title_slug <problem title> | --url <problem url>) [--directory <project directory>] [--lang <language>] [--force] [--git-init]
+lpg (--title_slug <problem title> | --url <problem url>) [--directory <project directory>] [--lang <language>] [--force] [--git-init] [--git-commit] [--git-commit-message <message>]
 ```
 
 ### Local package
 
 ```sh
-python -m lpg (--title_slug <problem title> | --url <problem url>) [--directory <project directory>] [--lang <language>] [--force] [--git-init]
+python -m lpg (--title_slug <problem title> | --url <problem url>) [--directory <project directory>] [--lang <language>] [--force] [--git-init] [--git-commit] [--git-commit-message <message>]
 ```
 
 ### Explanation

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "leetcode-project-generator"
-version = "1.2.0"
+version = "1.2.1"
 authors = [
   { name = "Konrad Guzek", email = "[email protected]" },
 ]

src/lpg/interfaces/lang/base.py

@@ -17,8 +17,8 @@ def function_signature_pattern(self) -> Pattern[str]:
         """Returns the function signature regular expression pattern."""
 
     @abstractmethod
-    def write_project_files(self, template: str) -> None:
-        """Writes the project files."""
+    def prepare_project_files(self, template: str) -> dict[str, str]:
+        """Generates a dictionary of filenames to file contents."""
 
     def create_project(self, template: str) -> None:
         """Creates the project template."""
@@ -29,4 +29,6 @@ def create_project(self, template: str) -> None:
             )
         self.groups = self.match.groupdict()
 
-        self.write_project_files(template)
+        for filename, content in self.prepare_project_files(template).items():
+            with open(filename, "w", encoding="utf-8") as file:
+                file.write(content)

src/lpg/interfaces/lang/c.py

@@ -28,14 +28,7 @@ class CLanguageInterface(BaseLanguageInterface):
 
     function_signature_pattern = FUNCTION_SIGNATURE_PATTERN
 
-    def write_project_files(self, template: str):
-        """Creates the project template for C."""
-
-        with open("solution.c", "w", encoding="utf-8") as file:
-            file.write(template + "\n")
-
-        with open("solution.h", "w", encoding="utf-8") as file:
-            file.write(HEADER_FILE_TEMPLATE.format(**self.groups))
+    def prepare_project_files(self, template: str):
 
         params = self.groups["params"].split(", ")
         self.groups["param_declarations"] = self.groups["params"].replace(
@@ -44,5 +37,8 @@ def write_project_files(self, template: str):
         self.groups["params_call"] = ", ".join(param.split()[-1] for param in params)
         formatted = TEST_FILE_TEMPLATE.format(**self.groups)
 
-        with open("test.c", "w", encoding="utf-8") as file:
-            file.write(formatted)
+        return {
+            "solution.c": f"{template}\n",
+            "solution.h": HEADER_FILE_TEMPLATE.format(**self.groups),
+            "test.c": formatted,
+        }

src/lpg/interfaces/lang/python3.py

@@ -27,12 +27,7 @@ class Python3LanguageInterface(BaseLanguageInterface):
 
     function_signature_pattern = FUNCTION_SIGNATURE_PATTERN
 
-    def write_project_files(self, template: str):
-        """Creates the project template for Python 3."""
-
-        with open("solution.py", "w", encoding="utf-8") as file:
-            file.write(f"{TYPING_IMPORT_TEMPLATE}\n{template}pass\n")
-
+    def prepare_project_files(self, template: str):
         params = (
             [
                 param
@@ -49,7 +44,7 @@ def write_project_files(self, template: str):
             param.split("=")[0].split(":")[0].strip() for param in params
         )
 
-        formatted = TEST_FILE_TEMPLATE.format(**self.groups)
-
-        with open("test.py", "w", encoding="utf-8") as file:
-            file.write(f"{TYPING_IMPORT_TEMPLATE}{formatted}")
+        return {
+            "solution.py": f"{TYPING_IMPORT_TEMPLATE}\n{template}pass\n",
+            "test.py": f"{TYPING_IMPORT_TEMPLATE}{TEST_FILE_TEMPLATE.format(**self.groups)}",
+        }

src/lpg/lpg.py

@@ -14,6 +14,7 @@
 
 DEFAULT_PROJECT_LANGUAGE = "c"
 DEFAULT_PROJECT_DIRECTORY = R"~/Documents/Coding/{language_name}/leetcode/"
+DEFAULT_COMMIT_MESSAGE = "initialise project {problem_name}"
 
 
 @click.command()
@@ -32,39 +33,61 @@
     "-l",
     help="The language of the code to generate.",
     default=DEFAULT_PROJECT_LANGUAGE,
+    show_default=True,
 )
 @click.option(
     "--directory",
     "-d",
     help="The directory for the project to be created in.",
     default=DEFAULT_PROJECT_DIRECTORY,
+    show_default=True,
 )
 @click.option(
     "--force",
     "-f",
     help="Force-creates the project directory even if it already exists.",
     default=False,
     is_flag=True,
-    show_default=True,
 )
 @click.option(
     "--git-init",
     "-g",
     help="Initialises a git repository in the project directory.",
     default=False,
     is_flag=True,
-    show_default=False,
+)
+@click.option(
+    "--git-commit",
+    "-c",
+    help=(
+        "Creates an initial commit in the project directory. "
+        "Can be used without --git-init  if you have a parent repository."
+    ),
+    default=False,
+    is_flag=True,
+)
+@click.option(
+    "--git-commit-message",
+    "-m",
+    help=(
+        "Creates an initial commit in the project directory. "
+        "Can be used without --git-init if you have a parent repository already."
+    ),
+    default=DEFAULT_COMMIT_MESSAGE,
+    show_default=True,
 )
 @click.help_option("--help", "-h")
 @click.argument("url_or_slug", required=False)
-def lpg(
+def lpg(  # pylint: disable=too-many-arguments, too-many-positional-arguments
     url_or_slug: str | None = None,
     title_slug: str | None = None,
     url: str | None = None,
     lang: str = DEFAULT_PROJECT_LANGUAGE,
     directory: str = DEFAULT_PROJECT_DIRECTORY,
     force: bool = True,
     git_init: bool = False,
+    git_commit: bool = False,
+    git_commit_message: str = DEFAULT_COMMIT_MESSAGE,
 ):
     """Creates a LeetCode skeleton project from the given problem URL or
     title slug in the specified programming language."""
@@ -78,7 +101,14 @@ def lpg(
     title_slug, template_data = get_leetcode_template(lang, title_slug, url)
     path = create_project(title_slug, directory, template_data, force)
     if git_init:
-        subprocess.run("git init", check=True)
+        subprocess.run(["git", "init"], check=True)
+    if git_commit:
+        subprocess.run(["git", "add", "."], check=True)
+        subprocess.run(
+            ["git", "commit", "-m", git_commit_message.format(problem_name=title_slug)],
+            check=False,
+        )
+
     click.echo(f"Successfully created project at {path}!")