22创建 Composer 包
33##########################
44
5- 您可以将您创建的 :doc: `../general/modules ` 转换为 Composer 包,或者为 CodeIgniter 4 创建一个 Composer 包。
5+ 你可以将你创建的 :doc: `../general/modules ` 转换为 Composer 包,或者为 CodeIgniter 4 创建一个 Composer 包。
66
77.. contents ::
88 :local:
2929创建 composer.json
3030**********************
3131
32- 在您的包目录的根目录中 ,创建一个 **composer.json ** 文件。该文件定义了关于您的包及其依赖项的元数据 。
32+ 在你的包目录的根目录中 ,创建一个 **composer.json ** 文件。该文件定义了关于你的包及其依赖项的元数据 。
3333
34- 使用 ``composer init `` 命令可以帮助您创建它 。
34+ 使用 ``composer init `` 命令可以帮助你创建它 。
3535
3636例如,**composer.json ** 可能如下所示::
3737
5252 }
5353 ],
5454 "require": {
55- // 在此处添加您的包所需的任何依赖项
55+ // 在此处添加你的包所需的任何依赖项
5656 },
5757 "require-dev": {
5858 // 在此处添加开发所需的任何依赖项(例如 PHPUnit)
6464
6565``name `` 字段在这里非常重要。包名称通常以 "vendor-name/package-name" 的格式书写,全部小写。以下是一个常见的示例:
6666
67- - ``your-vendor-name ``:标识供应商(包的创建者)的名称,例如您的姓名或组织名称 。
68- - ``your-package-name ``:您正在创建的包的名称 。
67+ - ``your-vendor-name ``:标识供应商(包的创建者)的名称,例如你的姓名或组织名称 。
68+ - ``your-package-name ``:你正在创建的包的名称 。
6969
7070因此,为了使名称唯一以区分其它包,使其与其他包区分开是非常重要的,尤其是在发布时。
7171
7474
7575包名称决定了 ``autoload.psr4 `` 中的供应商命名空间。
7676
77- 如果您的包名称是 ``your-vendor/your-package ``,那么供应商命名空间必须是 ``YourVendor ``。因此,您需要像下面这样编写 ::
77+ 如果你的包名称是 ``your-vendor/your-package ``,那么供应商命名空间必须是 ``YourVendor ``。因此,你需要像下面这样编写 ::
7878
7979 "autoload": {
8080 "psr-4": {
8181 "YourVendor\\YourPackage\\": "src/"
8282 }
8383 }
8484
85- 这个设置指示 Composer 自动加载您的包的源代码 。
85+ 这个设置指示 Composer 自动加载你的包的源代码 。
8686
8787选择许可证
8888================
8989
90- 如果您对开源许可证不熟悉 ,请参考 https://choosealicense.com/。许多 PHP 包,包括 CodeIgniter,使用 MIT 许可证。
90+ 如果你对开源许可证不熟悉 ,请参考 https://choosealicense.com/。许多 PHP 包,包括 CodeIgniter,使用 MIT 许可证。
9191
9292***************************
9393准备开发工具
9494***************************
9595
96- 有许多工具可以帮助确保代码质量。因此,您应该使用它们。您可以使用 `CodeIgniter DevKit <https://github.com/codeigniter4/devkit >`_ 轻松安装和配置此类工具。
96+ 有许多工具可以帮助确保代码质量。因此,你应该使用它们。你可以使用 `CodeIgniter DevKit <https://github.com/codeigniter4/devkit >`_ 轻松安装和配置此类工具。
9797
9898安装 DevKit
9999=================
100100
101- 在您的包目录的根目录中 ,运行以下命令:
101+ 在你的包目录的根目录中 ,运行以下命令:
102102
103103.. code-block :: console
104104
105105 composer config minimum-stability dev
106106 composer config prefer-stable true
107107 composer require --dev codeigniter4/devkit
108108
109- DevKit 安装了各种 Composer 包,帮助您进行开发 ,并在 **vendor/codeigniter4/devkit/src/Template ** 中为它们安装了模板。将其中的文件复制到您的项目根目录,并根据您的需求进行编辑 。
109+ DevKit 安装了各种 Composer 包,帮助你进行开发 ,并在 **vendor/codeigniter4/devkit/src/Template ** 中为它们安装了模板。将其中的文件复制到你的项目根目录,并根据你的需求进行编辑 。
110110
111111配置 Coding Standards Fixer
112112==================================
113113
114114DevKit 提供了基于 `PHP-CS-Fixer <https://github.com/PHP-CS-Fixer/PHP-CS-Fixer >`_ 的 `CodeIgniter Coding Standard <https://github.com/CodeIgniter/coding-standard >`_ 的 Coding Standards Fixer。
115115
116- 将 **vendor/codeigniter4/devkit/src/Template/.php-cs-fixer.dist.php ** 复制到您的项目根目录 。
116+ 将 **vendor/codeigniter4/devkit/src/Template/.php-cs-fixer.dist.php ** 复制到你的项目根目录 。
117117
118118为缓存文件创建 **build ** 文件夹::
119119
120120 your-package-name/
121121 ├── .php-cs-fixer.dist.php
122122 ├── build/
123123
124- 打开您的编辑器中的 **.php-cs-fixer.dist.php ** 文件,并修复文件夹路径::
124+ 打开你的编辑器中的 **.php-cs-fixer.dist.php ** 文件,并修复文件夹路径::
125125
126126 --- a/.php-cs-fixer.dist.php
127127 +++ b/.php-cs-fixer.dist.php
@@ -135,13 +135,13 @@ DevKit 提供了基于 `PHP-CS-Fixer <https://github.com/PHP-CS-Fixer/PHP-CS-Fix
135135 ])
136136 ->exclude([
137137
138- 完成后,您可以运行 Coding Standards Fixer:
138+ 完成后,你可以运行 Coding Standards Fixer:
139139
140140.. code-block :: console
141141
142142 vendor/bin/php-cs-fixer fix --ansi --verbose --diff
143143
144- 如果您在 **composer.json ** 中添加了 ``scripts.cs-fix ``,则可以使用 ``composer cs-fix `` 命令运行它::
144+ 如果你在 **composer.json ** 中添加了 ``scripts.cs-fix ``,则可以使用 ``composer cs-fix `` 命令运行它::
145145
146146 {
147147 // ...
@@ -158,20 +158,20 @@ DevKit 提供了基于 `PHP-CS-Fixer <https://github.com/PHP-CS-Fixer/PHP-CS-Fix
158158允许用户覆盖设置
159159===================================
160160
161- 如果您的包有一个配置文件,并且您希望用户能够覆盖设置 ,可以使用 :php:func: `config() ` 函数与短类名(例如 ``config('YourConfig') ``)来调用配置文件。
161+ 如果你的包有一个配置文件,并且你希望用户能够覆盖设置 ,可以使用 :php:func: `config() ` 函数与短类名(例如 ``config('YourConfig') ``)来调用配置文件。
162162
163163然后,用户可以通过在 **app/Config ** 中放置一个与短类名相同且扩展了包配置类的配置类(例如 ``YourVendor\YourPackage\Config\YourConfig ``)来覆盖包配置。
164164
165165在 app/Config 中覆盖设置
166166=================================
167167
168- 如果您需要在 **app/Config ** 文件夹中覆盖或添加已知配置,可以使用 :ref: `Implicit Registrars <registrars >`。
168+ 如果你需要在 **app/Config ** 文件夹中覆盖或添加已知配置,可以使用 :ref: `Implicit Registrars <registrars >`。
169169
170170**********
171171参考资料
172172**********
173173
174- 我们已经发布了一些官方包。您可以在创建自己的包时使用这些包作为参考 :
174+ 我们已经发布了一些官方包。你可以在创建自己的包时使用这些包作为参考 :
175175
176176- https://github.com/codeigniter4/shield
177177- https://github.com/codeigniter4/settings
0 commit comments