如何在5分钟内上手Laravel Prompts？从安装到第一个交互式命令行表单

如何在5分钟内上手Laravel Prompts？从安装到第一个交互式命令行表单

【免费下载链接】promptsBeautiful and user-friendly forms for your command-line PHP applications.项目地址: https://gitcode.com/gh_mirrors/pro/prompts

Laravel Prompts是一款为PHP命令行应用打造的美观且用户友好的表单工具，能帮助开发者快速构建交互式命令行界面。本文将带你在5分钟内完成从安装到创建第一个交互式表单的全过程，让你的PHP命令行应用体验升级。

1. 快速安装Laravel Prompts的两种方法

1.1 使用Composer一键安装

在你的PHP项目根目录下执行以下命令，即可快速安装Laravel Prompts：

composer require laravel/prompts

1.2 通过Git仓库手动部署

如果你需要手动部署，可以克隆官方仓库到本地：

git clone https://gitcode.com/gh_mirrors/pro/prompts cd prompts composer install

2. 5分钟创建你的第一个交互式表单

2.1 基础表单结构示例

创建一个playground/index.php文件，引入必要的工具函数并定义表单流程：

<?php use function Laravel\Prompts\intro; use function Laravel\Prompts\suggest; use function Laravel\Prompts\text; use function Laravel\Prompts\select; use function Laravel\Prompts\multiselect; use function Laravel\Prompts\confirm; use function Laravel\Prompts\spin; use function Laravel\Prompts\note; use function Laravel\Prompts\outro; require __DIR__.'/../vendor/autoload.php'; intro('Welcome to Laravel Prompts Demo');

2.2 添加表单交互元素

在基础结构中添加各种表单元素，实现完整的交互流程：

1. 智能建议输入

$name = suggest( label: 'What is your name?', placeholder: 'E.g. Taylor Otwell', options: [ 'Dries Vints', 'Guus Leeuw', 'James Brooks', 'Jess Archer', 'Joe Dixon', 'Taylor Otwell' ] );

2. 路径验证输入

$path = text( label: 'Where should we create your project?', placeholder: 'E.g. ./laravel', validate: fn ($value) => match (true) { ! $value => 'Please enter a path', $value[0] !== '.' => 'Please enter a relative path', default => null, } );

3. 单选选择器

$type = select( label: 'Pick a project type', default: 'ts', options: [ 'ts' => 'TypeScript', 'js' => 'JavaScript', ] );

4. 多选选择器

$tools = multiselect( label: 'Select additional tools.', default: ['pint', 'eslint'], options: [ 'pint' => 'Pint', 'eslint' => 'ESLint', 'prettier' => 'Prettier', ] );

5. 确认对话框

$install = confirm( label: 'Install dependencies?' );

2.3 添加加载状态和结果展示

if ($install) { spin(fn () => sleep(3), 'Installing dependencies...'); } note(<<<EOT Installation complete! To get started, run: cd {$path} php artisan serve EOT); outro('Happy coding!');

3. Laravel Prompts核心功能模块解析

3.1 输入类组件

• 文本输入：text()- 基础文本输入，支持验证规则
• 密码输入：password()- 隐藏输入内容的安全密码框
• 智能建议：suggest()- 带自动完成功能的智能输入框

3.2 选择类组件

• 单选选择：select()- 从选项列表中选择一项
• 多选选择：multiselect()- 支持选择多项的复选列表
• 确认提示：confirm()- 简单的是/否确认对话框

3.3 反馈类组件

• 加载状态：spin()- 显示加载动画和状态文本
• 提示消息：note()- 显示格式化的提示信息
• 错误警告：error()/warning()- 显示错误和警告信息

4. 进阶使用技巧

4.1 表单验证最佳实践

利用闭包函数实现复杂验证逻辑：

$password = password( label: 'Provide a password', validate: fn ($value) => match (true) { ! $value => 'Please enter a password.', strlen($value) < 5 => 'Password should have at least 5 characters.', default => null, } );

4.2 自定义主题和样式

通过修改src/Themes/Default目录下的渲染器文件，自定义表单的外观样式，如：

• AutoCompletePromptRenderer.php
• SelectPromptRenderer.php

4.3 表单流程控制

使用FormBuilder.php和FormStep.php实现多步骤表单：

// 示例代码结构 $form = new FormBuilder(); $form->step('personal', 'Personal Information', function () { // 步骤1表单元素 }); $form->step('project', 'Project Settings', function () { // 步骤2表单元素 }); $result = $form->run();

5. 常见问题解决

5.1 依赖冲突问题

如果遇到Composer依赖冲突，尝试更新依赖版本：

composer update laravel/prompts

5.2 非交互式环境兼容

对于CI/CD等非交互式环境，使用FakesInputOutput.php提供模拟输入：

use Laravel\Prompts\Concerns\FakesInputOutput; // 在测试环境中模拟用户输入 FakesInputOutput::fake([ 'name' => 'Test User', 'path' => './test-project', ]);

6. 探索更多示例和工具

Laravel Prompts提供了丰富的示例文件，位于playground目录下，包含各种组件的使用演示：

• autocomplete.php - 自动完成组件示例
• multiselect.php - 多选组件示例
• progress.php - 进度条组件示例
• table.php - 表格展示组件示例

通过这些示例，你可以快速掌握各种组件的使用方法，为你的命令行应用添加更多交互功能。

Laravel Prompts让PHP命令行应用的表单交互变得简单而优雅，无论是构建安装脚本、管理工具还是交互式CLI应用，它都能帮助你提升用户体验。现在就动手尝试，5分钟内打造你的第一个交互式命令行表单吧！

【免费下载链接】promptsBeautiful and user-friendly forms for your command-line PHP applications.项目地址: https://gitcode.com/gh_mirrors/pro/prompts