tdf_tool 2.4.4__py3-none-any.whl

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tdf_tool/app.py

@@ -0,0 +1,15 @@
+import fire
+
+from tdf_tool.pipeline import Pipeline
+from ruamel import yaml
+
+from tdf_tool.tools.print import Print
+
+
+import io
+import sys
+# 将标准输出流的编码方式设置为 UTF-8（用于兼容windows）
+sys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding='utf-8')
+
+def main():
+    fire.Fire(Pipeline())

tdf_tool/pipeline.py

@@ -0,0 +1,36 @@
+import sys
+from tdf_tool.pipelines.module import Module
+from tdf_tool.pipelines.translate import Translate
+from tdf_tool.pipelines.annotation import Annotation
+from tdf_tool.pipelines.fix_header import FixHeader
+from tdf_tool.pipelines.package import Package
+
+from tdf_tool.pipelines.git import Git
+from tdf_tool.pipelines.upgrade import Upgrade
+
+
+class Pipeline:
+    """
+    二维火 Flutter 脚手架工具，包含项目构建，依赖分析，git等功能。。
+    """
+
+    def __init__(self):
+        self.module = Module()
+        self.translate = Translate()
+        self.package = Package()
+        self.fixHeader = FixHeader()
+        
+        # 注解整合命令
+        self.annotation = Annotation()
+
+    def upgrade(self):
+        """
+        tdf_tool upgrade：升级插件到最新版本
+        """
+        Upgrade().run()
+
+    def git(self, *kwargs, **kwargs1):
+        """
+        tdf_tool git【git 命令】：批量操作 git 命令, 例如 tdf_tool git push
+        """
+        Git(sys.argv[2:]).run()

tdf_tool/pipelines/annotation.py

@@ -0,0 +1,119 @@
+import os
+from tdf_tool.tools.config.initial_json_config import InitialJsonConfig
+from tdf_tool.tools.config.module_json_config import ModuleItemType, ModuleJsonConfig
+from tdf_tool.tools.config.packages_config import PackageNode, PackagesJsonConfig
+from tdf_tool.tools.print import Print
+from tdf_tool.tools.shell_dir import ShellDir
+
+from tdf_tool.pipelines.router import Router
+from tdf_tool.pipelines.api_interaction import ApiAnnotation
+
+class Annotation:
+    """
+    模块间支持相关命令：tl annotation -h 查看详情
+    """
+
+    def __init__(self):
+        Print.title("检测中...")
+        self.__buildRunnerName: str = "build_runner" # build_runner库名
+        ShellDir.dirInvalidate()
+        self.__routerAnnotation: Router = Router()
+        self.__apiAnnotation: ApiAnnotation = ApiAnnotation()
+        self.__businessModuleList = self.__api_businessModuleList()
+        self.__packagesList: list[PackageNode] = PackagesJsonConfig(ShellDir.getShellDir()).packages # 壳依赖的所有库
+
+    def start(self):
+        """
+        tl annotation start：会以交互式进行操作，对指定的模块执行描述文件(包括路由，api交互)生成和自动注册逻辑
+        """
+        
+        Print.str("检测到以下模块可生成描述文件：\n")
+        for index, item in enumerate(self.__businessModuleList):
+            print(f"{index}: {item}")
+        print()
+        while True:
+            module_name = input("请输入需要生成描述文件的模块名或其下标(input ! 退出，all 自动注册)：")
+            if module_name == "!" or module_name == "！":
+                exit(0)
+            elif module_name == "all":
+                self.__integrate_shell()
+                exit(0)
+            elif module_name in self.__businessModuleList:
+                self.__generateCode(module_name)
+                Print.title(module_name + "描述文件生成完成")
+                self.__integrate_shell()
+                exit(0)
+            else:
+                try:
+                    i = int(module_name)
+                    if (i < len(self.__businessModuleList)):
+                        _module_anme = self.__businessModuleList[i]
+                        self.__generateCode(_module_anme)
+                        Print.title(_module_anme + "描述文件生成完成")
+                        self.__integrate_shell()
+                        exit(0)
+                    else:
+                        Print.warning("输入有误，请重新输入")
+                except ValueError:
+                    Print.warning("输入有误，请重新输入")                    
+    
+    # 生成指定模块的描述文件
+    def __generateCode(self, targetModule: str):
+        Print.title(targetModule + " 模块生成注解描述文件...")
+        for item in self.__packagesList:
+            if item.packageName == targetModule:
+                if item.isRemote == False:
+                    ShellDir.goInShellDir()
+                    if self.__judgeHasBuildRunnerPackage(item.packagePath):
+                        ShellDir.goInShellDir()
+                        os.chdir(item.packagePath)
+                        self.__generatorFunc()
+                    else:
+                        Print.str(
+                            "请确保模块{0}已依赖build_runner，可参考其他模块进行依赖配置❌".format(
+                                targetModule
+                            )
+                        )
+                else:
+                    Print.str(
+                        "检测到模块{0}当前是远程依赖，无法生成路由描述文件❌".format(targetModule))
+    
+    # 生成代码
+    def __generatorFunc(self):
+        os.system("flutter packages pub run build_runner clean")
+        os.system(
+            "flutter packages pub run build_runner build --delete-conflicting-outputs"
+        )
+    
+    # 判断业务组件下是否有依赖必须的build_runner模块
+    def __judgeHasBuildRunnerPackage(self, packageLibPath: str) -> bool:
+        os.chdir(packageLibPath)
+        packageJsonConfig = PackagesJsonConfig(
+            os.getcwd(), filter_by_tdf=False)
+
+        hasBuildRunner = False
+        for item in packageJsonConfig.packages:
+            if item.packageName == self.__buildRunnerName:
+                hasBuildRunner = True
+                
+        return hasBuildRunner
+                
+
+    def __integrate_shell(self):
+        self.__routerAnnotation.integrate_shell()
+        self.__apiAnnotation.integrate_shell()
+        Print.title("整合完成")
+        
+    def __api_businessModuleList(self):
+        __module_config = ModuleJsonConfig()
+        __list = []
+        for item in InitialJsonConfig().moduleNameList:
+            cofig_item = __module_config.get_item(item)
+            if (
+                cofig_item.type == ModuleItemType.Lib
+                or cofig_item.type == ModuleItemType.Api
+                or cofig_item.type == ModuleItemType.Module
+                or cofig_item.type == ModuleItemType.Plugin
+            ):
+                __list.append(item)
+        return __list

