magento · coderimus · Oct 21, 2020 · Oct 19, 2020 · Oct 19, 2020 · Oct 19, 2020
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,128 +1,177 @@
-1.0.1
-============= 
-* Features:
-    * Create a CLI command action
-    * Create a CRON group action
-    * Create a CRON job action
-    * Create a Controller action
-    * Code Inspection: Module declaration inspections in the scope of `module.xml` and `registration.php`
-    * Code Inspection: GraphQL resolver in the scope of a schema file
-* Improvements:
-    * Fixed the positioning of all dialog popups
-    * Adjusted Magento root validation for consider `magento/framework` as a requirement
-    * Adjusted Magento version validation RegExp to support patch versions
-* Fixed bugs:
-    * The `create a plugin action` is accessible from the wrong context
-    * Null pointer exception on the new module group
-
-1.0.0
-============= 
-* Features:
-    * RequireJS mapping support (reference navigation, completion)
-    * MFTF support MVP (reference navigation, completion)
-    * Line markers for navigation from a plugin class to a target class
-    * Line markers for navigation from a GraphQl resolver to schema and vice versa
-    * Create a plugin for a class public method
-    * Create a New Magento 2 Module action
-    * Create a Block action
-    * Create a View Model action
-    * Create a new Magento 2 module as a separate project
-    * Create an observer for an event action
-    * Create a GraphQL resolver action
-    * Override class by reference action
-    * Plugin class methods generation
-    * Code Inspection: Duplicated plugin Usage in di.xml
-    * Code Inspection: Plugin declaration in the scope of a Plugin Class
-    * Code Inspection: Warning regarding Cacheable false attribute in default XML
-    * Code Inspection: GraphQL resolver in the scope of a PHP Class
-    * Code Inspection: Duplicated Observer Usage in events XML
-    * Moved plugin configuration from `Settings > Preferences > Languages & Frameworks > PHP > Magento` to
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0). 
+
+## 2.0.0
+
+### Added
+
+- Inject a view model to a block and a reference block from the context menu action
+- Override in Theme action
+- Generate Listing UI component (including all required files)
+- Generate Form UI component (including all required files)
+- Code Inspection: ACL resource title
+- Reference navigation and completion for `crontab.xml`
+- Reference navigation and completion for `menu.xml`
+
+### Changed
+
+- Adjusted module version to module.xml (considering the Magento version)
+- Adjusted support of variadic arguments to plugin declaration inspection
+
+### Fixed
+- Fixed missing first letter name in `composer.json`
+- Fixed the CLI command namespace
+- Fixed endless loop of notifications on launch
+- Fix `composer.json` generation with module dependency that doesn't have `composer.json`
+
+## ## 1.0.1
+
+### Added
+
+- Create a CLI command action
+- Create a CRON group action
+- Create a CRON job action
+- Create a Controller action
+- Code Inspection: Module declaration inspections in the scope of `module.xml` and `registration.php`
+- Code Inspection: GraphQL resolver in the scope of a schema file
+
+### Changed
+
+- Fixed the positioning of all dialog popups
+- Adjusted Magento root validation for consider `magento/framework` as a requirement
+- Adjusted Magento version validation RegExp to support patch versions
+
+### Fixed
+
+- The `create a plugin action` is accessible from the wrong context
+- Null pointer exception on the new module group
+
+## 1.0.0
+
+### Added
+
+- RequireJS mapping support (reference navigation, completion)
+- MFTF support MVP (reference navigation, completion)
+- Line markers for navigation from a plugin class to a target class
+- Line markers for navigation from a GraphQl resolver to schema and vice versa
+- Create a plugin for a class public method
+- Create a New Magento 2 Module action
+- Create a Block action
+- Create a View Model action
+- Create a new Magento 2 module as a separate project
+- Create an observer for an event action
+- Create a GraphQL resolver action
+- Override class by reference action
+- Plugin class methods generation
+- Code Inspection: Duplicated plugin Usage in di.xml
+- Code Inspection: Plugin declaration in the scope of a Plugin Class
+- Code Inspection: Warning regarding Cacheable false attribute in default XML
+- Code Inspection: GraphQL resolver in the scope of a PHP Class
+- Code Inspection: Duplicated Observer Usage in events XML
+- Moved plugin configuration from `Settings > Preferences > Languages & Frameworks > PHP > Magento` to
         `Settings > Preferences > Languages & Frameworks > PHP > Frameworks > Magento`
-    * Fixed support of 2020.* versions of IDE's
-
-0.3.0
-============= 
-* Features:
-    * Extended navigation from PHP class to its XML declaration to support any configs
-    * Documented local environment set up for plugin development
-* Fixed bugs:
-    * Fixed NullPointerException
-
-0.2.3
-=============
-* Features:
-    * Added JavaScript reference contributor
-    * Support references for each part of FQN of PHP class, methods, constants
-    * Support reference from XML/JavaScript for module name
-    * Support reference from XML/JavaScript for module element path (e.g. Magento_Catalog::product/list/addto/compare.phtml)
-    * Added project detector
-    * Move configuration section to "Languages & Frameworks > Php > Magento"
-    * Remove deprecated elements
+- Fixed support of 202## 0.* versions of IDE's
+
+## 0.3.0
+
+### Added
+
+- Extended navigation from PHP class to its XML declaration to support any configs
+- Documented local environment set up for plugin development
+
+### Fixed
+
+- Fixed NullPointerException
+
+## 0.2.3
+
+### Added
+
+- Added JavaScript reference contributor
+- Support references for each part of FQN of PHP class, methods, constants
+- Support reference from XML/JavaScript for module name
+- Support reference from XML/JavaScript for module element path (e.g. Magento_Catalog::product/list/addto/compare.phtml)
+- Added project detector
+- Move configuration section to "Languages & Frameworks > Php > Magento"
+- Remove deprecated elements
 
