Merge pull request #5 from Svtter:feat/task-api

add task api. Feat.

docs/api/checker.rst

@@ -0,0 +1,13 @@
+checker
+========
+
+用于检查 git 仓库是否干净。
+
+Usage
+------
+
+.. code-block:: python
+
+   from easybuilder.checker import check_clean
+
+   check_clean()  # 检查 git 仓库是否干净

docs/api/index.rst

@@ -0,0 +1,8 @@
+API
+=====
+
+.. toctree::
+   :maxdepth: 2
+
+   task
+   checker

docs/api/task.rst

@@ -0,0 +1,25 @@
+Task
+======
+
+We create task api to define the task of easybuilder.
+
+预定义的 task 是 :class:`CheckCleanTask`。如果想要替换预定义的 task，可以修改 Worker 的 ``default_tasks``。
+
+Usage
+-----------
+
+如果想要定义自己的 task，可以通过以下方式进行。
+
+.. code-block:: python
+
+    from easybuilder.task import Task
+
+    class MyTask(Task):
+        pass
+
+
+    class MyWorker(Worker):
+        prev_tasks = [MyTask]
+        def main(self):
+            pass
+

docs/index.rst

@@ -23,4 +23,5 @@ Install easybuilder
    :caption: Contents:
 
    usage
+   api/index
 

docs/usage.rst

@@ -37,10 +37,3 @@ easybuilder 是一个简单的构建工具，主要包含以下几个组件：
        # 在临时文件夹中进行操作
        pass
 
-**checker**: 检查工具
------------------------------------
-.. code-block:: python
-
-   from easybuilder.checker import check_clean
-
-   check_clean()  # 检查 git 仓库是否干净

src/easybuilder/task/__init__.py

@@ -0,0 +1,27 @@
+import abc
+import os
+
+from easybuilder.checker import check_clean
+
+
+class Task(abc.ABC):
+    @abc.abstractmethod
+    def action(self):
+        pass
+
+
+class PdmLockTask(Task):
+    """test if pdm.lock is latest"""
+
+    def action(self):
+        ret = os.system("pdm lock --check")
+        if ret != 0:
+            print("pdm.lock is not up to date, please run 'pdm lock' first")
+            exit(1)
+
+
+class CheckCleanTask(Task):
+    """check if git repo is clean"""
+
+    def action(self):
+        check_clean()

src/easybuilder/worker.py

@@ -1,12 +1,19 @@
-from .checker import check_clean
+from . import task
 
 
 class Worker(object):
+    default_tasks: list[type[task.Task]] = [task.CheckCleanTask]
+    prev_tasks: list[type[task.Task]] = []
+    next_tasks: list[type[task.Task]] = []
+
     def __init__(self):
         pass
 
     def before_run(self):
-        check_clean()
+        for t in self.default_tasks:
+            t().action()
+        for t in self.prev_tasks:
+            t().action()
 
     def after_run(self):
         pass