feat add project base config #128

Luffy2004-c · 2024-11-24T13:15:36Z

Description

Related Issue

#126

Type of Change

📚 Examples / docs / tutorials / dependencies update
🔧 Bug fix (non-breaking change which fixes an issue)
🥂 Improvement (non-breaking change which improves an existing feature)
🚀 New feature (non-breaking change which adds functionality)
💥 Breaking change (fix or feature that would cause existing functionality to change)
🔐 Security fix

Checklist

I've read the CODE_OF_CONDUCT.md document.
I've read the CONTRIBUTING.md guide.
I've updated the code style using make codestyle.
I've written tests for all new methods and classes that I created.
I've written the docstring in Google format for all the methods and classes that I used.

github-actions

Hello @Luffy2004-c, thanks for opening your first pull request 😊! We really appreciate your work. Happy Coding 🎉🎊 !

gcop/utils/init_config.py

gcop/__main__.py

gcop/utils/init_config.py

Undertone0809 · 2024-11-24T14:30:06Z

gcop/__main__.py

@@ -73,14 +74,16 @@ def generate_commit_message(
        str: git commit message with ai generated.
    """
    gcop_config = get_config()
-
+    commit_template = (
+        ConfigFileHandleMixin().get_local_config().get("gcoprule", None)


不太建议用 Mixin 这种写法，能不能直接写成一两个函数就好了？simple is good.

Undertone0809 · 2024-11-24T14:31:55Z

gcop/__main__.py

+def init_project_command():
+    """Initialize gcop config"""
+    logger.color_info("Initializing gcop config...")
+    command = InitConfigCommand()


就几行代码，直接写会不会更方直观？

你是指把init_config的逻辑直接全部搬到这个函数里面来吗？

我觉得逻辑可能可以化简一点但也问题不大你先写着

Undertone0809 · 2024-11-24T14:32:38Z

缺文档，可以补充一下使用文档。

Undertone0809 · 2024-11-24T14:34:03Z

最好创建个单测 mock 一下

Luffy2004-c · 2024-11-24T14:36:19Z

GET!🙂

Undertone0809 · 2024-11-24T14:35:31Z

gcop/utils/init_config.py

+    def _check_config_exist(self):
+        return self.config_file_path.exists()
+
+    def get_local_config(self) -> dict:


不要用 dict，用 typing Dict

Undertone0809 · 2024-11-24T14:38:09Z

gcop/utils/init_config.py

+    def _check_config_exist(self):
+        return self.config_file_path.exists()
+
+    def get_local_config(self) -> dict:


我不知道具体里面有什么字段，可以用 dataclass 声明一下

Undertone0809 · 2024-11-28T00:16:56Z

gcop/utils/init_config.py

+        return self.config_file_path.exists()
+
+
+class InitConfigCommand(ConfigFileHandleMixin):


我想说我不太喜欢你这种写法，只有一个函数单独定义个类有什么意义吗，让 AI 给你优化一下

看看 fastapi，django 的源码看看他们写 Mixin 的动机是什么，不要乱套设计模式。

Undertone0809 · 2024-11-28T00:18:20Z

gcop/utils/init_config.py

+
+
+@dataclass
+class LocalConfig:


叫 ProjectConfig 是不是更合适？

~/user/.zeeland/gcop 下的配置也能叫 LocalConfig

Undertone0809 · 2024-11-28T00:29:56Z

gcop/utils/init_config.py

+
+from gcop.utils import Color, logger, read_yaml
+
+INIT_CONFIG_COMMAND = "init_project"


你没 get 到我的意思，我是说 gcop init_project 这个命令很奇怪，而且在命令行中我们一般用 gcop init_project。

这里单独用一个常量，其他 command 都没用常量，你不觉得你这种写法很奇怪吗？

Undertone0809 · 2024-11-28T00:32:15Z

建议把 init_config.py 这个文件删除了

首先这个 init_config.py 的名字含义不明，local config? project config? 我已经有一个 config,py 文件，这个文件是用来干嘛的？
都是 config 为什么不选择都放在 config.py 里面呢？

Undertone0809 · 2024-11-28T00:37:17Z

文档 也很重要，没有文档等于你没更新这个功能，向大家介绍要如何使用最新发布的功能。

Undertone0809 · 2024-11-28T00:50:01Z

gcop/__main__.py

+    """Initialize gcop config"""
+    logger.color_info("Initializing gcop config...")
+    command = InitConfigCommand()
+    if command.handle():


@app.command(name="init-project") @check_version_before_command def init_project_config(): """Initialize gcop project config""" logger.color_info("Initializing gcop project config...") cur_path = Path.cwd() config_path = cur_path / ".gcop" / "config.yaml" if config_path.exists(): logger.color_info("Gcop config already exists.", color=Color.YELLOW) return try: config_path.parent.mkdir(parents=True, exist_ok=True) config_path.touch() except Exception as e: logger.color_info(f"Failed to create gcop config: {e}", color=Color.RED) return

直接用面向过程写一遍是不是更简单？

Undertone0809 · 2024-11-28T00:56:35Z

gcop/__main__.py

@@ -73,14 +78,13 @@ def generate_commit_message(
        str: git commit message with ai generated.
    """
    gcop_config = get_config()
-
+    commit_template = get_local_config().gcoprule or gcop_config.commit_template


为什么这个字段不和 gcop_config 的 commit_template 字段保持一致？这样子会徒增理解成本。

Undertone0809 · 2024-11-28T00:59:29Z

如果 project 都可以有自己的一套 config，为什么不选择和 gcop_config 使用完全一样的字段和配置呢？你当前的写法只能自定义 commit_template，如果你把 gcop_config 和 project_config 抽象成一套 pattern，是不是可以用相同的方式直接读取项目配置和全局配置呢？

… logic

…isting

Undertone0809 · 2024-12-08T19:24:51Z

gcop/config.py

+EXAMPLE_CONFIG = GcopConfig.get_example_config()
+
+
+def check_model_config(new_model: dict) -> bool:


使用 typing Dict，不要用 dict

Undertone0809 · 2024-12-08T19:28:00Z

gcop/config.py

    if not hasattr(get_config, "_instance"):
        get_config._instance = GcopConfig.from_yaml()
-
+    project_config_path = Path.cwd() / ".gcop" / "config.yaml"


看起来感觉可以化简

feat add project base config

2edd2e9

github-actions bot reviewed Nov 24, 2024

View reviewed changes

Undertone0809 requested changes Nov 24, 2024

View reviewed changes

Undertone0809 reviewed Nov 24, 2024

View reviewed changes

Luffy2004-c added 4 commits November 27, 2024 22:33

optimize : add <dataclass> for local config

46ef8b6

test: add test for init_config

aa360fa

feat : add auto commit learn from history

0f312c9

code format

85e02c1

Undertone0809 reviewed Nov 28, 2024

View reviewed changes

Undertone0809 requested changes Nov 28, 2024

View reviewed changes

Luffy2004-c added 6 commits December 7, 2024 11:06

optimise init-project command

38a5340

optimise the way to get config

2fe99b0

refactor : optimise get_config that is added to project configuration…

4b7c684

… logic

fix: fix the logic of check_model_config()

8d7b929

add unit-test for get_config

069d928

fix bugs : fix the logic of getting config while project config is ex…

bddbc6d

…isting

Luffy2004-c force-pushed the add-project-baseconfig branch from bc3b813 to bddbc6d Compare December 8, 2024 02:43

refactor : code format

e06c84d

Undertone0809 reviewed Dec 8, 2024

View reviewed changes

Undertone0809 closed this Dec 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat add project base config #128

feat add project base config #128

Luffy2004-c commented Nov 24, 2024 •

edited

Loading

github-actions bot left a comment

Undertone0809 Nov 24, 2024

Undertone0809 Nov 24, 2024

Luffy2004-c Nov 24, 2024

Undertone0809 Nov 24, 2024

Undertone0809 commented Nov 24, 2024

Undertone0809 commented Nov 24, 2024

Luffy2004-c commented Nov 24, 2024

Undertone0809 Nov 24, 2024

Undertone0809 Nov 24, 2024

Undertone0809 Nov 28, 2024 •

edited

Loading

Undertone0809 Nov 28, 2024 •

edited

Loading

Undertone0809 Nov 28, 2024

Undertone0809 Nov 28, 2024

Undertone0809 Nov 28, 2024 •

edited

Loading

Undertone0809 commented Nov 28, 2024

Undertone0809 commented Nov 28, 2024

Undertone0809 Nov 28, 2024 •

edited

Loading

Undertone0809 Nov 28, 2024

Undertone0809 commented Nov 28, 2024

Undertone0809 Dec 8, 2024

Undertone0809 Dec 8, 2024

		return self.config_file_path.exists()


		class InitConfigCommand(ConfigFileHandleMixin):


		from gcop.utils import Color, logger, read_yaml

		INIT_CONFIG_COMMAND = "init_project"

		EXAMPLE_CONFIG = GcopConfig.get_example_config()


		def check_model_config(new_model: dict) -> bool:

feat add project base config #128

feat add project base config #128

Conversation

Luffy2004-c commented Nov 24, 2024 • edited Loading

Description

Related Issue

Type of Change

Checklist

github-actions bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Undertone0809 commented Nov 24, 2024

Undertone0809 commented Nov 24, 2024

Luffy2004-c commented Nov 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Undertone0809 Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

Undertone0809 Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Undertone0809 Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

Undertone0809 commented Nov 28, 2024

Undertone0809 commented Nov 28, 2024

Undertone0809 Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Undertone0809 commented Nov 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Luffy2004-c commented Nov 24, 2024 •

edited

Loading

Undertone0809 Nov 28, 2024 •

edited

Loading

Undertone0809 Nov 28, 2024 •

edited

Loading

Undertone0809 Nov 28, 2024 •

edited

Loading

Undertone0809 Nov 28, 2024 •

edited

Loading