topazdom / wpboot
一个免费的开源轻量级 CLI 工具,用于快速启动 WordPress 主题和插件开发
Requires
- minicli/minicli: ^2.0
- symfony/filesystem: ^5.1
- topazdom/figleti: ^2.0
README
WPboot CLI
wpboot
WPboot 是一个免费的开源轻量级 CLI 应用,由 @zaghadon 创建,用于启动 WordPress 主题和插件开发。此存储库是 wpboot 的官方存储库,也是之前 Themeboot 项目的延续。
为什么选择 wpboot
我作为自由职业者为不同的人构建插件和主题,并希望快速开始一个简单的项目骨架,因此我创建了 wpboot,以帮助我通过简单地提供项目的详细信息并初始化模板来轻松启动新项目;如果您使用它并且喜欢它,请发送您的项目链接,让我将其列在 Created with 上。谢谢 <3
入门
您需要 php-cli、Composer 以及本地的 WordPress 安装才能开始。
简单安装
有两种简单的方法可以在您的计算机上安装 WPBoot。
第一种也是推荐的方法是通过 Composer 全局要求,一行命令。确保将 Composer 的系统级供应商 bin 目录放置在您的 $PATH 中,以便系统可以找到 wpboot 可执行文件。
该目录根据您的操作系统存在于不同的位置;然而,一些常见位置包括
macOS: $HOME/.composer/vendor/bin Windows: %USERPROFILE%\AppData\Roaming\Composer\vendor\bin GNU / Linux 发行版: $HOME/.config/composer/vendor/bin or $HOME/.composer/vendor/bin
展示如何操作
如果它尚未存在,请将以下行添加到您的 Bash 配置文件中(通常是 ~/.bash_profile、~/.bashrc、~/.zshrc 等)
export PATH=~/.composer/vendor/bin:$PATH
如果该文件不存在,请创建它。
运行以下命令以使更改生效
source ~/.bash_profile
您还可以通过运行 composer global about 来查找 composer 的全局安装路径,并从第一行查找。
安装
- 运行
composer global require topazdom/wpboot以在您的计算机中全局安装 WPboot。 - 运行
wpboot以验证安装是否成功。
另一种方法是直接将项目克隆到您的计算机上。更改目录到克隆的项目,并安装 composer 依赖项。
- 运行
git clone https://github.com/topazdom/wpboot.git - 运行
cd wpboot - 运行
composer install
通过以下方式手动将 wpboot 二进制文件导出到您的 PATH 中,使其全局可用:
-
Windows:将
wpboot的路径添加到系统 PATH 变量。 -
Linux:运行
sudo ln -s /usr/local/bin/wpboot /path/to/wpboot,将路径替换为您的 wpboot 安装位置。这将创建您本地全局 bin 文件夹和 wpboot 可执行二进制文件之间的符号链接。 -
Mac:运行
echo 'export PATH="$PATH:$HOME/path/to/wpboot"' >> ~/.zshrc以将二进制文件导出到 PATH。您需要重新启动终端才能使新的 bash 文件生效。 -
运行
wpboot以验证安装是否成功。
简单用法
更改目录到您的 WordPress 安装的主题或插件文件夹。
`cd **/wp-content/themes/` OR `cd **/wp-content/plugins/`.
___________
FOR THEME
___________
Initialize new Theme development From a theme file directory.
`wpboot theme` This would initialize the boilerplate scaffolding in the current directory or folder.
If Running from the /themes/ directory, specify theme folder name using the folder parameter e.g
`wpboot theme folder="newtheme"` This would create the folder and initialize the boilerplate scaffolding in the created directory or folder.
___________
FOR PLUGIN
___________
Initialize new Plugin Development From the Plugin Directory
`wpboot plugin` make sure you provide accurate plugin folder name in the Text Domain Field as this would be used programmatically to help you follow accordingly with the WordPress Naming Standards.
贡献
欢迎贡献力量!您可以贡献代码、文档、提交问题...
待办事项
- 规划和编写单元测试以测试命令。
- 在输入过程中强制执行合规性,通过验证输入并保护用户免受自身伤害。
- 帮助分享给许多WordPress开发者社区。
- 收藏并关注以保持对进化的跟踪。
致谢
-
由@krafthaus_创建的WP主题骨架基于Underscores http://krafthaus.co.id/,(C) 2012-2016 Automattic, Inc. Underscores遵循GNU GPL v2或更高版本的条款分发。
-
WordPressPluginBoilerplate 是WordPress插件开发的基石,旨在提供构建插件的清晰和一致的指南。一个标准化、组织化、面向对象的基石,用于构建高质量的WordPress插件。
-
Minicli 是一个实验性的无依赖工具包,用于在PHP中构建以CLI为中心的应用程序。Minicli作为一个教育实验和构建PHP中的简单命令行应用时去依赖的方法而创建。它可以用于微服务、个人开发工具、机器人和一些有趣的小玩意。
