Feature - conform templates script

[michalbundyra]

It should be called from main repository package:

$ zf-maintainer rebase-doc-templates <path-to-package>

It takes package name from composer "name" key.

• renames doc -> docs if exists (otherwise creates docs directory)
• puts all support files and templates into docs directory
• removes CONTRIBUTING.md and CONDUCT.md from main directory
• updates LICENSE.md
• updates mkdocs.yml if exists (doc -> docs and copyright year)
• updates coveralls.yml
• updates .gitattributes
• updates .gitignore
• adds .travis.yml only file in repo does not exist
• updated composer.json
  • checks repository description and update it to match with description in https://docs.zendframework.com/zf-mkdoc-theme/scripts/zf-component-list.json
  • fixes sections order
  • removes default type if it's library
  • updates scripts
  • updates license
  • updates support
  • updates config
  • removes "minimum-stability" and "prefer-stable"
  • checks keywords
  • checks branch-alias (dev-master and dev-develop)
• updates badges in README.md and prints error when badge is not found
• replaces links to the documentation (docs.zendframework.com) in README.md and docs/books md files

I've used this script to prepare PR in all zend-expressive-* packages and tested also in couple others. Definitely we can improve it more, but as starter I think it's good enough ;-)

[weierophinney]

And... just for the record... I have created weierophinney/zf-component-template, which can be used when creating a new component. It is in-sync currently with this repository, and includes as self-removing setup.php script that does these same operations. It also provides a ConfigProvider class, and a test for that class, as a baseline for the new component.

This stuff could be moved into this repository as well. The main difference is that creation wouldn't be clone + setup, but instead just invoking the script.

[weierophinney]

According to wikipedia \n\r is possible somewhere:

Yes, RiscOS and Acorn BBS... which PHP doesn't support anyways. I mean, I suppose you could edit on these platforms and deploy to another platform, but it's unlikely.

I've been working with line-endings in PHP OSS projects for over a dozen years, and have literally never had anybody ask to support LF+CR. :smile:

[weierophinney]

With #28 merged, do you want me to merge this, or wait for you to refactor it to symfony/console?

[michalbundyra]

@weierophinney

With #28 merged, do you want me to merge this, or wait for you to refactor it to symfony/console?

I'm refactoring it now to use symfony/console. Will be ready shortly.

[michalbundyra]

@weierophinney It's now updated

[weierophinney]

Thanks, @webimpress!