Godot GDScript Toolkit 项目教程

1. 项目目录结构及介绍

Godot GDScript Toolkit 项目的目录结构如下：

godot-gdscript-toolkit/
├── CHANGELOG.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── action.yml
├── makefile
├── pylintrc
├── setup.cfg
├── setup.py
├── tox.ini
├── github/
│   └── workflows/
├── editor-plugins/
│   └── emacs/
├── gdtoolkit/
│   ├── common/
│   ├── formatter/
│   ├── gd2py/
│   ├── gdradon/
│   ├── linter/
│   └── parser/
├── stubs/
│   └── lark/
└── tests/

目录结构介绍

• CHANGELOG.md: 记录项目的变更日志。
• LICENSE: 项目的开源许可证文件。
• MANIFEST.in: 用于指定在打包时需要包含的文件。
• README.md: 项目的介绍和使用说明。
• action.yml: GitHub Actions 的配置文件。
• makefile: 项目的 Makefile，用于自动化构建和测试。
• pylintrc: Pylint 的配置文件，用于代码质量检查。
• setup.cfg: 项目的配置文件，包含安装和构建的配置。
• setup.py: 项目的安装脚本。
• tox.ini: Tox 的配置文件，用于自动化测试。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• editor-plugins/emacs/: 包含 Emacs 编辑器的插件文件。
• gdtoolkit/: 包含 GDScript 工具的核心代码，包括解析器、格式化器、代码检查器等。
• stubs/lark/: 包含 Lark 解析器的存根文件。
• tests/: 包含项目的测试代码。

2. 项目启动文件介绍

项目的启动文件主要位于 gdtoolkit 目录下，每个子目录对应一个工具模块。以下是主要的启动文件：

• gdtoolkit/parser/main.py: GDScript 解析器的启动文件。
• gdtoolkit/linter/main.py: GDScript 代码检查器的启动文件。
• gdtoolkit/formatter/main.py: GDScript 代码格式化器的启动文件。
• gdtoolkit/gd2py/main.py: GDScript 到 Python 转换器的启动文件。
• gdtoolkit/gdradon/main.py: GDScript 代码复杂度计算器的启动文件。

这些启动文件通过 setup.py 中的 entry_points 配置，可以在安装后通过命令行直接调用。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

• setup.cfg: 项目的配置文件，包含安装和构建的配置。例如：

  [metadata]
  name = gdtoolkit
  version = 4.3.2
  description = Independent set of tools for working with GDScript - parser, linter and formatter
  

• pylintrc: Pylint 的配置文件，用于代码质量检查。例如：

  [MASTER]
  disable = missing-docstring, invalid-name
  

• tox.ini: Tox 的配置文件，用于自动化测试。例如：

  [tox]
  envlist = py37, py38, py39, py310
  

• action.yml: GitHub Actions 的配置文件，用于自动化工作流。例如：

  name: Static checks
  on:
    push:
      branches: [ "main" ]
    pull_request:
      branches: [ "main" ]
  jobs:
    static-checks:
      name: 'Static checks'
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v4
        - uses: Scony/godot-gdscript-toolkit@master
        - run: gdformat --check source/
        - run: gdlint source/
  

这些配置文件共同协作，确保项目的安装、构建、测试和部署过程能够顺利进行。