-0.2.2
-============= 
-* Features:
-    * Added Module name to configuration tooltip
-* Fixed bugs:
-    * Fixed "Project disposed" exception
+## 0.2.2
+
+### Added
+
+- Added Module name to configuration tooltip
+
+### Fixed
+
+- Fixed "Project disposed" exception
 
-0.2.1
-=============    
-* Features:
-    * added module name for "Goto configuration" labels
+## 0.2.1
+
+### Added
+
+- added module name for "Goto configuration" labels
 
-0.2.0
-=============
-* Features:
-    * WebApi routes
-    * nicer "Goto configuration" labels
-    * plugin settings (manual reindex, URN generation, plugin on/off)
+## 0.2.0
+
+### Added
+
+- WebApi routes
+- nicer "Goto configuration" labels
+- plugin settings (manual reindex, URN generation, plugin on/off)
+
+## 0.1
 
-0.1
-=============  
-* Features:
-    * Context type completion for:
-        * Observers completion only for ObserverInterface impl in events.xml
-        * Blocks completion only for BlockInterface name in layouts.xml
-        * Preference configuration in di.xml
-        * Type hinting for object arguments in di.xml
-    * @api usage inspection in Module context
-    * ObjectManager usage inspection in Module context
-    * virtualType arguments resolution
-    * webapi.xml interface/method completion/references
-    * Support for old people using PhpStorm 8 or JDK1.7
+### Added
+
+- Context type completion for:
+    - Observers completion only for ObserverInterface impl in events.xml
+    - Blocks completion only for BlockInterface name in layouts.xml
+    - Preference configuration in di.xml
+    - Type hinting for object arguments in di.xml
+- @api usage inspection in Module context
+- ObjectManager usage inspection in Module context
+- virtualType arguments resolution
+- webapi.xml interface/method completion/references
+- Support for old people using PhpStorm 8 or JDK## 1.7
 
-0.0.9
-=============    
-* Features:
-    * Added Reference and completion support for layouts
-        * block: class, before, after
-        * referenceBlock: name
-        * move: element, destination, before, after
-        * remove: name
-        * update: handle
-        * referenceContainer: name
-    * Line marker reference for php class to Layout configuration
-
-0.0.8
-=============
-* Features:
-    * Added Line marker reference for php class/interface to DI configuration
-    * Added Line marker reference to plugins
-
-0.0.7
-=============
-* Features:
-    * Added reference to configuration and observers (classes or virtualType)
-    * Added reference to observers from configuration
-    * Added reference to event dispatch from configuration
+## 0.0.9
+
+### Added
+
+- Added Reference and completion support for layouts
+    - block: class, before, after
+    - referenceBlock: name
+    - move: element, destination, before, after
+    - remove: name
+    - update: handle
+    - referenceContainer: name
+- Line marker reference for php class to Layout configuration
+
+## 0.0.8
+
+### Added
+- Added Line marker reference for php class/interface to DI configuration
+- Added Line marker reference to plugins
+
+## 0.0.7
+
+### Added
+
+- Added reference to configuration and observers (classes or virtualType)
+- Added reference to observers from configuration
+- Added reference to event dispatch from configuration
 
-0.0.6
-=============
-* Features:
-    * Added reference and completion support for virtual types/classes/arguments in DI configuration
+## 0.0.6
+
+### Added
+
+- Added reference and completion support for virtual types/classes/arguments in DI configuration
 
-0.0.5
-=============
-* Features:
-    * Added reference support for classes/interfaces in DI configuration
+## 0.0.5
+
+### Added
+
+- Added reference support for classes/interfaces in DI configuration
diff --git a/build.gradle b/build.gradle
@@ -7,6 +7,7 @@ plugins {
     id 'org.jetbrains.intellij' version '0.4.22'
     id 'checkstyle'
     id 'pmd'
+    id 'org.jetbrains.changelog' version '0.6.2'
 }
 
 repositories {
@@ -19,6 +20,7 @@ version '2.0.0'
 apply plugin: 'org.jetbrains.intellij'
 apply plugin: 'java'
 apply plugin: 'groovy'
+apply plugin: 'org.jetbrains.changelog'
 
 def phpPluginVersion = System.getProperty("phpPluginVersion", "201.7223.91")
 def ideaVersion = System.getProperty("ideaVersion", "2020.1.1")
@@ -46,6 +48,10 @@ intellij {
     sameSinceUntilBuild false
     downloadSources !Boolean.valueOf(System.getenv('CI'))
     sandboxDirectory "${project.rootDir}/.idea-sandbox"
+
+    patchPluginXml {
+        changeNotes({ changelog.getLatest().toHTML() })
+    }
 }
 
 sourceSets {
@@ -74,3 +80,14 @@ static def getDate() {
 }
 
 apply from: "${project.rootDir}/gradle-tasks/staticChecks.gradle"
+
+changelog {
+    version = "${project.version}"
+    path = "${project.projectDir}/CHANGELOG.md"
+    header = { "[${project.version}] - ${getDate()}" }
+    headerParserRegex = ~/(\d+\.)?(\d+\.)?(\*|\d+)/
+    itemPrefix = "-"
+    keepUnreleasedSection = true
+    unreleasedTerm = "[Unreleased]"
+    groups = ["Added", "Changed", "Deprecated", "Removed", "Fixed", "Security"]
+}