tdf_tool/pipelines/api_interaction.py

@@ -0,0 +1,204 @@
+import os
+import shutil
+from tdf_tool.tools.config.packages_config import PackageNode, PackagesJsonConfig
+from tdf_tool.tools.platform_tools import PlatformTools
+from tdf_tool.tools.print import Print
+from tdf_tool.tools.shell_dir import ShellDir
+
+
+class ImplNode:
+    def __init__(self):
+        self.packageName = ""
+        self.packagePath = ""
+        self.filePath = ""
+
+    def print(self):
+        Print.yellow("package:" + self.packageName + "/" + self.filePath)
+
+
+class ApiNode:
+    def __init__(self):
+        self.packageName = ""
+        self.packagePath = ""
+        self.filePath = ""
+
+    def print(self):
+        Print.yellow("package:" + self.packageName + "/" + self.filePath)
+
+
+class ApiAnnotation:
+    """
+    模块间交互支持相关命令：tl api -h 查看详情
+    """
+
+    def __init__(self):
+        self.ff = None
+        self.__implSuffix: str = ".tdf_impl.dart"  # 交互描述文件后缀
+        self.__implNodeList: list[ImplNode] = []  # impl描述文件列表
+        self.__apiSuffix: str = ".tdf_api.dart"  # 交互api描述文件后缀
+        self.__apiNodeList: list[ApiNode] = []  # api描述文件列表
+        self.__interactionDir: str = "tdf_api"  # 交互文件目录
+        self.__annotationName: str = "tdf_module_api_anno"  # 注解库名
+        self.__packagesList: list[PackageNode] = []  # 壳依赖的所有库
+
+        ShellDir.dirInvalidate()
+        self.fetch_packages_list()
+
+    # 遍历壳应用.packages下的所有package,将所有tdf开头的模块都添加入packagesList中
+    def fetch_packages_list(self):
+        ShellDir.goInShellDir()
+        # 遍历壳应用的所有package,将所有tdf开头的模块都添加入packagesList中
+        self.__packagesList = PackagesJsonConfig(os.getcwd()).packages
+
+    # 整合
+    def integrate_shell(self):
+        # 生成交互文件夹
+        tdf_api_dir = self.get_interaction_dir()
+        auto_register_file = os.path.join(tdf_api_dir, "api_register.dart")
+        self.ff = open(auto_register_file, "w+")
+
+        # 整合所有 tdf_api.dart 文件
+        self.__integrate_tdf_api_files()
+
+        # 整合所有 tdf_impl.dart 文件
+        self.__integrate_tdf_impl_files()
+
+        # 生成注册代码
+        self.__generate_register_code()
+
+        self.ff.close()
+
+        # 全部生成文件format
+        self.__format__()
+
+    def __generate_register_code(self):
+        for _item in self.__implNodeList:
+            self.____import_data_creator(self.ff, _item.packageName, _item.filePath, _item.packageName)
+        for _item in self.__apiNodeList:
+            self.____import_data_creator(self.ff, _item.packageName, _item.filePath, _item.packageName)
+
+        self.__import_data_creator_without_alias(self.ff, "tdf_module_api_anno", "tdf_module_api_anno.dart")
+
+        content = """
+
+        class TDFApiImplAutoRegister {{
+          static List<Type> apis = [
+            {0}
+          ];
+          // 确保所有被引用的api库的实现类都已注册
+          static void _ensureApiImplRegister() {{
+            apis.forEach((element) {{
+              if (!ApiRegisterCenter.keys.contains(element)) {{
+                throw Exception("${{element}}的实现类未未注册！！！请删除库${{element}}的引用或者引入实现类");
+              }}
+            }});
+          }}
+
+          static void autoRegister() {{
+              {1}
+              _ensureApiImplRegister();
+          }}
+        }}
+            """
+        self.ff.write(content.format(
+            self.api_list_creator(),
+            self.__register_list_creator()))
+
+    def __register_list_creator(self):
+        content = ""
+        for item in self.__implNodeList:
+            content += """
+            ApiRegisterCenter.register({0}.AutoRegister.apiType,{1}.AutoRegister.provider);
+            """.format(item.packageName, item.packageName)
+        return content
+
+    def api_list_creator(self):
+        content = ""
+        for item in self.__apiNodeList:
+            content += """
+            {0}.TDFApiAutoInvalidate.apiType,
+                    """.format(item.packageName)
+        return content
+
+    def __integrate_tdf_impl_files(self):
+        Print.title("整合所有交互impl文件")
+        for packageItem in self.__packagesList:
+            __file_path = self.__get_target_file(packageItem.packagePath, self.__implSuffix)
+            if __file_path is not None:
+                _implNode = ImplNode()
+                _implNode.packagePath = packageItem.packagePath
+                _implNode.packageName = packageItem.packageName
+                _implNode.filePath = __file_path
+                _implNode.print()
+                self.__implNodeList.append(_implNode)
+
+    def __integrate_tdf_api_files(self):
+        Print.title("整合所有交互api文件")
+        for packageItem in self.__packagesList:
+            __file_path = self.__get_target_file(packageItem.packagePath, self.__apiSuffix)
+            if __file_path is not None:
+                _apiNode = ApiNode()
+                _apiNode.packagePath = packageItem.packagePath
+                _apiNode.packageName = packageItem.packageName
+                _apiNode.filePath = __file_path
+                _apiNode.print()
+                self.__apiNodeList.append(_apiNode)
+
+    # 获取指定目录下的指定后缀文件
+    def __get_target_file(self, file_path: str, suffix: str) -> str:
+        ShellDir.goInShellDir()
+        os.chdir(file_path)
+
+        count: int = 0
+        __target_file: str
+        nowaPath = os.popen(PlatformTools.pwd_cmd()).read().split("\n")[0]
+        for root, dirs, files in os.walk(nowaPath):
+            for file in files:
+                src_file = os.path.join(root, file)
+                if src_file.endswith(suffix):
+                    count += 1
+                    if PlatformTools.is_windows():
+                        temp = src_file.split("\lib\\")[1]
+                        __target_file = temp.replace("\\", "/")
+                    else:
+                        __target_file = src_file.split("/lib/")[1]
+        if count == 1:
+            return __target_file
+        elif count > 1:
+            raise Exception("模块{0}存在多个交互文件，请检查❌".format(file_path))
+            return None
+        return None
+
+    def get_interaction_dir(self):
+        ShellDir.goInShellDir()
+        os.chdir("lib")
+        if os.path.exists(self.__interactionDir):
+            shutil.rmtree(self.__interactionDir)
+        os.mkdir(self.__interactionDir)
+        return os.path.join(ShellDir.getShellDir(), "lib", self.__interactionDir)
+
+    # 对所有self.__interactionDir目录下的文件执行format
+    def __format__(self):
+        ShellDir.goInShellLibDir()
+        __path = os.path.join(ShellDir.getShellDir(), "lib", self.__interactionDir)
+        os.system("dart format {0}".format(__path))
+
+    # 生成import数据
+    def ____import_data_creator(
+            self, f_write, module_name, file_path, alias
+    ):
+        f_write.write(
+            'import "package:{0}/{1}" as {2};\n'.format(
+                module_name, file_path, alias
+            )
+        )
+
+    # 生成import数据(无重命名)
+    def __import_data_creator_without_alias(
+            self, f_write, module_name, file_path
+    ):
+        f_write.write(
+            'import "package:{0}/{1}";\n'.format(
+                module_name, file_path
+            )
+        )

