#Issue-142: Action/Code Generation. New CLI command Generation #240

coderimus · 2020-04-29T20:33:45Z

Description (*)
This PR provides a new action: Magento 2 CLI Command

This new action has the next form

All fields are required. The Console is a predefined value

For example, the next data set

The result of its generation will be

CLI PHP CLass

di.xml settings

If a developer decided to add one more CLI command in the scope of the current module the result will be next:

Fixed Issues (if relevant)
#142

Questions or comments

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with integration/functional tests (if applicable)
All automated tests passed successfully (all builds are green)

… settings

eduard13

Hi @coderimus, really great job so far 👍. I've left couple of notices, please check them as well.
Thank you.

eduard13 · 2020-04-30T12:48:04Z

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewCLICommandDialog.form

+            </constraints>
+            <properties>
+              <labelFor value="61353"/>
+              <text resource-bundle="magento2/common" key="common.cli.class.name"/>


Let's use common.className instead of adding a new one. Please adjust everywhere where it is used.

@eduard13 thank you for the review! Got your point and totally agree with it 👍 Will apply changes with the next push.

eduard13 · 2020-04-30T12:49:55Z

resources/magento2/common.properties

@@ -27,3 +27,10 @@ common.notAvailable=N/A
 common.classInheritance=Inherit Class
 common.license.proprietary=Proprietary
 common.description=Description
+common.cli.class.name=Class Name
+common.cli.parent.directory=Parent Directory


Let's use it like this common.parentDirectory as it may reused in some other components.

eduard13 · 2020-04-30T12:50:57Z

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewCLICommandDialog.form

+            </constraints>
+            <properties>
+              <labelFor value="d786e"/>
+              <text resource-bundle="magento2/common" key="common.cli.cli.description"/>


We already have common.description.

Suggested change

<text resource-bundle="magento2/common" key="common.cli.cli.description"/>

<text resource-bundle="magento2/common" key="common.description"/>

eduard13 · 2020-04-30T12:51:33Z

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewCLICommandDialog.form

+            </constraints>
+            <properties>
+              <labelFor value="a06d9"/>
+              <text resource-bundle="magento2/common" key="common.cli.cli.name"/>


Same here

Suggested change

<text resource-bundle="magento2/common" key="common.cli.cli.name"/>

<text resource-bundle="magento2/common" key="common.name"/>

eduard13 · 2020-04-30T12:51:57Z

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewCLICommandDialog.form

+            </constraints>
+            <properties>
+              <labelFor value="82342"/>
+              <text resource-bundle="magento2/common" key="common.cli.parent.directory"/>


Suggested change

<text resource-bundle="magento2/common" key="common.cli.parent.directory"/>

<text resource-bundle="magento2/common" key="common.parentDirectory"/>

eduard13 · 2020-04-30T12:53:35Z

src/com/magento/idea/magento2plugin/actions/generation/generator/CLICommandClassGenerator.java

+            "validator.file.cantBeCreated",
+            commonBundle.message("common.cli.class.title")


Let's have some indents here

Suggested change

"validator.file.cantBeCreated",

commonBundle.message("common.cli.class.title")

"validator.file.cantBeCreated",

commonBundle.message("common.cli.class.title")

eduard13 · 2020-04-30T12:55:25Z

src/com/magento/idea/magento2plugin/actions/generation/dialog/AbstractDialog.java

