pronovix/drupal-module-template

This package is abandoned and no longer maintained. No replacement package was suggested.

There is no license information available for the latest version (8.x-dev) of this package.

Module template for Drupal modules.

8.x-dev 2019-07-30 08:49 UTC

Requires

• php: >= 7.1

Requires (Dev)

• composer/composer: ~1.7.0
• symfony/yaml: ^3.4 | ^4.0

Unknown License

README

Start development of a new module

Building a new module with Composer

$ composer create-project -s dev pronovix/drupal-module-template path/to/my_module

or

$ docker run --rm -it -v $PWD:/app --user $(id -u):$(id -g) composer create-project -s dev pronovix/drupal-module-template my_module

See the composer documentation for details.

Contributing to this template

• Spin up the containers inside the .dev folder with docker-compose up -d.
• Open an interactive shell with docker-compose exec php bash and run any command that you need.

Test module creation from this template:

Run this inside the php container:

$ COMPOSER_MIRROR_PATH_REPOS=1 composer create-project --repository='{"type": "path", "url": "/mnt/files/drupal_module"}' -s dev pronovix/drupal-module-template /path/in/container/my_module

Alternatively, you can use the official Composer image for the same, just run this command in the root of the template:

$  docker run --rm -it -v $PWD:/app -v /tmp:/tmp --user $(id -u):$(id -g) -e COMPOSER_MIRROR_PATH_REPOS=1 composer:1.7 create-project --repository='{"type": "path", "url": "/app"}' -s dev pronovix/drupal-module-template /tmp/my_module

(This will create a module from the template in the host system's /tmp/my_module folder.)

Applying/updating template files on an existing module

1. Follow the steps from "Building a new module with Composer". If your module's machine name is foobar use that as a parameter, like composer create-project -s dev pronovix/drupal-module-template foobar.
2. Move the following folders and files from the created folder to your module's root:

• .dev
• docs

1. Move or merge the content of any remaining files and folders.

• Pay more attention when you are merging the composer.json files, especially to the require-dev section which defines the correct versions of the testing related dependencies.
• If you do not want to run tests on Travis CI then files that contains travis can be ignored.

Credits

Inspired by the OpenEuropa Drupal module template.