tdf_tool/pipelines/fix_header.py

@@ -0,0 +1,36 @@
+from tdf_tool.tools.shell_dir import ProjectType, ShellDir
+from tdf_tool.tools.print import Print
+from tdf_tool.tools.fix_header.fix_header_lint import FixHeaderLint
+from tdf_tool.tools.fix_header.fix_header_entry import FixHeaderEntry, FixHeaderType
+
+
+class FixHeader:
+    """
+    iOS修复头文件相关：tl fixHeader -h 查看详情
+    """
+
+    def __init__(self):
+        self.lint = FixHeaderLint()
+        self.__fix_entry = FixHeaderEntry(FixHeaderType.REPLACE)
+
+    def start(self):
+        """
+        tl fixHeader start，会以交互式进行进行头文件修复
+        """
+        ShellDir.dirInvalidate()
+        projectType = ShellDir.getProjectType()
+        if projectType == ProjectType.FLUTTER:
+            Print.error("tl fixHeader 只支持iOS")
+        elif projectType == ProjectType.IOS:
+            self.__fix_entry.start()
+
+    def module(self, name: str):
+        """
+        tl fixHeader module【模块名】，修复指定模块名
+        """
+        ShellDir.dirInvalidate()
+        projectType = ShellDir.getProjectType()
+        if projectType == ProjectType.FLUTTER:
+            Print.error("tl fixHeader 只支持iOS")
+        elif projectType == ProjectType.IOS:
+            self.__fix_entry.module(name)

