JosephLeedy/module-xml-validator

为XML文件与配置的schema进行验证添加控制台命令

0.2.1 2022-11-17 21:45 UTC

This package is auto-updated.

Last update: 2024-09-25 19:44:55 UTC


README

Joseph Leedy的XML Validator是用于Magento开源和Adobe Commerce的开发工具,它添加了一个控制台命令,用于验证XML文件是否与其配置的schema一致。

功能与优势

  • 确保您的XML文件根据其对应的核心schema有效,从而减少部署和运行时错误

要求

  • Magento开源或Adobe Commerce版本2.4.4或更高版本(建议版本2.4.5或更高版本)
  • PHP版本7.4.32或更高,或PHP 8.1.12或更高(建议)

安装

您可以通过在终端或命令提示符中输入以下命令,通过Composer安装XML Validator扩展

cd /path/to/your/store
composer require --dev joseph-leedy/module-xml-validator

安装后

在扩展安装后,您必须运行以下命令以修复您的setup/src/Magento/Setup/Console/CommandList.php文件。这将允许工具仅在安装了核心Magento文件且没有数据库的情况下运行。

patch -p1 < vendor/joseph-leedy/module-xml-validator/patches/Add-validate-XML-command-to-Setup-Command-List.patch

更新

要使用Composer更新XML Validator扩展,请在终端或命令提示符中运行以下命令

cd /path/to/your/store
composer update joseph-leedy/module-xml-validator

安装后或更新后

要完成安装或更新过程,请运行以下命令

cd /path/to/your/store
php bin/magento module:enable JosephLeedy_XmlValidator
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

用法

命令行

使用以下命令在本地环境中运行此工具

cd /path/to/your/store
bin/magento dev:xml:validate path/to/your/code

参数

使用GitHub Actions的CI/CD

此工具将自动检测它是否在GitHub Actions的持续集成和持续部署(CI/CD)管道中运行,并输出所需的语句以在受影响的代码中显示警告和错误。未来版本将添加对其他CI/CD管道的支持。

支持

如果在使用此扩展时遇到任何问题或错误,请在GitHub存储库中打开一个问题。请确保包括所有相关信息,包括问题或错误的描述、发生时您正在做什么、安装的Magento开源或Adobe Commerce和PHP版本,以及其他相关细节。我将尽力及时回应您的请求,通常在24-48个工作小时内(周一至周五上午9:00至下午5:00美国东部时间,不包括节假日)。

许可证

此扩展中包含的源代码根据开源软件许可证版本3.0 (OSL-3.0) 许可。此许可证的副本可以在源代码包中的LICENSE文件中找到,或在网上https://open-source.org.cn/licenses/OSL-3.0找到。

包含的源代码的版权由Joseph Leedy独家持有,所有权利保留。

历史

扩展的完整历史记录可以在CHANGELOG.md文件中找到。

贡献

我们欢迎并重视您的贡献。有关如何帮助我们改进和维护此工具的更多详细信息,请参阅CONTRIBUTING.md文件。