README

VoordeMensen (ll-voordemensen)

WordPress 的非官方插件，用于直接访问 VoordeMensen 票务平台

安装

Zip 下载（推荐）

要在您的 WordPress 网站上下载并安装此插件，请按照以下步骤操作

转到版本标签并找到最新版本。
下载名为 ll-voordemensen-x.x.x.zip 的 zip 文件（其中 x.x.x 是版本号）。
将下载的 zip 文件重命名为 ll-voordemensen.zip。
解压 zip 文件。请确保它将内容放入名为 ll-voordemensen 的目录中。
将提取的文件夹及其内容放入 WordPress 安装的 wp-content/plugins 目录。
通过 wp-admin 控制面板激活插件。

Composer 安装（替代方法）

您还可以通过 Packagist 下载插件。请注意，如果您这样做，您的 composer 应该设置为以 wordpress-plugin 类型的包安装在您的 wp-content/plugins 目录中。

配置

要配置插件，只需在 VoordeMensen 插件设置屏幕中填写您的客户端名称。

开发

设置

使用最新的 twenty-* 主题创建一个新的 WordPress 安装。
导航到 wp-content/plugins 目录。
将此存储库克隆到那里，以便创建 ll-voordemensen 目录。
导航到 ll-voordemensen 目录，然后从那里运行

composer-install
npm ci
npm run build

运行 composer run test 以在本地验证结果（有关测试的更多信息请参阅此文件中的后续内容）。

发布

将 main 分支中的所有 PR 合并。
在 ll-voordemensen.php 中更改版本号。
等待所有 GitHub Actions 完成。
更新创建的草稿发布，设置标签和版本名称，采用 SEMVER 结构如 vX.X.X。
发布版本。

Composer

Composer 用于管理自动加载和自动测试。有关测试主题的更多信息请参阅本文件的后续内容。

Webpack

用法

npm run start
npm run lint
npm run fix
npm run build
npm run scripts:lint
npm run scripts:fix
npm run styles:lint
npm run styles:fix
npm run browsersync
npm run bundle-analyzer

如果您在本地遇到 node_modules（尤其是 webpack）的初始安装问题，请尝试将您的本地环境设置为 DEV，在您的 CLI 上执行以下操作

export NODE_ENV=development

问题的原因可能是 Node 版本和它的默认状态（它曾经安装所有包，但最近改为仅安装生产模块）。

配置

使用 webpack 开发服务器自定义配置。复制 development/config.local.json.example 文件并将其保存为 development/config.local.json。在此文件中添加您自己的项目 URL，根据您的开发协议设置安全，并设置端口号。此配置用于覆盖您本地开发环境的默认 URL。这适用于 webpack-dev-server 和 browser-sync。

示例

{
  "url": "http://local.my-site.test",
  "secure": false,
  "port": 1234
}

图片

Webpack 自动处理 SCSS 中使用的图片。对于您直接在 php 中使用的图片，请将其导入到 index.js 中。

import 'images/logo.jpg';

通过使用 ( new \LevelLevel\VoorDeMensen\Assets() )->get_assets_directory_url() 函数在 .php 文件中获取图片 URL。例如，将标志放在标题中

<img src="<?php echo ( new \LevelLevel\VoorDeMensen\Assets() )->get_assets_directory_url(); ?>/images/logo.jpg" alt="">

Lazyload

我们使用浏览器默认的懒加载图像。用法示例

<img src="<?php echo ( new \LevelLevel\VoorDeMensen\Assets() )->get_assets_directory_url(); ?>/images/thumbnail.jpg" loading="lazy" alt="">

Linter

样式检查：使用Styleint，规则设置在.stylelintrc.json中。查看所有文档规则
JavaScript：使用eslint，规则设置在.eslintrc.json中。查看所有文档规则

本地化

此仓库的默认文本语言为英语。确保将所有带有text-domain ll-vdm的字符串进行翻译。

运行：composer run make-pot以更新.pot文件。

自动测试

存在多个代码测试。

Composer，用于检查composer文件是否完好
PHPCS，用于检查是否遵循Level Level PHP代码标准
Psalm测试，寻找代码中的可能错误
PHP Doc Check，用于检查复杂函数是否有解释其功能的注释

GitHub动作

在每次pull-request时，都会运行一个GitHub动作，该动作基于composer run test的结果验证项目。您需要在仓库中提供以下密钥（在设置/密钥下）

SATIS_DOMAIN（不带协议）
SATIS_USERNAME
SATIS_PASSWORD

手动

运行composer run test以本地验证结果。

修复

运行composer run fix以使用自动化修复工具，如phpcbf。

使用https本地工作

如果您在本地使用https，则需要启用Chrome以允许无效证书。要启用此功能，请转到：chrome://flags/#allow-insecure-localhost并启用允许从localhost加载的资源使用无效证书选项。

编辑器配置

主题附带一个.editorconfig文件。要使此功能正常工作，您需要安装一个使用.editorconfig文件的插件。

level-level / ll-voordemensen

维护者

详细信息