modmore/moduleskeleton

Commerce模块项目的骨架。

v1.3.3-pl 2023-09-19 14:19 UTC

README

此存储库包含一个Commerce模块项目的骨架。它可以通过composer安装。

mkdir my-project
composer create-project modmore/moduleskeleton my-project

骨架将自动将安装目录的名称重命名到各个部分,并应用一些转换。

  • 对于目录名、词典等,目录名将转换为小写,并在某些地方以commerce_为前缀。
  • 对于命名空间、模块和其他“友好”的位置,使用项目名称,通过-拆分项目名称,将每个部分的第一个字母大写,并将它们组合在一起。(例如,一个名为foo-bar的目录将被转换为FooBar

包含在骨架中

  • 一个构建,用于创建包含设置、核心文件夹、需求验证器和组件目录中docs的包信息的传输包(_build)。此构建还包括由modmore.com包提供者启用的专有代码。
  • 一个引导文件(_bootstrap/index.php),可用于快速设置命名空间、设置和其他关键部分以开始工作。
  • 在核心/组件目录内部
    • 包含许可(MIT)、变更日志和README的包信息文件(在docs中)。
    • 包含项目名称的英文词典存根。
    • model/schema下,一个示例xPDO包架构。如果您使用它,您将找到在/_build/build.schema.php中的脚本,将其转换为模型,并在src/Modules/Projectname.php中的(注释掉的)代码来加载包。
    • src/Modules/Projectname.php中有一个模块,包含填写了基本方法的完整模块。
    • 一个定义PSR-4自动加载器的composer.json文件,用于您的命名空间和项目名称。如果您更改此文件,请在core/components/projectname/目录中运行composer dump-autoload以更新自动加载器。
  • 一个基本的phpcs规则集,既检查PHP 7.4-8.2兼容性,也包含我们项目使用的标准编码规范。它在.github/workflows/phpcs.yml中,在GitHub推送时自动运行,并在项目根目录中的composer.json中。
    • 要本地运行,请确保在根目录中执行composer install
    • 运行composer run phpcs以检查编码规范和PHP版本兼容性
    • 运行composer run phpcbf以自动修复不符合编码规范的代码,在可能的情况下

祝您构建愉快!