public-mirrors
/
composer
mirror of https://github.com/composer/composer
1
0
Fork 0
Code

more consistent ucfirst composer references

pull/4171/head
Rob Bast 2015-06-22 11:08:23 +02:00
parent db4b8dd42b
commit 6ee6074a5c
6 changed files with 59 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/03-cli.md
View File

@ -64,18 +64,18 @@ If there is a `composer.lock` file in the current directory, it will use the
exact versions from there instead of resolving them. This ensures that exact versions from there instead of resolving them. This ensures that
everyone using the library will get the same versions of the dependencies. everyone using the library will get the same versions of the dependencies.
If there is no `composer.lock` file, composer will create one after dependency If there is no `composer.lock` file, Composer will create one after dependency
resolution. resolution.
### Options ### Options
* **--prefer-source:** There are two ways of downloading a package: `source` * **--prefer-source:** There are two ways of downloading a package: `source`
and `dist`. For stable versions composer will use the `dist` by default. and `dist`. For stable versions Composer will use the `dist` by default.
The `source` is a version control repository. If `--prefer-source` is The `source` is a version control repository. If `--prefer-source` is
enabled, composer will install from `source` if there is one. This is enabled, Composer will install from `source` if there is one. This is
useful if you want to make a bugfix to a project and get a local git useful if you want to make a bugfix to a project and get a local git
clone of the dependency directly. clone of the dependency directly.
* **--prefer-dist:** Reverse of `--prefer-source`, composer will install * **--prefer-dist:** Reverse of `--prefer-source`, Composer will install
from `dist` if possible. This can speed up installs substantially on build from `dist` if possible. This can speed up installs substantially on build
servers and other use cases where you typically do not run updates of the servers and other use cases where you typically do not run updates of the
vendors. It is also a way to circumvent problems with git if you do not vendors. It is also a way to circumvent problems with git if you do not
@ -87,7 +87,8 @@ resolution.
installing a package, you can use `--dry-run`. This will simulate the installing a package, you can use `--dry-run`. This will simulate the
installation and show you what would happen. installation and show you what would happen.
* **--dev:** Install packages listed in `require-dev` (this is the default behavior). * **--dev:** Install packages listed in `require-dev` (this is the default behavior).
* **--no-dev:** Skip installing packages listed in `require-dev`. The autoloader generation skips the `autoload-dev` rules. * **--no-dev:** Skip installing packages listed in `require-dev`. The autoloader
generation skips the `autoload-dev` rules.
* **--no-autoloader:** Skips autoloader generation. * **--no-autoloader:** Skips autoloader generation.
* **--no-scripts:** Skips execution of scripts defined in `composer.json`. * **--no-scripts:** Skips execution of scripts defined in `composer.json`.
* **--no-plugins:** Disables plugins. * **--no-plugins:** Disables plugins.
@ -326,7 +327,7 @@ php composer.phar validate
### Options ### Options
* **--no-check-all:** Whether or not composer do a complete validation. * **--no-check-all:** Whether or not Composer does a complete validation.
## status ## status
@ -351,7 +352,7 @@ vendor/seld/jsonlint:
## self-update ## self-update
To update composer itself to the latest version, just run the `self-update` To update Composer itself to the latest version, just run the `self-update`
command. It will replace your `composer.phar` with the latest version. command. It will replace your `composer.phar` with the latest version.
```sh ```sh
@ -364,7 +365,7 @@ If you would like to instead update to a specific release simply specify it:
php composer.phar self-update 1.0.0-alpha7 php composer.phar self-update 1.0.0-alpha7
``` ```
If you have installed composer for your entire system (see [global installation](00-intro.md#globally)), If you have installed Composer for your entire system (see [global installation](00-intro.md#globally)),
you may have to run the command with `root` privileges you may have to run the command with `root` privileges
```sh ```sh
@ -374,11 +375,12 @@ sudo composer self-update
### Options ### Options
* **--rollback (-r):** Rollback to the last version you had installed. * **--rollback (-r):** Rollback to the last version you had installed.
* **--clean-backups:** Delete old backups during an update. This makes the current version of composer the only backup available after the update. * **--clean-backups:** Delete old backups during an update. This makes the
current version of Composer the only backup available after the update.
## config ## config
The `config` command allows you to edit some basic composer settings in either The `config` command allows you to edit some basic Composer settings in either
the local composer.json file or the global config.json file. the local composer.json file or the global config.json file.
```sh ```sh
@ -424,7 +426,7 @@ php composer.phar config repositories.foo vcs https://github.com/foo/bar
## create-project ## create-project
You can use Composer to create new projects from an existing package. This is You can use Composer to create new projects from an existing package. This is
the equivalent of doing a git clone/svn checkout followed by a composer install the equivalent of doing a git clone/svn checkout followed by a "composer install"
of the vendors. of the vendors.
There are several applications for this: There are several applications for this:
@ -434,7 +436,7 @@ There are several applications for this:
3. Projects with multiple developers can use this feature to bootstrap the 3. Projects with multiple developers can use this feature to bootstrap the
initial application for development. initial application for development.
To create a new project using composer you can use the "create-project" command. To create a new project using Composer you can use the "create-project" command.
Pass it a package name, and the directory to create the project in. You can also Pass it a package name, and the directory to create the project in. You can also
provide a version as third argument, otherwise the latest version is used. provide a version as third argument, otherwise the latest version is used.
@ -574,7 +576,7 @@ not be guessed from VCS info and is not present in `composer.json`.
### COMPOSER_VENDOR_DIR ### COMPOSER_VENDOR_DIR
By setting this var you can make composer install the dependencies into a By setting this var you can make Composer install the dependencies into a
directory other than `vendor`. directory other than `vendor`.
### COMPOSER_BIN_DIR ### COMPOSER_BIN_DIR
@ -584,7 +586,7 @@ directory to something other than `vendor/bin`.
### http_proxy or HTTP_PROXY ### http_proxy or HTTP_PROXY
If you are using composer from behind an HTTP proxy, you can use the standard If you are using Composer from behind an HTTP proxy, you can use the standard
`http_proxy` or `HTTP_PROXY` env vars. Simply set it to the URL of your proxy. `http_proxy` or `HTTP_PROXY` env vars. Simply set it to the URL of your proxy.
Many operating systems already set this variable for you. Many operating systems already set this variable for you.
@ -606,18 +608,18 @@ can also set it to `*` to ignore the proxy for all HTTP requests.
### HTTP_PROXY_REQUEST_FULLURI ### HTTP_PROXY_REQUEST_FULLURI
If you use a proxy but it does not support the request_fulluri flag, then you If you use a proxy but it does not support the request_fulluri flag, then you
should set this env var to `false` or `0` to prevent composer from setting the should set this env var to `false` or `0` to prevent Composer from setting the
request_fulluri option. request_fulluri option.
### HTTPS_PROXY_REQUEST_FULLURI ### HTTPS_PROXY_REQUEST_FULLURI
If you use a proxy but it does not support the request_fulluri flag for HTTPS If you use a proxy but it does not support the request_fulluri flag for HTTPS
requests, then you should set this env var to `false` or `0` to prevent composer requests, then you should set this env var to `false` or `0` to prevent Composer
from setting the request_fulluri option. from setting the request_fulluri option.
### COMPOSER_HOME ### COMPOSER_HOME
The `COMPOSER_HOME` var allows you to change the composer home directory. This The `COMPOSER_HOME` var allows you to change the Composer home directory. This
is a hidden, global (per-user on the machine) directory that is shared between is a hidden, global (per-user on the machine) directory that is shared between
all projects. all projects.
@ -639,7 +641,7 @@ configuration in the project's `composer.json` always wins.
### COMPOSER_CACHE_DIR ### COMPOSER_CACHE_DIR
The `COMPOSER_CACHE_DIR` var allows you to change the composer cache directory, The `COMPOSER_CACHE_DIR` var allows you to change the Composer cache directory,
which is also configurable via the [`cache-dir`](04-schema.md#config) option. which is also configurable via the [`cache-dir`](04-schema.md#config) option.
By default it points to $COMPOSER_HOME/cache on \*nix and OSX, and By default it points to $COMPOSER_HOME/cache on \*nix and OSX, and
@ -647,7 +649,7 @@ By default it points to $COMPOSER_HOME/cache on \*nix and OSX, and
### COMPOSER_PROCESS_TIMEOUT ### COMPOSER_PROCESS_TIMEOUT
This env var controls the time composer waits for commands (such as git This env var controls the time Composer waits for commands (such as git
commands) to finish executing. The default value is 300 seconds (5 minutes). commands) to finish executing. The default value is 300 seconds (5 minutes).
### COMPOSER_DISCARD_CHANGES ### COMPOSER_DISCARD_CHANGES
@ -656,7 +658,7 @@ This env var controls the discard-changes [config option](04-schema.md#config).
### COMPOSER_NO_INTERACTION ### COMPOSER_NO_INTERACTION
If set to 1, this env var will make composer behave as if you passed the If set to 1, this env var will make Composer behave as if you passed the
`--no-interaction` flag to every command. This can be set on build boxes/CI. `--no-interaction` flag to every command. This can be set on build boxes/CI.
← [Libraries](02-libraries.md) | [Schema](04-schema.md) → ← [Libraries](02-libraries.md) | [Schema](04-schema.md) →

13
doc/04-schema.md
View File

@ -87,7 +87,7 @@ that needs some special logic, you can define a custom type. This could be a
all be specific to certain projects, and they will need to provide an all be specific to certain projects, and they will need to provide an
installer capable of installing packages of that type. installer capable of installing packages of that type.
Out of the box, composer supports four types: Out of the box, Composer supports four types:
- **library:** This is the default. It will simply copy the files to `vendor`. - **library:** This is the default. It will simply copy the files to `vendor`.
- **project:** This denotes a project rather than a library. For example - **project:** This denotes a project rather than a library. For example
@ -656,7 +656,7 @@ Use `"prefer-stable": true` to enable.
Custom package repositories to use. Custom package repositories to use.
By default composer just uses the packagist repository. By specifying By default Composer just uses the packagist repository. By specifying
repositories you can get packages from elsewhere. repositories you can get packages from elsewhere.
Repositories are not resolved recursively. You can only add them to your main Repositories are not resolved recursively. You can only add them to your main
@ -665,14 +665,14 @@ ignored.
The following repository types are supported: The following repository types are supported:
* **composer:** A composer repository is simply a `packages.json` file served * **composer:** A Composer repository is simply a `packages.json` file served
via the network (HTTP, FTP, SSH), that contains a list of `composer.json` via the network (HTTP, FTP, SSH), that contains a list of `composer.json`
objects with additional `dist` and/or `source` information. The `packages.json` objects with additional `dist` and/or `source` information. The `packages.json`
file is loaded using a PHP stream. You can set extra options on that stream file is loaded using a PHP stream. You can set extra options on that stream
using the `options` parameter. using the `options` parameter.
* **vcs:** The version control system repository can fetch packages from git, * **vcs:** The version control system repository can fetch packages from git,
svn and hg repositories. svn and hg repositories.
* **pear:** With this you can import any pear repository into your composer * **pear:** With this you can import any pear repository into your Composer
project. project.
* **package:** If you depend on a project that does not have any support for * **package:** If you depend on a project that does not have any support for
composer whatsoever you can define the package inline using a `package` composer whatsoever you can define the package inline using a `package`
@ -794,10 +794,11 @@ Optional.
### non-feature-branches ### non-feature-branches
A list of regex patterns of branch names that are non-numeric (e.g. "latest" or something), that will NOT be handled as feature branches. This is an array of strings. A list of regex patterns of branch names that are non-numeric (e.g. "latest" or something),
that will NOT be handled as feature branches. This is an array of strings.
If you have non-numeric branch names, for example like "latest", "current", "latest-stable" If you have non-numeric branch names, for example like "latest", "current", "latest-stable"
or something, that do not look like a version number, then composer handles such branches or something, that do not look like a version number, then Composer handles such branches
as feature branches. This means it searches for parent branches, that look like a version as feature branches. This means it searches for parent branches, that look like a version
or ends at special branches (like master) and the root package version number becomes the or ends at special branches (like master) and the root package version number becomes the
version of the parent branch or at least master or something. version of the parent branch or at least master or something.

23
doc/05-repositories.md
View File

@ -6,7 +6,7 @@ of repositories are available, and how they work.
## Concepts ## Concepts
Before we look at the different types of repositories that exist, we need to Before we look at the different types of repositories that exist, we need to
understand some of the basic concepts that composer is built on. understand some of the basic concepts that Composer is built on.
### Package ### Package
@ -16,8 +16,8 @@ code, but in theory it could be anything. And it contains a package
description which has a name and a version. The name and the version are used description which has a name and a version. The name and the version are used
to identify the package. to identify the package.
In fact, internally composer sees every version as a separate package. While In fact, internally Composer sees every version as a separate package. While
this distinction does not matter when you are using composer, it's quite this distinction does not matter when you are using Composer, it's quite
important when you want to change it. important when you want to change it.
In addition to the name and the version, there is useful metadata. The information In addition to the name and the version, there is useful metadata. The information
@ -312,7 +312,7 @@ should you need to specify one for whatever reason, you can use `git`, `svn` or
If you set the `no-api` key to `true` on a github repository it will clone the If you set the `no-api` key to `true` on a github repository it will clone the
repository as it would with any other git repository instead of using the repository as it would with any other git repository instead of using the
GitHub API. But unlike using the `git` driver directly, composer will still GitHub API. But unlike using the `git` driver directly, Composer will still
attempt to use github's zip files. attempt to use github's zip files.
#### Subversion Options #### Subversion Options
@ -341,7 +341,7 @@ If you have no branches or tags directory you can disable them entirely by
setting the `branches-path` or `tags-path` to `false`. setting the `branches-path` or `tags-path` to `false`.
If the package is in a sub-directory, e.g. `/trunk/foo/bar/composer.json` and If the package is in a sub-directory, e.g. `/trunk/foo/bar/composer.json` and
`/tags/1.0/foo/bar/composer.json`, then you can make composer access it by `/tags/1.0/foo/bar/composer.json`, then you can make Composer access it by
setting the `"package-path"` option to the sub-directory, in this example it setting the `"package-path"` option to the sub-directory, in this example it
would be `"package-path": "foo/bar/"`. would be `"package-path": "foo/bar/"`.
@ -462,7 +462,7 @@ and `IntermediatePackage` from a Github repository:
### Package ### Package
If you want to use a project that does not support composer through any of the If you want to use a project that does not support Composer through any of the
means above, you still can define the package yourself by using a `package` means above, you still can define the package yourself by using a `package`
repository. repository.
@ -517,7 +517,7 @@ Typically you would leave the source part off, as you don't really need it.
While you will probably want to put your packages on packagist most of the time, While you will probably want to put your packages on packagist most of the time,
there are some use cases for hosting your own repository. there are some use cases for hosting your own repository.
* **Private company packages:** If you are part of a company that uses composer * **Private company packages:** If you are part of a company that uses Composer
for their packages internally, you might want to keep those packages private. for their packages internally, you might want to keep those packages private.
* **Separate ecosystem:** If you have a project which has its own ecosystem, * **Separate ecosystem:** If you have a project which has its own ecosystem,
@ -538,15 +538,16 @@ supported use case and changes will happen without caring for third parties
using the code. using the code.
Packagist is a Symfony2 application, and it is [available on Packagist is a Symfony2 application, and it is [available on
GitHub](https://github.com/composer/packagist). It uses composer internally and GitHub](https://github.com/composer/packagist). It uses Composer internally and
acts as a proxy between VCS repositories and the composer users. It holds a list acts as a proxy between VCS repositories and the Composer users. It holds a list
of all VCS packages, periodically re-crawls them, and exposes them as a composer of all VCS packages, periodically re-crawls them, and exposes them as a Composer
repository. repository.
### Toran Proxy ### Toran Proxy
[Toran Proxy](https://toranproxy.com/) is a web app much like Packagist but [Toran Proxy](https://toranproxy.com/) is a web app much like Packagist but
providing private package hosting as well as mirroring/proxying of GitHub and packagist.org. Check its homepage and the [Satis/Toran Proxy article](articles/handling-private-packages-with-satis.md) providing private package hosting as well as mirroring/proxying of GitHub and
packagist.org. Check its homepage and the [Satis/Toran Proxy article](articles/handling-private-packages-with-satis.md)
for more information. for more information.
### Satis ### Satis

14
doc/06-config.md
View File

@ -16,7 +16,7 @@ slow connection or huge vendors.
### use-include-path ### use-include-path
Defaults to `false`. If true, the Composer autoloader will also look for classes Defaults to `false`. If `true`, the Composer autoloader will also look for classes
in the PHP include path. in the PHP include path.
### preferred-install ### preferred-install
@ -49,12 +49,12 @@ an OAuth token for GitHub.
A list of domain names and username/passwords to authenticate against them. For A list of domain names and username/passwords to authenticate against them. For
example using `{"example.org": {"username": "alice", "password": "foo"}` as the example using `{"example.org": {"username": "alice", "password": "foo"}` as the
value of this option will let composer authenticate against example.org. value of this option will let Composer authenticate against example.org.
### platform ### platform
Lets you fake platform packages (PHP and extensions) so that you can emulate a Lets you fake platform packages (PHP and extensions) so that you can emulate a
production env or define your target platform in the config. e.g. `{"php": production env or define your target platform in the config. Example: `{"php":
"5.4", "ext-something": "4.0"}`. "5.4", "ext-something": "4.0"}`.
### vendor-dir ### vendor-dir
@ -72,7 +72,7 @@ into this directory.
Defaults to `$COMPOSER_HOME/cache` on unix systems and Defaults to `$COMPOSER_HOME/cache` on unix systems and
`C:\Users\<user>\AppData\Local\Composer` on Windows. Stores all the caches used `C:\Users\<user>\AppData\Local\Composer` on Windows. Stores all the caches used
by composer. See also [COMPOSER_HOME](03-cli.md#composer-home). by Composer. See also [COMPOSER_HOME](03-cli.md#composer-home).
### cache-files-dir ### cache-files-dir
@ -104,7 +104,7 @@ first until the cache fits.
### prepend-autoloader ### prepend-autoloader
Defaults to `true`. If false, the composer autoloader will not be prepended to Defaults to `true`. If false, the Composer autoloader will not be prepended to
existing autoloaders. This is sometimes required to fix interoperability issues existing autoloaders. This is sometimes required to fix interoperability issues
with other autoloaders. with other autoloaders.
@ -119,7 +119,7 @@ Defaults to `false`. Always optimize when dumping the autoloader.
### classmap-authoritative ### classmap-authoritative
Defaults to `false`. If true, the composer autoloader will not scan the Defaults to `false`. If `true`, the Composer autoloader will not scan the
filesystem for classes that are not found in the class map. Implies filesystem for classes that are not found in the class map. Implies
'optimize-autoloader'. 'optimize-autoloader'.
@ -130,7 +130,7 @@ used for GitHub Enterprise setups.
### github-expose-hostname ### github-expose-hostname
Defaults to `true`. If set to false, the OAuth tokens created to access the Defaults to `true`. If set to `false`, the OAuth tokens created to access the
github API will have a date instead of the machine hostname. github API will have a date instead of the machine hostname.
### notify-on-install ### notify-on-install

4
doc/07-community.md
View File

@ -1,11 +1,11 @@
# Community # Community
There are many people using composer already, and quite a few of them are There are many people using Composer already, and quite a few of them are
contributing. contributing.
## Contributing ## Contributing
If you would like to contribute to composer, please read the If you would like to contribute to Composer, please read the
[README](https://github.com/composer/composer) and [README](https://github.com/composer/composer) and
[CONTRIBUTING](https://github.com//composer/composer/blob/master/CONTRIBUTING.md) [CONTRIBUTING](https://github.com//composer/composer/blob/master/CONTRIBUTING.md)
documents. documents.

11
doc/articles/troubleshooting.md
View File

@ -48,7 +48,7 @@ This is a list of common pitfalls on using Composer, and how to avoid them.
1. Check the ["Package not found"](#package-not-found) item above. 1. Check the ["Package not found"](#package-not-found) item above.
2. If the package tested is a dependency of one of its dependencies (cyclic 2. If the package tested is a dependency of one of its dependencies (cyclic
dependency), the problem might be that composer is not able to detect the version dependency), the problem might be that Composer is not able to detect the version
of the package properly. If it is a git clone it is generally alright and Composer of the package properly. If it is a git clone it is generally alright and Composer
will detect the version of the current branch, but travis does shallow clones so will detect the version of the current branch, but travis does shallow clones so
that process can fail when testing pull requests and feature branches in general. that process can fail when testing pull requests and feature branches in general.
@ -61,7 +61,14 @@ This is a list of common pitfalls on using Composer, and how to avoid them.
## Package not found in a Jenkins-build ## Package not found in a Jenkins-build
1. Check the ["Package not found"](#package-not-found) item above. 1. Check the ["Package not found"](#package-not-found) item above.
2. Reason for failing is similar to the problem which can occur on travis-ci.org: The git-clone / checkout within Jenkins leaves the branch in a "detached HEAD"-state. As a result, composer is not able to identify the version of the current checked out branch and may not be able to resolve a cyclic dependency. To solve this problem, you can use the "Additional Behaviours" -> "Check out to specific local branch" in your Git-settings for your Jenkins-job, where your "local branch" shall be the same branch as you are checking out. Using this, the checkout will not be in detached state any more and cyclic dependency is recognized correctly. 2. Reason for failing is similar to the problem which can occur on travis-ci.org: The
git-clone / checkout within Jenkins leaves the branch in a "detached HEAD"-state. As
a result, Composer is not able to identify the version of the current checked out branch
and may not be able to resolve a cyclic dependency. To solve this problem, you can use
the "Additional Behaviours" -> "Check out to specific local branch" in your Git-settings
for your Jenkins-job, where your "local branch" shall be the same branch as you are
checking out. Using this, the checkout will not be in detached state any more and cyclic
dependency is recognized correctly.
## Need to override a package version ## Need to override a package version