tdf_tool/pipelines/git.py

@@ -0,0 +1,33 @@
+from tdf_tool.tools.config.initial_json_config import InitialJsonConfig
+from tdf_tool.tools.cmd import Cmd
+from tdf_tool.tools.print import Print
+from tdf_tool.tools.shell_dir import ProjectType, ShellDir
+
+
+class Git:
+    """
+    tl git【git 命令】：批量操作 git 命令, 例如 tl git push
+    """
+
+    def __init__(self, arg: list):
+        self.__gitArg = ["git"] + arg
+        self.__arg = arg
+
+    def run(self):
+        ShellDir.dirInvalidate()
+        self.__batch_run_git()
+
+    def __batch_run_git(self):
+        ShellDir.goInShellDir()
+        projectType = ShellDir.getProjectType()
+        if projectType == ProjectType.FLUTTER:
+            Print.title("开始操作壳：" + " ".join(self.__gitArg))
+            Cmd.runAndPrint(self.__gitArg, shell=False)
+
+            for module in InitialJsonConfig().moduleNameList:
+                ShellDir.goInModuleDir(module)
+                Print.title("开始操作" + module + "模块：" + " ".join(self.__gitArg))
+                Cmd.runAndPrint(self.__gitArg, shell=False)
+        elif projectType == ProjectType.IOS:
+            ios_arg = ["bundle", "exec", "pod", "bin", "batch"] + self.__arg
+            Cmd.runAndPrint(ios_arg, shell=False)

