Add composer template #15

geerteltink · 2017-07-13T09:59:01Z

As discussed in several communication channels, there is no clear path on how the composer.json file should look like these days. There have been many changes which were not communicated to all maintainers and contributors in a central place. This PR adds a composer.json template to provide that central communication to everyone involved.

froschdesign · 2017-07-13T10:09:28Z

@xtreamwayz
You are too fast! 😉
I had already written a new issue report, but your PR is much better!

froschdesign · 2017-07-13T10:11:50Z

template/composer.json

+    "type": "library",
+    "license": "BSD-3-Clause",
+    "keywords": [
+        "http",


I would replace these lines with a short description like:

"keywords" : [ "<individual keywords for current project>" ],

michalbundyra · 2017-07-13T10:11:43Z

template/composer.json

+        }
+    },
+    "require": {
+        "php": "^5.6 || ^7.0"


Should we change order also here, to have first 7.0?

Don't know. I think in every project it's the lowest PHP first at the moment.

michalbundyra · 2017-07-13T10:12:48Z

template/composer.json

+        "issues": "https://github.com/zendframework/<project-name>/issues",
+        "source": "https://github.com/zendframework/<project-name>",
+        "slack": "https://zendframework-slack.herokuapp.com",
+        "forum": "https://discourse.zendframework.com"


Should we have here link to the main page of forum or maybe specific category there?
https://github.com/zendframework/zend-expressive/blob/master/composer.json#L19

If a category exists, then we should use it.

michalbundyra · 2017-07-13T10:13:29Z

template/composer.json

+    "type": "library",
+    "license": "BSD-3-Clause",
+    "keywords": [
+        "http",


Maybe we should have here also zf or zendframework keyword?

michalbundyra · 2017-07-13T10:13:50Z

template/composer.json

+        "test": "phpunit --colors=always",
+        "test-coverage": "phpunit --coverage-clover clover.xml"
+    }
+}


Please add empty line at the end of the file.

michalbundyra · 2017-07-13T10:14:20Z

template/composer.json

+        "php": "^5.6 || ^7.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^6.0.8 || ^5.7.15",


I would update these version to the latest: ^6.2.3 || ^5.7.21

I agree, however PHP Unit updates twice a month or so. It should not be the goal of this template to keep track of PHP Unit releases.

michalbundyra · 2017-07-13T10:15:22Z

template/composer.json

