Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Should we use full Composer package names or Symfony Flex shortcuts? #9693

Closed
javiereguiluz opened this issue Apr 27, 2018 · 5 comments
Closed

Should we use full Composer package names or Symfony Flex shortcuts? #9693

javiereguiluz opened this issue Apr 27, 2018 · 5 comments
Labels
hasPR A Pull Request has already been submitted for this issue.

Comments

@javiereguiluz
Copy link
Member

javiereguiluz commented Apr 27, 2018 •
edited
Loading

Related to #9691 and other similar PRs we've received. Our idea was to always assume that the reader of 3.4+ docs was using Flex, so we use shortcuts everywhere. Should we keep doing that?

My vote is to keep using shortcuts, but let's ask to doc maintainers: @weaverryan @xabbuh @wouterj @HeahDude. Thanks!
@weaverryan
Copy link
Member

I lean slightly towards the longer versions... it avoids issues for some users, and I think people copy-and-paste most of the time anyways. So, that's my vote, but I DO like how cool the aliases look :p

@liviubalan
Copy link
Contributor

I think that a good idea is to use Composer format for Symfony versions <4.0 and the Flex format for Symfony versions >=4.0. According to Flex documentation:

The only caveat is that Symfony Flex requires that applications use the following directory structure, which is the same used by default in Symfony 4

I vote for:
-Composer format for Symfony <4.0
-Flex format for Symfony 4.0+

@javiereguiluz
Copy link
Member Author

Yesterday we discussed about this on Symfony Slack. Most people (all of them in fact) were against Flex shortcuts. The analogy I used was that these shortcuts are like a lottery: when using it you don't know which package will be installed. I'm now more and more convinced of not using these shortcuts anywhere in the docs.

@javiereguiluz
Copy link
Member Author

Ryan, Wouter and I seem to agree on doing this ... so let's do it! I'm going to prepare the PR right now.

@javiereguiluz javiereguiluz mentioned this issue May 7, 2018
Closed
@javiereguiluz javiereguiluz added the hasPR A Pull Request has already been submitted for this issue. label May 7, 2018
javiereguiluz added a commit that referenced this issue May 16, 2018
@javiereguiluz
minor #9742 Don't use Flex shortcuts when installing packages (javier…
06cc6e5 
…eguiluz)

This PR was squashed before being merged into the 4.0 branch (closes #9742).

Discussion
----------

Don't use Flex shortcuts when installing packages

This fixes #9693. I've left some shortcuts on purpose:

* in `frontend/encore/installation.rst`: `composer require encore` because Webpack Encore is a bit special and the shortcut is the best way to install it.
* in `quick_tour/*.rst` because it shows the features provided by Symfony and shortcuts is one of those features. Readers will learn about them and later they'll decide if they want to use them or not.
* in `setup/flex.rst` because they are used on purpose to talk about Flex shortcuts.

Commits
-------

2495590 Don't use Flex shortcuts when installing packages
@javiereguiluz
Copy link
Member Author

Fixed by #9742.

@wouterj wouterj mentioned this issue May 31, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
hasPR A Pull Request has already been submitted for this issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@javiereguiluz @weaverryan @liviubalan