From 7aac3ef6aeb3cde1673189b14645668188dc3e54 Mon Sep 17 00:00:00 2001 From: Vasilii Burlacu Date: Tue, 31 Mar 2020 13:11:57 +0300 Subject: [PATCH 1/2] Added description for the Module's composer.json file and adjusted the template code style --- .../internal/Magento Module Composer.json.ft | 11 +++-- .../Magento Module Composer.json.html | 49 +++++++++++++++++++ 2 files changed, 57 insertions(+), 3 deletions(-) create mode 100644 resources/fileTemplates/internal/Magento Module Composer.json.html diff --git a/resources/fileTemplates/internal/Magento Module Composer.json.ft b/resources/fileTemplates/internal/Magento Module Composer.json.ft index 5bf88ab4a..b76262d8f 100644 --- a/resources/fileTemplates/internal/Magento Module Composer.json.ft +++ b/resources/fileTemplates/internal/Magento Module Composer.json.ft @@ -3,9 +3,14 @@ "version": "${MODULE_VERSION}", "description": "${MODULE_DESCRIPTION}", "type": "magento2-module", - #if (${DEPENDENCIES}) "require": { - ${DEPENDENCIES} }, #end -#if (${LICENSE}) ${LICENSE}, #end + #if (${DEPENDENCIES}) + "require": { + ${DEPENDENCIES} + }, + #end + #if (${LICENSE}) + ${LICENSE}, + #end "autoload": { "files": [ "registration.php" diff --git a/resources/fileTemplates/internal/Magento Module Composer.json.html b/resources/fileTemplates/internal/Magento Module Composer.json.html new file mode 100644 index 000000000..c230dfc6e --- /dev/null +++ b/resources/fileTemplates/internal/Magento Module Composer.json.html @@ -0,0 +1,49 @@ + + +

+ The composer.json file determines the module's hard dependencies on other modules.
+ It is required in a module for extensions provider vendors and it's optional for custom implementations, but it is highly recommended to use. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Predefined variables and their default values:
${COMPOSER_PACKAGE_NAME} Module's composer name. Default value: ''.
${MODULE_VERSION} Module's version. Default value is '1.0.0'.
${MODULE_DESCRIPTION} Short description of what the module does. Default value: 'N/A'.
${DEPENDENCIES} A list of the module's dependencies.
${LICENSE} Module's licence.
${PACKAGE} Module's package name. Also know as Vendor name. Default value: ''.
${MODULE_NAME} Module's name. Default value: ''.
+ + From f84142440ccd17868056d645244ede408f977588 Mon Sep 17 00:00:00 2001 From: Vasilii Burlacu Date: Tue, 31 Mar 2020 13:45:23 +0300 Subject: [PATCH 2/2] Adjusted the composer.json template description --- .../internal/Magento Module Composer.json.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/resources/fileTemplates/internal/Magento Module Composer.json.html b/resources/fileTemplates/internal/Magento Module Composer.json.html index c230dfc6e..1739e6842 100644 --- a/resources/fileTemplates/internal/Magento Module Composer.json.html +++ b/resources/fileTemplates/internal/Magento Module Composer.json.html @@ -7,22 +7,22 @@ - + - + - + - + @@ -37,12 +37,12 @@ - + - +
Predefined variables and their default values:Template's predefined variables:
${COMPOSER_PACKAGE_NAME}  Module's composer name. Default value: ''.Module's composer name.
${MODULE_VERSION}  Module's version. Default value is '1.0.0'.Module's version.
${MODULE_DESCRIPTION}  Short description of what the module does. Default value: 'N/A'.Short description of what the module does.
${DEPENDENCIES}
${PACKAGE}  Module's package name. Also know as Vendor name. Default value: ''.Module's package name. Also know as Vendor name.
${MODULE_NAME}  Module's name. Default value: ''.Module's name.