Skip to content

Update the installation instructions for components #11754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions components/asset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/asset
$ composer require symfony/asset:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down Expand Up @@ -153,7 +153,7 @@ corresponding output file:
"...": "..."
}

In those cases, use the
In those cases, use the
:class:`Symfony\\Component\\Asset\\VersionStrategy\\JsonManifestVersionStrategy`::

use Symfony\Component\Asset\Package;
Expand Down
2 changes: 1 addition & 1 deletion components/browser_kit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/browser-kit
$ composer require symfony/browser-kit:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/cache
$ composer require symfony/cache:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/class_loader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/class-loader
$ composer require symfony/class-loader:^3.4

Alternatively, you can clone the `<https://github.com/symfony/class-loader>`_ repository.

Expand Down
2 changes: 1 addition & 1 deletion components/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/config
$ composer require symfony/config:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/console
$ composer require symfony/console:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/css_selector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/css-selector
$ composer require symfony/css-selector:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/debug.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/debug
$ composer require symfony/debug:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/dependency_injection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/dependency-injection
$ composer require symfony/dependency-injection:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/dom_crawler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/dom-crawler
$ composer require symfony/dom-crawler:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/dotenv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/dotenv
$ composer require symfony/dotenv:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/event_dispatcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/event-dispatcher
$ composer require symfony/event-dispatcher:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/expression_language.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/expression-language
$ composer require symfony/expression-language:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/filesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/filesystem
$ composer require symfony/filesystem:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/finder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/finder
$ composer require symfony/finder:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
10 changes: 5 additions & 5 deletions components/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/form
$ composer require symfony/form:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down Expand Up @@ -114,7 +114,7 @@ use the built-in support, first install the Security CSRF component:

.. code-block:: terminal

$ composer require symfony/security-csrf
$ composer require symfony/security-csrf:^3.4

The following snippet adds CSRF protection to the form factory::

Expand Down Expand Up @@ -172,7 +172,7 @@ between Twig and several Symfony components:

.. code-block:: terminal

$ composer require symfony/twig-bridge
$ composer require symfony/twig-bridge:^3.4

The TwigBridge integration provides you with several :doc:`Twig Functions </reference/forms/twig_reference>`
that help you render the HTML widget, label and error for each field
Expand Down Expand Up @@ -260,7 +260,7 @@ installed:

.. code-block:: terminal

$ composer require symfony/translation symfony/config
$ composer require symfony/translation:^3.4 symfony/config:^3.4

Next, add the :class:`Symfony\\Bridge\\Twig\\Extension\\TranslationExtension`
to your ``Twig\\Environment`` instance::
Expand Down Expand Up @@ -305,7 +305,7 @@ it's installed in your application:

.. code-block:: terminal

$ composer require symfony/validator
$ composer require symfony/validator:^3.4

If you're not familiar with Symfony's Validator component, read more about
it: :doc:`/validation`. The Form component comes with a
Expand Down
2 changes: 1 addition & 1 deletion components/http_foundation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/http-foundation
$ composer require symfony/http-foundation:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/http_kernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/http-kernel
$ composer require symfony/http-kernel:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/intl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/intl
$ composer require symfony/intl:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/ldap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/ldap
$ composer require symfony/ldap:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/lock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/lock
$ composer require symfony/lock:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/options_resolver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/options-resolver
$ composer require symfony/options-resolver:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/phpunit_bridge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Installation

.. code-block:: terminal

$ composer require --dev "symfony/phpunit-bridge:*"
$ composer require --dev "symfony/phpunit-bridge::^3.4"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No double colon here and the quotes are not needed, right?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quotes are needed by some shells like zsh IIRC.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, but for now we are not using quotes across the docs, maybe we should add them everywhere then

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so. I confirm the behavior. Quoting is what I'm doing in Twig's docs: https://twig.symfony.com/doc/2.x/installation.html


.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/process
$ composer require symfony/process:^3.4


.. include:: /components/require_autoload.rst.inc
Expand Down
2 changes: 1 addition & 1 deletion components/property_access.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/property-access
$ composer require symfony/property-access:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/property_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/property-info
$ composer require symfony/property-info:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/psr7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/psr-http-message-bridge
$ composer require symfony/psr-http-message-bridge:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/routing
$ composer require symfony/routing:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/security
$ composer require symfony/security:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/serializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/serializer
$ composer require symfony/serializer:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/stopwatch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/stopwatch
$ composer require symfony/stopwatch:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/templating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/templating
$ composer require symfony/templating:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/translation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/translation
$ composer require symfony/translation:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
4 changes: 2 additions & 2 deletions components/using_components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Using the Finder Component

.. code-block:: terminal

$ composer require symfony/finder
$ composer require symfony/finder:^3.4

The name ``symfony/finder`` is written at the top of the documentation for
whatever component you want.
Expand Down Expand Up @@ -64,7 +64,7 @@ them one by one, you can include the ``symfony/symfony`` package:

.. code-block:: terminal

$ composer require symfony/symfony
$ composer require symfony/symfony:^3.4

This will also include the Bundle and Bridge libraries, which you may or
may not actually need.
Expand Down
2 changes: 1 addition & 1 deletion components/validator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/validator
$ composer require symfony/validator:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/var_dumper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Installation

.. code-block:: terminal

$ composer require --dev symfony/var-dumper
$ composer require --dev symfony/var-dumper:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/web_link.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/web-link
$ composer require symfony/web-link:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
2 changes: 1 addition & 1 deletion components/workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Installation

.. code-block:: terminal

$ composer require symfony/workflow
$ composer require symfony/workflow:^3.4

.. include:: /components/require_autoload.rst.inc

Expand Down
Loading