+    protected CommonBundle bundle;
+
+    public AbstractDialog() {
+        this.bundle = new CommonBundle();


Good point 👍

…ento2-phpstorm-plugin into 142/cli-command-generation

…mmand-generation

VitaliyBoyko · 2020-05-04T13:44:23Z

...m/magento/idea/magento2plugin/actions/generation/generator/CLICommandDiXmlGeneratorTest.java

@@ -13,22 +13,27 @@
 import com.magento.idea.magento2plugin.magento.packages.Package;
 import com.magento.idea.magento2plugin.util.CamelCaseToSnakeCase;

+@SuppressWarnings({
+        "PMD.FieldNamingConventions",
+        "PMD.LongVariable",


Let's suppress the LongVariable on a global level. I believe variable names should be descriptive and self-explanatory.

…s to exclude pattern

coderimus · 2020-05-04T15:08:03Z

@eduard13 requested change added and the work completed in the scope of the PR issue. Please, review this PR 😃

eduard13

Hi @coderimus it works really great ✅. Could you please check on minor note and share your thought regarding that one?
Also looks like something is wrong with the dialog elements, probably with JPanels. Check the following screenshot (but it's also visible in PR description)

Let's make it to looks like this:

eduard13 · 2020-05-04T16:42:44Z

resources/magento2/common.properties

@@ -27,3 +27,10 @@ common.notAvailable=N/A
 common.classInheritance=Inherit Class
 common.license.proprietary=Proprietary
 common.description=Description
+common.parentDirectory=Parent Directory
+common.cliCommandName=CLI Command Name


What do you think if we'll keep it just Command Name?

Agree, will change :)

coderimus · 2020-05-04T19:42:18Z

@eduard13 thank you for your review and suggestions 👍 I implemented them. Please, review.

eduard13

Awesome.
Good job 💯

coderimus added 3 commits April 29, 2020 23:20

Implement base file generation logic

aec07d4

Remove comments

a1dfac9

Change validation for the command description

6a1ab92

coderimus added action code generation labels Apr 29, 2020

magento-engcom-team added Community Insider: Magecom community-insider-contribution labels Apr 29, 2020

coderimus changed the title ~~142/cli command generation~~ [WIP] 142: Action/Code Generation. New CLI command Generation Apr 29, 2020

coderimus added 2 commits April 30, 2020 10:40

Use common bundle for the NewCLICommandValidator

ef47c50

Use textarea for command description and add xml files for the di.xml…

570ff8b

… settings

eduard13 requested changes Apr 30, 2020

View reviewed changes

m2-community-project bot assigned eduard13 Apr 30, 2020

m2-community-project bot added the Progress: changes requested label Apr 30, 2020

m2-community-project bot assigned coderimus Apr 30, 2020

m2-community-project bot added Progress: review and removed Progress: changes requested labels Apr 30, 2020

Vitaliy and others added 7 commits April 30, 2020 11:12

Merge branch '1.0.1-develop' into 142/cli-command-generation

842a2d4

Provide required xml generation for CLI initialization

40a6d9f

Merge branch '142/cli-command-generation' of github.com:coderimus/mag…

a28be65

…ento2-phpstorm-plugin into 142/cli-command-generation

Fix some style and logic

5aa70e6

Validator logic changes and style adjustments

07bcd41

Refactoring and add test for the CLI class generation

ac10090

Merge remote-tracking branch 'upstream/1.0.1-develop' into 142/cli-co…

ece7061

…mmand-generation

VitaliyBoyko reviewed May 4, 2020

View reviewed changes

m2-community-project bot assigned VitaliyBoyko May 4, 2020

Add di.xml tests, fix static tests, add resources and TestData folder…

1183194

…s to exclude pattern

coderimus changed the title ~~[WIP] 142: Action/Code Generation. New CLI command Generation~~ #Issue-142: Action/Code Generation. New CLI command Generation May 4, 2020

VitaliyBoyko removed their assignment May 4, 2020

VitaliyBoyko requested a review from eduard13 May 4, 2020 14:58

eduard13 requested changes May 4, 2020

View reviewed changes

Adjustments after review

91af5ee

coderimus requested a review from eduard13 May 4, 2020 19:42

eduard13 added in testing Advanced Award: test coverage Progress: approved QA passed Complex and removed in testing labels May 5, 2020

eduard13 approved these changes May 5, 2020

View reviewed changes

m2-community-project bot removed the Progress: review label May 5, 2020

VitaliyBoyko merged commit 06c1505 into magento:1.0.1-develop May 5, 2020

m2-community-project bot removed the Progress: approved label May 5, 2020

	<text resource-bundle="magento2/common" key="common.cli.cli.description"/>
	<text resource-bundle="magento2/common" key="common.description"/>

		"validator.file.cantBeCreated",
		commonBundle.message("common.cli.class.title")

#Issue-142: Action/Code Generation. New CLI command Generation #240

#Issue-142: Action/Code Generation. New CLI command Generation #240

Uh oh!

Conversation

coderimus commented Apr 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eduard13 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coderimus commented May 4, 2020

Uh oh!

eduard13 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coderimus commented May 4, 2020

Uh oh!

eduard13 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderimus commented Apr 29, 2020 •

edited

Loading

eduard13 left a comment •

edited

Loading