+    "type": "library",
+    "license": "BSD-3-Clause",
+    "keywords": [
+        "<individual keywords for current project>"


Maybe we should have here some common keywords like zf or zendframework?

Good question. The keywords are used at searching and filtering. Maybe is "zend" as mark / brand also interesting?!

froschdesign · 2017-07-13T10:17:54Z

template/composer.json

@@ -0,0 +1,55 @@
+{
+    "name": "zendframework/<project-name>",
+    "description": "<project-description>",


My suggestion:

"description": "<project description, the same like the repository description>",

- Add default keywords - Add possible forum categories - Update PHP Unit versions - Add empty line at end of file - Update description

@see

> It is recommended to omit this field and have it just default to > `library`. @see https://getcomposer.org/doc/04-schema.md#type

froschdesign · 2017-07-14T07:43:29Z

template/composer.json

@@ -2,7 +2,6 @@
    "name": "zendframework/<project-name>",
    "description": "<project description, the same like the repository description>",
    "homepage": "https://docs.zendframework.com/<project-name>/",
-    "type": "library",


Good catch! 👍

michalbundyra · 2017-07-14T07:44:47Z

@xtreamwayz what about adding:

"config": {
  "sort-packages": true
},

https://github.com/weierophinney/hal/blob/master/composer.json#L15-L17

geerteltink · 2017-07-14T07:48:37Z

I was thinking about sort-packages as well. I'm not sure how that works out with existing dependencies. It's added to the expressive skeleton as well. It does make it easier to lookup dependencies when they are sorted.

https://getcomposer.org/doc/06-config.md#sort-packages

geerteltink · 2017-07-15T05:54:40Z

Currently version constrains are written in different ways:

"^5.6 || ^7.0"
"^6.2 || ^5.7",
"^1.0 || 1.0.x-dev".

According to the composer docs it doesn't matter how you write it?

When you write a version constraint, it may reference a specific tag (e.g., 1.1) or it may reference a valid range of tags (e.g., >=1.1 <2.0, or ~4.0). To resolve these constraints, Composer first asks the VCS to list all available tags, then creates an internal list of available versions based on these tags. In the above example, composer's internal list includes versions 1.0, 1.0.1, 1.0.2, the beta release of 1.1, the first and second release candidates of 1.1, the final release version 1.1, etc....

When Composer has a complete list of available versions from your VCS, it then finds the highest version that matches all version constraints in your project.

So what to do? "lowest || highest" vs "highest || lowest".

froschdesign · 2017-07-15T07:55:34Z

…it doesn't matter how you write it?

Right, because:

…finds the highest version…

I prefer a simple and intuitive reading: "lowest || highest"

weierophinney · 2017-07-15T12:41:34Z

I assumed that the || operator worked as it does in most programming languages, choosing the first to match. However, when I consider it from a practical point of view, it will use this to determine what set of packages are valid, so it can choose the latest based on the requirements of other dependencies.

So, the main thing is that we are consistent. I agree with @froschdesign that latest last makes sense, as the constraints are then ordered.

froschdesign · 2017-07-19T06:43:38Z

LGTM 👍

weierophinney

Since the template is for new packages, we should push the PHP and PHPUnit constraints higher.

All else looks good.

weierophinney · 2017-08-01T19:37:26Z

template/composer.json

+        "docs": "https://docs.zendframework.com/<package_name>/",
+        "issues": "https://github.com/zendframework/<package_name>/issues",
+        "source": "https://github.com/zendframework/<package_name>",
+        "rss": "https://github.com/zendframework/<package_name>/releases.atom",


I find it funny that we use an Atom feed for the RSS item. 😄 That said, it's the only appropriate location.

weierophinney · 2017-08-01T19:38:11Z

template/composer.json

+        "forum": "https://discourse.zendframework.com/c/questions/<components|expressive|apigility>"
+    },
+    "require": {
+        "php": "^5.6 || ^7.0"


For new packages, this will be simply ^7.1, in which case, we can change the PHPUnit constraint to simply ^6.2.

Add composer template

Close #15

weierophinney · 2017-11-07T22:02:41Z

Thanks, @webimpress!

geerteltink · 2017-11-08T04:03:32Z

Thanks, @webimpress!

???

michalbundyra · 2017-11-08T07:05:51Z

lol, thanks @xtreamwayz 👍 👍 👍

weierophinney · 2017-11-08T15:21:32Z

@xtreamwayz I typed the wrong issue identifier when I wrote that! (I use gh from the command line for a number of tasks)

THANK YOU, Geert!

Add composer template

c8b7710

This was referenced Jul 13, 2017

Add travis template #16

Merged

Update Travis CI config zendframework/zend-expressive-fastroute#37

Merged

froschdesign reviewed Jul 13, 2017

View reviewed changes

Add description for keywords

3e52d2c

michalbundyra reviewed Jul 13, 2017

View reviewed changes

froschdesign reviewed Jul 13, 2017

View reviewed changes

geerteltink added 5 commits July 13, 2017 13:58

Apply requested changes

06c9be1

- Add default keywords - Add possible forum categories - Update PHP Unit versions - Add empty line at end of file - Update description

Update constraints

fd0a29a

Move extra down

c069854

Add rss feed

3cccb74

Remove type

dbc5e12

> It is recommended to omit this field and have it just default to > `library`. @see https://getcomposer.org/doc/04-schema.md#type

froschdesign reviewed Jul 14, 2017

View reviewed changes

geerteltink added 2 commits July 14, 2017 09:52

Add sort-packages

b0a2fb4

https://getcomposer.org/doc/06-config.md#sort-packages

Change project-name with package_name

d4d12cc

Use "lowest || highest" constraints

3ece15b

froschdesign approved these changes Jul 19, 2017

View reviewed changes

froschdesign mentioned this pull request Jul 27, 2017

Update composer.json zendframework/ZendService_Google_Gcm#33

Closed

weierophinney suggested changes Aug 1, 2017

View reviewed changes

geerteltink added 2 commits August 2, 2017 21:55

New packages should target PHP ^7.1 and use PHPUnit ^6.2

7a57a2e

Use phpunit 6.3

dbfae78

froschdesign mentioned this pull request Aug 23, 2017

PHPUnit update zendframework/zend-soap#42

Closed

michalbundyra mentioned this pull request Sep 29, 2017

QA Tools config templates #21

Merged

weierophinney merged commit dbfae78 into zendframework:master Nov 7, 2017

weierophinney added a commit that referenced this pull request Nov 7, 2017

Merge pull request #15 from xtreamwayz/feature/composer-template

6d1160f

Add composer template

weierophinney added a commit that referenced this pull request Nov 7, 2017

Merge branch 'hotfix/15'

baf05c6

Close #15

geerteltink deleted the feature/composer-template branch November 8, 2017 04:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add composer template #15

Add composer template #15

geerteltink commented Jul 13, 2017

froschdesign commented Jul 13, 2017

froschdesign Jul 13, 2017 •

edited

Loading

michalbundyra Jul 13, 2017

geerteltink Jul 13, 2017

michalbundyra Jul 13, 2017

froschdesign Jul 13, 2017

michalbundyra Jul 13, 2017

michalbundyra Jul 13, 2017

michalbundyra Jul 13, 2017

geerteltink Jul 13, 2017

michalbundyra Jul 13, 2017

froschdesign Jul 13, 2017

froschdesign Jul 13, 2017

froschdesign Jul 14, 2017

michalbundyra commented Jul 14, 2017

geerteltink commented Jul 14, 2017

geerteltink commented Jul 15, 2017

froschdesign commented Jul 15, 2017 •

edited

Loading

weierophinney commented Jul 15, 2017

froschdesign commented Jul 19, 2017

weierophinney left a comment

weierophinney Aug 1, 2017

weierophinney Aug 1, 2017

weierophinney commented Nov 7, 2017

geerteltink commented Nov 8, 2017

michalbundyra commented Nov 8, 2017

weierophinney commented Nov 8, 2017

Add composer template #15

Add composer template #15

Conversation

geerteltink commented Jul 13, 2017

froschdesign commented Jul 13, 2017

froschdesign Jul 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michalbundyra commented Jul 14, 2017

geerteltink commented Jul 14, 2017

geerteltink commented Jul 15, 2017

froschdesign commented Jul 15, 2017 • edited Loading

weierophinney commented Jul 15, 2017

froschdesign commented Jul 19, 2017

weierophinney left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weierophinney commented Nov 7, 2017

geerteltink commented Nov 8, 2017

michalbundyra commented Nov 8, 2017

weierophinney commented Nov 8, 2017

froschdesign Jul 13, 2017 •

edited

Loading

froschdesign commented Jul 15, 2017 •

edited

Loading