fsac/laravel-react-make

Artisan 命令,用于生成包含 TypeScript 支持的 React 组件

v4.0.0-beta.1 2024-02-24 13:34 UTC

This package is auto-updated.

Last update: 2024-09-24 15:30:27 UTC


README

使用 Artisan 快速在你的 Laravel 应用中搭建 React 组件。包括可定制的模板占位符和 TypeScript 支持。

php artisan make:react MyComponent

支持

安装

在 Laravel 目录下,通过 Composer 进行安装。

composer require --dev fsac/laravel-react-make

基本用法

resources/js/components 下生成一个 React 函数组件。

php artisan make:react PrimaryButton
# -> resources/js/components/PrimaryButton.jsx

您也可以包括子目录

php artisan make:react buttons/Primary
# -> resources/js/components/buttons/Primary.jsx

提供绝对路径将省略 components 前缀,使用 resources/js 作为根目录

php artisan make:react /pages/Settings
# -> resources/js/pages/Settings.jsx

高级用法

TypeScript

该命令也支持生成 TypeScript 组件。也可以使用简写版本 -t

php artisan make:react --typescript PrimaryButton
# -> resources/js/components/PrimaryButton.tsx

文件扩展名

您可以提供自定义文件扩展名。也可以使用简写版本 -x

php artisan make:react --extension js PrimaryButton
# -> resources/js/components/PrimaryButton.js

配置

如果您想自定义默认配置,您必须发布配置文件

php artisan vendor:publish --tag react-config

基本路径

要使用除 resources/js 之外的基本路径,您可以为 base 配置选项提供一个值

'base' => resource_path('ts'),

路径前缀

当指定相对路径时,命令将使用 components 前缀。您可以使用 prefix 配置选项更改此前缀

'prefix' => 'Components',

默认选项

每次使用命令时提供相同的选项,例如当与 TypeScript 代码库一起工作时,可能会变得繁琐。您可以使用 defaults 配置属性提供自己的默认选项值

'defaults' => ['typescript' => true],

自定义占位符

如果您想自定义用于生成组件的默认模板,您可以将它们发布到 stubs 目录

php artisan vendor:publish --tag react-stub

许可证

此代码在 MIT 许可证 下开源。