tdf_tool/pipelines/module.py

@@ -0,0 +1,62 @@
+from tdf_tool.tools.cli.project_cli import ProjectCLI
+from tdf_tool.tools.cmd import Cmd
+from tdf_tool.tools.config.config import CLIJsonConfig
+from tdf_tool.tools.shell_dir import ProjectType, ShellDir
+from tdf_tool.tools.vscode.vscode import VsCodeManager
+
+
+class Module:
+    """
+    模块相关工具： tl module -h 查看详情
+    """
+
+    def __init__(self):
+        self.__cli = ProjectCLI()
+        self.__vscodeManager = VsCodeManager()
+
+    def init(self):
+        """
+        项目初始化
+        """
+        ShellDir.dirInvalidate()
+        self.__cli.initial()
+
+    def deps(self):
+        """
+        修改initial_config.json文件后，执行该命令，更新依赖
+        """
+        ShellDir.dirInvalidate()
+        ShellDir.goInShellDir()
+        projectType = ShellDir.getProjectType()
+        if projectType == ProjectType.FLUTTER:
+            self.__cli.cliDeps()
+        elif projectType == ProjectType.IOS:
+            ios_arg = ["bundle", "exec", "pod", "bin", "batch", "clone"]
+            Cmd.runAndPrint(ios_arg, shell=False)
+    
+    def depsUnSync(self):
+        """
+        修改initial_config.json文件后，执行该命令，更新依赖
+        """
+        ShellDir.dirInvalidate()
+        ShellDir.goInShellDir()
+        projectType = ShellDir.getProjectType()
+        if projectType == ProjectType.FLUTTER:
+            self.__cli.depsUnSync()
+        elif projectType == ProjectType.IOS:
+            ios_arg = ["bundle", "exec", "pod", "bin", "batch", "clone"]
+            Cmd.runAndPrint(ios_arg, shell=False)
+
+    def open(self):
+        """
+        打开vscode，同时将所有模块添加入vscode中
+        """
+        ShellDir.dirInvalidate()
+        self.__vscodeManager.openFlutterProject()
+
+    def module_update(self):
+        """
+        更新存储项目git信息的json文件
+        """
+        ShellDir.dirInvalidate()
+        CLIJsonConfig.updateModuleConfig()

tdf_tool/pipelines/package.py

@@ -0,0 +1,49 @@
+import os
+from tdf_tool.tools.dependencies_analysis import DependencyAnalysis
+from tdf_tool.tools.package.seal_off_package_utils import (
+    changeVersionAndDependencies,
+    createAndPushTag,
+    tagInfoObj,
+)
+from tdf_tool.tools.print import Print
+from tdf_tool.tools.shell_dir import ShellDir
+
+
+class Package:
+    """
+    封包工具相关：tl package -h 查看详情
+    """
+
+    def map(self):
+        """
+        tl package map：以二维数组形式输出模块的依赖顺序，每一item列表代表可同时打tag的模块
+        """
+        ShellDir.dirInvalidate()
+        json = DependencyAnalysis().generate()
+        print(json)
+        exit(0)
+
+    def tagInfo(self):
+        """
+        tl package tagInfo：输出一个json，每一节点包含一个模块，
+        内部包含：remote：远程最新版本号；
+        current：模块内配置的版本号；
+        upgrade：对比自增后的版本号；
+        sort：模块打tag顺序，sort相同即代表可同时打tag
+        """
+        ShellDir.dirInvalidate()
+        tagInfoObj()
+
+    def prepareTagTask(self, jsonData: str):
+        """
+        tl package prepareTagTask：修改yaml中的tag号和所有的依赖，该命令可看成是做打tag前的准备工作，把依赖规范化
+        """
+        ShellDir.dirInvalidate()
+        changeVersionAndDependencies(jsonData)
+
+    def tag(self, modules: str):
+        """
+        tl package tag：批量tag操作，参数通过逗号隔开，不要有空格。如tdf_tool package tag tdf_widgets
+        """
+        ShellDir.dirInvalidate()
+        createAndPushTag(modules.split(","))