Support exporting jar with custom task by CsCherrYY · Pull Request #350 · microsoft/vscode-java-dependency

Shi Chen (CsCherrYY) · 2020-10-15T09:09:12Z

This PR enables the Java Project Manager to support exporting jar with custom task. In this PR, you can change the value of the fields to customize what to export. The available template of tasks can be found at Terminal->Configure Tasks.... Here is an example of tasks.json including an export jar task:

{
	"version": "2.0.0",
	"tasks": [
		{
			"type": "java",
			"label": "java: exportjar:demo",
			"mainClass": "demo.App",
			"targetPath": "${workspaceFolder}/${workspaceFolderBasename}.jar",
			"elements": [
				"${compileOutput}",
				"${testCompileOutput}",
				"${dependencies}",
				"${testDependencies}",
				"!${compileOutput}/demo/innerPkg",
				"C:/work/demo/test.iml"
			],
			"problemMatcher": []
		}
	]
}

The following attributes are mandatory for every task configuration:

type - the type of export jar task, should always be java.
label - the name of export jar task. When you are going to run a task from Terminal->Run Task..., the labels of all available tasks will appear in the list.

Here are some optional attributes available to all launch configurations:

mainClass - the mainClass in MANIFEST.MF. If this attribute is not specified, the wizard to select the mainClass will appear during the export process.
targetPath - the target path of jar. VS Code variables is available in this attribute. If this attribute is not specified, the export process will apply the setting java.project.exportJar.targetPath.
elements - The array of elements to export. If this attribute is not specified, the wizard to select the elements will appear during the export process. This attribute is using glob patterns so you can also use ! to specify which not to include. Both absolute path and relative path to the project folder are supported here.

These reserved words are available in the elements:

${compileOutput} - the folders containing output class files in the runtime scope.
${testCompileOutput} - the folders containing output class files in the test scope.
${dependencies} - the artifact dependencies in the runtime scope.
${testDependencies} - the artifact dependencies in the test scope.
Note: The reserved words can be used to stand for a specific project. For example, if your workspace includes more than one workspace folder, one of them is demo. The ${compileOutput} will stand for the folders containing output class files in the runtime scope of all the workspace folders while the ${compileOutput:demo} stands for those of folder demo only.

You can run the custom task by clicking Terminal->Run Task and select the java type. Then the wizard will show all the available export jar tasks.

Sheng Chen (jdneo) · 2020-11-03T07:40:34Z

"label": "java: exportjar:demo-noMain" // The label of this task to show in the wizard from Terminal->Run Task...

Do we have this field?

Shi Chen (CsCherrYY) · 2020-11-03T07:52:44Z

"label": "java: exportjar:demo-noMain" // The label of this task to show in the wizard from Terminal->Run Task...

Do we have this field?

It's a VS Code built-in field. Its value is in this format: task.type: task.name

Sheng Chen (jdneo)

very close, just a few more comments

Sheng Chen (jdneo) · 2020-11-04T08:56:42Z

+  "configuration.java.project.exportJar.targetPath": "The default output path of export jar",
+  "taskDefinitions.java.project.exportJar.elements": "The content list of export jar.",
+  "taskDefinitions.java.project.exportJar.mainMethod": "The main method in the manifest of exported jar.",
+  "taskDefinitions.java.project.exportJar.targetPath": "The output path of the exported jar. This will override configuration.java.project.exportJar.targetPath."


I think we can use markdown description here and link to configuration.java.project.exportJar.targetPath. Similar as:

It seems that VS Code does not support markdown description in the taskDefinitions currently. So I couldn't find a way to link to the settings in the tasks.json file.

Sheng Chen (jdneo) · 2020-11-04T09:18:10Z

Some more feedbacks:

Can we remove problemMatcher when generating the task?
Default mainMethod should be filled if there is only one main entry
CompileOutput -> compileOutput and same to other reserved words

Shi Chen (CsCherrYY) · 2020-11-04T09:30:13Z

Some more feedbacks:

Can we remove problemMatcher when generating the task?

Default mainMethod should be filled if there is only one main entry

CompileOutput -> compileOutput and same to other reserved words

Thanks a lot! Will apply them.

Shi Chen (CsCherrYY) · 2020-11-05T09:52:45Z

Some more feedbacks:

Can we remove problemMatcher when generating the task?

Default mainMethod should be filled if there is only one main entry

CompileOutput -> compileOutput and same to other reserved words

It seems that problemMatcher cannot be removed programmly. The default echo task comes from literal template. Other tasks generated will include a problemMatcher property, whether it is undefined or used.

Sheng Chen (jdneo) · 2020-11-06T04:58:37Z

Shi Chen (@CsCherrYY) Please resolve the conflict

Jinbo Wang (testforstephen) · 2020-11-06T07:02:10Z

+      {
+        "type": "java",
+        "properties": {
+          "elements": {


A reference about how to support intellisense for constant literals when configuring elements.

https://github.com/microsoft/vscode-java-debug/blob/master/package.json#L346-L373

Jinbo Wang (@testforstephen) beautiful!

1. Rearranged the order of the task properties 2. Rename: mainMethod -> mainClass in many places to avoid any misunderstanding, including renaming ResolveMainClassExecutor to ResolveMainMethodExecutor 3. Support intellisense in tasks.json 4. Fix a bug on invisible project

Shi Chen (CsCherrYY) · 2020-11-06T09:46:24Z

+  "taskDefinitions.java.project.exportJar.elements": "The content list of the exported jar.",
+  "taskDefinitions.java.project.exportJar.mainClass": "The main class in the manifest of the exported jar.",
+  "taskDefinitions.java.project.exportJar.targetPath": "The output path of the exported jar. This will override configuration.java.project.exportJar.targetPath.",
+  "taskDefinitions.java.project.exportJar.compileOutput": "All of the output folders in the runtime scope.",


Sheng Chen (@jdneo) What do you think of the wording here, including output folders and dependencies ? Are them the proper ones? Or could you please give some suggestions?

Signed-off-by: Shi Chen <chenshi@microsoft.com>

1. Rename "runtimeDependencies" to "dependencies". 2. Rename "Runtime" to "runtime" and "Test" to "test" in the export jar wizard. 3. When configure default task, only "compileOutput" and "dependencies" are provided by default. 4. Add a new try-catch in jdtls.ext so that some exceptions such as duplicate files during export can be collected and the export process will not abort by them.

Sheng Chen (jdneo)

Thanks Shi Chen (@CsCherrYY)

Shi Chen (CsCherrYY) requested a review from Sheng Chen (jdneo) October 15, 2020 09:09

Sheng Chen (jdneo) requested changes Oct 16, 2020

View reviewed changes

Shi Chen (CsCherrYY) added 5 commits October 20, 2020 16:20

Support custom task to export jar

d907db0

Update ExportJarTaskProvider.ts

90061e8

Address part of the comments (WIP)

b3376b4

Address the comments

234e3cf

Rename interface IClassPath

69f1266

Shi Chen (CsCherrYY) force-pushed the CustomTask branch from 78a3f66 to 69f1266 Compare October 20, 2020 08:26

Update GenerateJarExecutor.ts

bdd2bf5

Sheng Chen (jdneo) reviewed Oct 21, 2020

View reviewed changes

Comment thread src/exportJarSteps/GenerateJarExecutor.ts Resolved

Comment thread src/exportJarSteps/ExportJarTaskProvider.ts Resolved

Address the comments

abb7d7a

Shi Chen (CsCherrYY) requested a review from Sheng Chen (jdneo) October 22, 2020 08:55

Shi Chen (CsCherrYY) linked an issue Oct 22, 2020 that may be closed by this pull request

Some exporting jar suggestions #298

Closed

Sheng Chen (jdneo) requested changes Oct 27, 2020

View reviewed changes

Address part of the comments(WIP)

add912f

Sheng Chen (jdneo) reviewed Oct 28, 2020

View reviewed changes

Comment thread package.nls.json Resolved

Sheng Chen (jdneo) reviewed Oct 28, 2020

View reviewed changes

Comment thread src/views/nodeCache/Trie.ts Resolved

Address the comments

700dfe7

Shi Chen (CsCherrYY) requested a review from Sheng Chen (jdneo) October 29, 2020 01:55

Sheng Chen (jdneo) requested changes Oct 29, 2020

View reviewed changes

Comment thread package.nls.zh.json Resolved

Comment thread src/exportJarSteps/ExportJarTaskProvider.ts Resolved

Comment thread src/exportJarSteps/utility.ts Resolved

Comment thread src/exportJarSteps/ExportJarTaskProvider.ts Resolved

Address the comments

85a88a8

Shi Chen (CsCherrYY) requested a review from Sheng Chen (jdneo) November 2, 2020 06:55

Sheng Chen (jdneo) requested changes Nov 2, 2020

View reviewed changes

Sheng Chen (jdneo) requested changes Nov 3, 2020

View reviewed changes

Sheng Chen (jdneo) added this to the 0.15.0 milestone Nov 3, 2020

Sheng Chen (jdneo) added the enhancement New feature or request label Nov 3, 2020

Address the comments

4310c7a

Merge branch 'master' into CustomTask

1230000

Shi Chen (CsCherrYY) requested a review from Sheng Chen (jdneo) November 3, 2020 08:44

Sheng Chen (jdneo) requested changes Nov 4, 2020

View reviewed changes

Address the comments

e48e59a

Merge branch 'master' into CustomTask

f1764b1

Jinbo Wang (testforstephen) reviewed Nov 6, 2020

View reviewed changes

Apply changes

41961a6

1. Rearranged the order of the task properties 2. Rename: mainMethod -> mainClass in many places to avoid any misunderstanding, including renaming ResolveMainClassExecutor to ResolveMainMethodExecutor 3. Support intellisense in tasks.json 4. Fix a bug on invisible project

Shi Chen (CsCherrYY) commented Nov 6, 2020

View reviewed changes

Shi Chen (CsCherrYY) and others added 4 commits November 9, 2020 20:09

Improve the wording

d20d77a

Tune naming and add some comments

af14f5b

Signed-off-by: Shi Chen <chenshi@microsoft.com>

Shorten code length

2d6d1fa

Sheng Chen (jdneo) approved these changes Nov 13, 2020

View reviewed changes

Sheng Chen (jdneo) merged commit a1d66be into master Nov 13, 2020

Sheng Chen (jdneo) deleted the CustomTask branch November 13, 2020 07:17

Shi Chen (CsCherrYY) changed the title ~~Support custom task to export jar~~ Support exporting jar with custom task Nov 16, 2020

Sheng Chen (jdneo) mentioned this pull request Nov 16, 2020

Some exporting jar suggestions #298

Closed

Conversation

Shi Chen (CsCherrYY) commented Oct 15, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Sheng Chen (jdneo) commented Nov 3, 2020

Uh oh!

Shi Chen (CsCherrYY) commented Nov 3, 2020

Uh oh!

Sheng Chen (jdneo) left a comment

Choose a reason for hiding this comment

Uh oh!

Sheng Chen (jdneo) Nov 4, 2020

Choose a reason for hiding this comment

Uh oh!

Shi Chen (CsCherrYY) Nov 5, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Sheng Chen (jdneo) commented Nov 4, 2020

Uh oh!

Shi Chen (CsCherrYY) commented Nov 4, 2020

Uh oh!

Shi Chen (CsCherrYY) commented Nov 5, 2020

Uh oh!

Sheng Chen (jdneo) commented Nov 6, 2020

Uh oh!

Jinbo Wang (testforstephen) Nov 6, 2020

Choose a reason for hiding this comment

Shi Chen (CsCherrYY) commented Oct 15, 2020 •

edited

Loading