How to build a wheel with composer

composer is a dependency management tool for PHP. This article will explain how to build a package and submit it to Packagist, so that others can easily use your package through composer.

There are the following steps to develop a composer package:

1. Initialize the composer.json file

2. Define the namespace and package name

3. Function that needs to be implemented to implement the package

4. Submit to GitHub

5. Register the package on Packagist

Initialize the composer.json file

After installing composer, you can run it locallycomposer init Set composer.json through the interactive command line.

The following introduces several of the properties, as well as the general settings:

name

This property defines the package name, separated by /, the preceding one is the supply The vendor name, followed by the package name, is a unique name provided by the vendor representative Packagist website to developers to organize packages and prevent naming conflicts. Therefore, when submitting, it is best to visit https://packagist.org/packages/yourvendorname and replace yourvendorname in the URL with the name you want. If the page does not have 404, it means it has been registered.

license

License. Regarding licenses, it is recommended to read two articles: Introduction to open source project licenses and how to choose license

require

Dependencies required to install the current package. The current package will be installed only if all dependencies are installed.

autoload

This configuration is mainly PSR-4 or PSR-0 settings, and it is more recommended to use the PSR-4 standard.

http://json-schema.org/ The definition of JSON Schema and the implementation of its various functions in various languages ​​are introduced. There is the implementation of validator, among which JSON Schema Validator is an online verification. Serve. In fact, the simplest thing is to use composer validate composer.json to verify whether the file has errors.

Project structure

The project structure is a typical MVC structure.

.
└── geo
    └── geosso
        ├── LICENSE
        ├── README.md
        ├── composer.json
        └── src
            ├── Contracts
            ├── Http
            │   ├── Controllers
            │   ├── Middleware
            │   └── Requests
            ├── ParamsBean
            ├── Providers
            ├── Support
            └── config12 directories

LICENSE, README.md and composer.json are manually created after running tree -d added.

The project root directory is defined under src and is also defined in composer.json, so that when composer loads this package, it knows how to resolve the file path through the namespace.

The Http directory represents the request response, the Controllers below represent the controllers of legal requests, Middleware represents the first level of the request, intercepting the request through middleware, and Requests obtains the front-end request and filters the request.

Contracts represents the interface definition. ParamsBean represents the parameter encapsulation when the application layer communicates with the underlying service. It uses the Bean to obtain each parameter instead of passing an array to make the calls consistent. It also forces type detection when calling the interface, which can largely unify the parameter transfer between layers. .

Providers represents Laravel's service container. Through the service container, you can register routes and configurations, load helper classes, and bind interfaces and their implementations.

Support are some helper classes that encapsulate commonly used functions that have nothing to do with logic. config represents the application's own configuration. Through config, you can easily set the configuration and use the global function config() transfer.

Submit to GitHub

Follow the previous steps, a package will have a basic skeleton. The next step is to upload it to GitHub, configure the project, integrate the continuous integration service, and issue the open source project license.

GitHub When initializing the project, you can choose to generate a .gitignore file, select a license, initialize the README.md file, switch to the local project directory, and follow the following steps to upload the directory to GitHub:

git init # 初始化仓库git remote set-url origin --push --add git@github.com:jayxhj/geosso.git # 添加远程追踪仓库地址git add .
git commit
git push origin master

Submit to Packagist

Packagist is the default address for composer to obtain package metadata information. After obtaining the metadata information from Packagist, pull the code from GitHub. Therefore, after uploading the package you develop to GitHub, you need to register it with Packagist so that people all over the world can pull your code through composer.

The above is the detailed content of How to build a wheel with composer. For more information, please follow other related articles on the PHP Chinese website!