1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
# VS Code support for Java using the javac API
Provides Java support using the javac API.
Requires that you have Java 8 installed on your system.
## Installation
[Install from the VS Code marketplace](https://marketplace.visualstudio.com/items?itemName=georgewfraser.vscode-javac)
## [Issues](https://github.com/georgewfraser/vscode-javac/issues)
## Features
### Autocomplete
<img src="http://g.recordit.co/bCbYuegVRV.gif">
### Go-to-definition
<img src="http://g.recordit.co/Fg7cpH1rnz.gif">
### Find symbol
<img src="http://g.recordit.co/6g1bESw3Pp.gif">
### Lint
<img src="http://g.recordit.co/DGTYfpFdSD.gif">
### Type information on hover
<img src="http://g.recordit.co/R3T0nLUpZJ.gif">
### Find references
<img src="http://g.recordit.co/71PXpvFfs8.gif">
## Usage
The presence of a `javaconfig.json` file indicates that
its parent directory is the root of a Java module.
`javaconfig.json` looks like:
{
"sourcePath": ["relative/path/to/source/root", ...],
"classPathFile": "file-with-classpath-as-contents.txt",
"outputDirectory": "relative/path/to/output/root"
}
The classpath is contained in a separate file,
in the format `entry.jar:another-entry.jar`.
This file is usually generated by a build tool like maven.
### Examples
### Maven
You can configure maven to output the current classpath to a file,
classpath.txt, where Visual Studio Code will find it.
#### javaconfig.json
Set the source path, and get the class path from a file:
{
"sourcePath": ["src/main/java"],
"classPathFile": "classpath.txt",
"outputDirectory": "target"
}
#### pom.xml
Configure maven to output `classpath.txt`
<project ...>
...
<build>
...
<plugins>
...
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<version>2.9</version>
<executions>
<execution>
<id>build-classpath</id>
<phase>generate-sources</phase>
<goals>
<goal>build-classpath</goal>
</goals>
</execution>
</executions>
<configuration>
<outputFile>classpath.txt</outputFile>
</configuration>
</plugin>
</plugins>
</build>
</project>
#### .gitignore
Ignore `classpath.txt`, since it will be different on every host
classpath.txt
...
### Gradle
Add this to your `build.gradle`:
```gradle
task vscodeClasspathFile {
description 'Generates classpath file for the Visual Studio Code java plugin'
ext.destFile = file("$buildDir/classpath.txt")
outputs.file destFile
doLast {
def classpathString = configurations.compile.collect{ it.absolutePath }.join(':')
assert destFile.parentFile.mkdir()
destFile.text = classpathString
}
}
task vscodeJavaconfigFile(dependsOn: vscodeClasspathFile) {
description 'Generates javaconfig.json file for the Visual Studio Code java plugin'
def relativePath = { File f ->
f.absolutePath - "${project.rootDir.absolutePath}/"
}
ext.destFile = file("javaconfig.json")
ext.config = [
sourcePath: sourceSets.collect{ it.java.srcDirs }.flatten().collect{ relativePath(it) },
classPathFile: relativePath(tasks.getByPath(':vscodeClasspathFile').outputs.files.singleFile),
outputDirectory: relativePath(new File(buildDir, 'vscode-classes'))
]
doLast {
def jsonContent = groovy.json.JsonOutput.toJson(ext.config)
destFile.text = groovy.json.JsonOutput.prettyPrint(jsonContent)
}
}
task vscode(dependsOn: vscodeJavaconfigFile) {
description 'Generates config files for the Visual Studio Code java plugin'
group 'vscode'
}
```
Then run `gradlew vscode`. This will generate
* `javaconfig.json`
* `build/classpath.txt`
## Directory structure
### Java service process
A java process that does the hard work of parsing and analyzing .java source files.
pom.xml (maven project file)
src/ (java sources)
repo/ (tools.jar packaged in a local maven repo)
target/ (compiled java .class files, .jar archives)
target/fat-jar.jar (single jar that needs to be distributed with extension)
### Typescript Visual Studio Code extension
"Glue code" that launches the external java process
and connects to it using [vscode-languageclient](https://www.npmjs.com/package/vscode-languageclient).
package.json (node package file)
tsconfig.json (typescript compilation configuration file)
tsd.json (project file for tsd, a type definitions manager)
lib/ (typescript sources)
out/ (compiled javascript)
## Design
This extension consists of an external java process,
which communicates with vscode using the [language server protocol](https://github.com/Microsoft/vscode-languageserver-protocol).
### Java service process
The java service process uses the implementation of the Java compiler in tools.jar,
which is a part of the JDK.
When VS Code needs to lint a file, perform autocomplete,
or some other task that requires Java code insight,
the java service process invokes the Java compiler programatically,
then intercepts the data structures the Java compiler uses to represent source trees and types.
### Incremental updates
The Java compiler isn't designed for incremental parsing and analysis.
However, it is *extremely* fast, so recompiling a single file gives good performance,
as long as we don't also recompile all of its dependencies.
We accomplish this by maintaining a single copy of the Java compiler in memory at all times.
When we want to recompile a file,
we clear that *one* file from the internal caches of the Java compiler,
and then rerun the compiler.
### Multiple javaconfig.json
If you have multiple javaconfig.json files in different subdirectories of your project,
the parent directory of each javaconfig.json will be treated as a separate java root.
## Logs
The java service process will output a log file with a name like 'javac-services.0.log'
in your project directory.
## Contributing
If you have npm and maven installed,
you should be able to install locally using
npm install -g vsce
npm install
./scripts/install.sh
|
