From 92922df6a40a0188f8a38963d4f010592f8bb414 Mon Sep 17 00:00:00 2001 From: JojocraftTv Date: Mon, 18 May 2026 19:19:22 +0200 Subject: [PATCH] docs: fix grammar and spelling mistakes --- README.md | 100 +++++++++++++++++++++++++------------------------- USAGE_DATA.md | 16 ++++---- 2 files changed, 57 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index d5e2fec88..7ad28b126 100644 --- a/README.md +++ b/README.md @@ -83,15 +83,13 @@ If you need to compile your projects against a different JDK version, it's recom }, { "name": "JavaSE-25", - "path": "/path/to/jdk-25", - "default": true + "path": "/path/to/jdk-25" }, - , { "name": "JavaSE-26", "path": "/path/to/jdk-26", "default": true - }, + } ] ``` The default runtime will be used when you open standalone Java files. @@ -121,21 +119,21 @@ Supported VS Code settings ========================== The following settings are supported: -* `java.home` : **Deprecated, please use 'java.jdt.ls.java.home' instead.** Absolute path to JDK home folder used to launch the Java Language Server. Requires VS Code restart. +* `java.home`: **Deprecated, please use 'java.jdt.ls.java.home' instead.** Absolute path to JDK home folder used to launch the Java Language Server. Requires VS Code restart. * `java.jdt.ls.lombokSupport.enabled`: Whether to enable lombok support. Defaults to `true`. -* `java.jdt.ls.vmargs` : Extra VM arguments used to launch the Java Language Server. Requires VS Code restart. -* `java.errors.incompleteClasspath.severity` : Specifies the severity of the message when the classpath is incomplete for a Java file. Supported values are `ignore`, `info`, `warning`, `error`. -* `java.trace.server` : Traces the communication between VS Code and the Java language server. -* `java.configuration.updateBuildConfiguration` : Specifies how modifications on build files update the Java classpath/configuration. Supported values are `disabled` (nothing happens), `interactive` (asks about updating on every modification), `automatic` (updating is automatically triggered). -* `java.configuration.maven.userSettings` : Path to Maven's user settings.xml. +* `java.jdt.ls.vmargs`: Extra VM arguments used to launch the Java Language Server. Requires VS Code restart. +* `java.errors.incompleteClasspath.severity`: Specifies the severity of the message when the classpath is incomplete for a Java file. Supported values are `ignore`, `info`, `warning`, `error`. +* `java.trace.server`: Traces the communication between VS Code and the Java language server. +* `java.configuration.updateBuildConfiguration`: Specifies how modifications on build files update the Java classpath/configuration. Supported values are `disabled` (nothing happens), `interactive` (asks about updating on every modification), `automatic` (updating is automatically triggered). +* `java.configuration.maven.userSettings`: Path to Maven's user settings.xml. * `java.configuration.checkProjectSettingsExclusions`: **Deprecated, please use 'java.import.generatesMetadataFilesAtProjectRoot' to control whether to generate the project metadata files at the project root. And use 'files.exclude' to control whether to hide the project metadata files from the file explorer.** Controls whether to exclude extension-generated project settings files (`.project`, `.classpath`, `.factorypath`, `.settings/`) from the file explorer. Defaults to `false`. -* `java.referencesCodeLens.enabled` : Enable/disable the references code lenses. -* `java.implementationCodeLens` : Enable/disable the implementations code lens for the provided categories. -* `java.signatureHelp.enabled` : Enable/disable signature help support (triggered on `(`). -* `java.signatureHelp.description.enabled` : Enable/disable to show the description in signature help. Defaults to `false`. -* `java.contentProvider.preferred` : Preferred content provider (see 3rd party decompilers available in [vscode-java-decompiler](https://github.com/dgileadi/vscode-java-decompiler)). -* `java.import.exclusions` : Exclude folders from import via glob patterns. Use `!` to negate patterns to allow subfolders imports. You have to include a parent directory. The order is important. -* `java.import.gradle.enabled` : Enable/disable the Gradle importer. +* `java.referencesCodeLens.enabled`: Enable/disable the references code lenses. +* `java.implementationCodeLens`: Enable/disable the implementations code lens for the provided categories. +* `java.signatureHelp.enabled`: Enable/disable signature help support (triggered on `(`). +* `java.signatureHelp.description.enabled`: Enable/disable to show the description in signature help. Defaults to `false`. +* `java.contentProvider.preferred`: Preferred content provider (see 3rd party decompilers available in [vscode-java-decompiler](https://github.com/dgileadi/vscode-java-decompiler)). +* `java.import.exclusions`: Exclude folders from import via glob patterns. Use `!` to negate patterns to allow subfolders imports. You have to include a parent directory. The order is important. +* `java.import.gradle.enabled`: Enable/disable the Gradle importer. * Specify the Gradle distribution used by the Java extension: * `java.import.gradle.wrapper.enabled`: Use Gradle from the 'gradle-wrapper.properties' file. Defaults to `true`. * `java.import.gradle.version`: Use Gradle from the specific version if the Gradle wrapper is missing or disabled. @@ -144,23 +142,23 @@ The following settings are supported: * `java.import.gradle.jvmArguments`: JVM arguments to pass to Gradle. * `java.import.gradle.user.home`: setting for GRADLE_USER_HOME. * `java.import.gradle.offline.enabled`: Enable/disable the Gradle offline mode. Defaults to `false`. -* `java.import.maven.enabled` : Enable/disable the Maven importer. -* `java.autobuild.enabled` : Enable/disable the 'auto build'. +* `java.import.maven.enabled`: Enable/disable the Maven importer. +* `java.autobuild.enabled`: Enable/disable the 'auto build'. * `java.maxConcurrentBuilds`: Set max simultaneous project builds. -* `java.completion.enabled` : Enable/disable code completion support. -* `java.completion.guessMethodArguments` : Specify how the arguments will be filled during completion. Defaults to `auto`. - - `auto`: Use `off` only when using Visual Studio Code - Insiders, other platform will defaults to `insertBestGuessedArguments`. +* `java.completion.enabled`: Enable/disable code completion support. +* `java.completion.guessMethodArguments`: Specify how the arguments will be filled during completion. Defaults to `auto`. + - `auto`: Use `off` only when using Visual Studio Code - Insiders, other platform will default to `insertBestGuessedArguments`. - `off`: Method arguments will not be inserted during completion. - `insertParameterNames`: The parameter names will be inserted during completion. - `insertBestGuessedArguments`: The best guessed arguments will be inserted during completion according to the code context. * `java.completion.filteredTypes`: Defines the type filters. All types whose fully qualified name matches the selected filter strings will be ignored in content assist or quick fix proposals and when organizing imports. For example 'java.awt.*' will hide all types from the awt packages. -* `java.completion.favoriteStaticMembers` : Defines a list of static members or types with static members. -* `java.completion.importOrder` : Defines the sorting order of import statements. -* `java.format.enabled` : Enable/disable the default Java formatter. -* `java.format.settings.url` : Specifies the url or file path to the [Eclipse formatter xml settings](https://github.com/redhat-developer/vscode-java/wiki/Formatter-settings). -* `java.format.settings.profile` : Optional formatter profile name from the Eclipse formatter settings. -* `java.format.comments.enabled` : Includes the comments during code formatting. -* `java.format.onType.enabled` : Enable/disable on-type formatting (triggered on `;`, `}` or ``). +* `java.completion.favoriteStaticMembers`: Defines a list of static members or types with static members. +* `java.completion.importOrder`: Defines the sorting order of import statements. +* `java.format.enabled`: Enable/disable the default Java formatter. +* `java.format.settings.url`: Specifies the url or file path to the [Eclipse formatter xml settings](https://github.com/redhat-developer/vscode-java/wiki/Formatter-settings). +* `java.format.settings.profile`: Optional formatter profile name from the Eclipse formatter settings. +* `java.format.comments.enabled`: Includes the comments during code formatting. +* `java.format.onType.enabled`: Enable/disable on-type formatting (triggered on `;`, `}` or ``). * `java.foldingRange.enabled`: Enable/disable smart folding range support. If disabled, it will use the default indentation-based folding range provided by VS Code. * `java.maven.downloadSources`: Enable/disable download of Maven source artifacts as part of importing Maven projects. * `java.maven.updateSnapshots`: Force update of Snapshots/Releases. Defaults to `false`. @@ -179,19 +177,19 @@ The following settings are supported: - `terminal`: Show the build status via terminal. - `off`: Do not show any build status. > For backward compatibility, this setting also accepts boolean value, where `true` has the same meaning as `notification` and `false` has the same meaning as `off`. -* `java.project.outputPath`: A relative path to the workspace where stores the compiled output. `Only` effective in the `WORKSPACE` scope. The setting will `NOT` affect Maven or Gradle project. +* `java.project.outputPath`: A relative path to the workspace where the compiled output will be stored. `Only` effective in the `WORKSPACE` scope. The setting will `NOT` affect Maven or Gradle project. * `java.project.referencedLibraries`: Configure glob patterns for referencing local libraries to a Java project. * `java.completion.maxResults`: Maximum number of completion results (not including snippets). `0` (the default value) disables the limit, all results are returned. In case of performance problems, consider setting a sensible limit. * `java.configuration.runtimes`: Map Java Execution Environments to local JDKs. * `java.server.launchMode`: - `Standard`: Provides full features such as intellisense, refactoring, building, Maven/Gradle support etc. - - `LightWeight`: Starts a syntax server with lower start-up cost. Only provides syntax features such as outline, navigation, javadoc, syntax errors. The lightweight mode won't load thirdparty extensions, such as java test runner, java debugger, etc. - - `Hybrid`: Provides full features with better responsiveness. It starts a standard language server and a secondary syntax server. The syntax server provides syntax features until the standard server is ready. And the syntax server will be shutdown automatically after the standard server is fully ready. + - `LightWeight`: Starts a syntax server with lower start-up cost. Only provides syntax features such as outline, navigation, javadoc, syntax errors. The lightweight mode won't load third-party extensions, such as java test runner, java debugger, etc. + - `Hybrid`: Provides full features with better responsiveness. It starts a standard language server and a secondary syntax server. The syntax server provides syntax features until the standard server is ready. And the syntax server will be shut down automatically after the standard server is fully ready. Default launch mode is `Hybrid`. Legacy mode is `Standard` * `java.sources.organizeImports.starThreshold`: Specifies the number of imports added before a star-import declaration is used, default is 99. * `java.sources.organizeImports.staticStarThreshold`: Specifies the number of static imports added before a star-import declaration is used, default is 99. -* `java.updateImportsOnPaste.enabled` : Enable/disable auto organize imports when pasting code. Defaults to `true`. +* `java.updateImportsOnPaste.enabled`: Enable/disable auto organize imports when pasting code. Defaults to `true`. * `java.imports.gradle.wrapper.checksums`: Defines allowed/disallowed SHA-256 checksums of Gradle Wrappers. * `java.project.importOnFirstTimeStartup`: Specifies whether to import the Java projects, when opening the folder in Hybrid mode for the first time. Supported values are `disabled` (never imports), `interactive` (asks to import or not), `automatic` (always imports). Default to `automatic`. * `java.project.importHint`: Enable/disable the server-mode switch information, when Java projects import is skipped on startup. Defaults to `true`. @@ -199,29 +197,29 @@ The following settings are supported: * `java.project.resourceFilters`: Excludes files and folders from being refreshed by the Java Language Server, which can improve the overall performance. For example, ["node_modules","\.git"] will exclude all files and folders named 'node_modules' or '.git'. Pattern expressions must be compatible with `java.util.regex.Pattern`. Defaults to ["node_modules","\.git"]. * `java.templates.fileHeader`: Specifies the file header comment for new Java file. Supports configuring multi-line comments with an array of strings, and using ${variable} to reference the [predefined variables](https://github.com/redhat-developer/vscode-java/wiki/Predefined-Variables-for-Java-Template-Snippets). * `java.templates.typeComment`: Specifies the type comment for new Java type. Supports configuring multi-line comments with an array of strings, and using ${variable} to reference the [predefined variables](https://github.com/redhat-developer/vscode-java/wiki/Predefined-Variables-for-Java-Template-Snippets). -* `java.templates.newFile.enabled` : Enable/disable automatic generation of class body and package declaration when creating a new Java file. Set to `false` to create empty Java files. Defaults to `true`. -* `java.references.includeAccessors`: Include getter, setter and builder/constructor when finding references. Default to true. -* `java.configuration.maven.globalSettings` : Path to Maven's global settings.xml. -* `java.configuration.maven.lifecycleMappings` : Path to Maven's lifecycle mappings xml. -* `java.eclipse.downloadSources` : Enable/disable download of Maven source artifacts for Eclipse projects. -* `java.references.includeDecompiledSources` : Include the decompiled sources when finding references. Default to true. +* `java.templates.newFile.enabled`: Enable/disable automatic generation of class body and package declaration when creating a new Java file. Set to `false` to create empty Java files. Defaults to `true`. +* `java.references.includeAccessors`: Include getter, setter and builder/constructor when finding references. Defaults to true. +* `java.configuration.maven.globalSettings`: Path to Maven's global settings.xml. +* `java.configuration.maven.lifecycleMappings`: Path to Maven's lifecycle mappings xml. +* `java.eclipse.downloadSources`: Enable/disable download of Maven source artifacts for Eclipse projects. +* `java.references.includeDecompiledSources`: Include the decompiled sources when finding references. Defaults to true. * `java.project.sourcePaths`: Relative paths to the workspace where stores the source files. `Only` effective in the `WORKSPACE` scope. The setting will `NOT` affect Maven or Gradle project. * `java.typeHierarchy.lazyLoad`: Enable/disable lazy loading the content in type hierarchy. Lazy loading could save a lot of loading time but every type should be expanded manually to load its content. * `java.codeGeneration.insertionLocation`: Specifies the insertion location of the code generated by source actions. Defaults to `afterCursor`. - `afterCursor`: Insert the generated code after the member where the cursor is located. - `beforeCursor`: Insert the generated code before the member where the cursor is located. - `lastMember`: Insert the generated code as the last member of the target type. -* `java.codeGeneration.addFinalForNewDeclaration`: Whether to generate the 'final' modifer for code actions that create new declarations. Defaults to `none`. +* `java.codeGeneration.addFinalForNewDeclaration`: Whether to generate the 'final' modifier for code actions that create new declarations. Defaults to `none`. - `none`: Do not generate final modifier - `fields`: Generate 'final' modifier only for new field declarations - `variables`: Generate 'final' modifier only for new variable declarations - `all`: Generate 'final' modifier for all new declarations -* `java.settings.url` : Specifies the url or file path to the workspace Java settings. See [Setting Global Preferences](https://github.com/redhat-developer/vscode-java/wiki/Settings-Global-Preferences) -* `java.symbols.includeSourceMethodDeclarations` : Include method declarations from source files in symbol search. Defaults to `false`. -* `java.symbols.includeGeneratedCode` : Include generated code (e.g. Lombok getters, setters, constructors) in document outline/symbols. Defaults to `false`. -* `java.quickfix.showAt` : Show quickfixes at the problem or line level. -* `java.configuration.workspaceCacheLimit` : The number of days (if enabled) to keep unused workspace cache data. Beyond this limit, cached workspace data may be removed. -* `java.import.generatesMetadataFilesAtProjectRoot` : Specify whether the project metadata files(.project, .classpath, .factorypath, .settings/) will be generated at the project root. Defaults to `false`. +* `java.settings.url`: Specifies the url or file path to the workspace Java settings. See [Setting Global Preferences](https://github.com/redhat-developer/vscode-java/wiki/Settings-Global-Preferences) +* `java.symbols.includeSourceMethodDeclarations`: Include method declarations from source files in symbol search. Defaults to `false`. +* `java.symbols.includeGeneratedCode`: Include generated code (e.g. Lombok getters, setters, constructors) in document outline/symbols. Defaults to `false`. +* `java.quickfix.showAt`: Show quickfixes at the problem or line level. +* `java.configuration.workspaceCacheLimit`: The number of days (if enabled) to keep unused workspace cache data. Beyond this limit, cached workspace data may be removed. +* `java.import.generatesMetadataFilesAtProjectRoot`: Specify whether the project metadata files(.project, .classpath, .factorypath, .settings/) will be generated at the project root. Defaults to `false`. * `java.inlayHints.parameterNames.enabled`: Enable/disable inlay hints for parameter names. Supported values are: `none`(disable parameter name hints), `literals`(Enable parameter name hints only for literal arguments) and `all`(Enable parameter name hints for literal and non-literal arguments). Defaults to `literals`. * `java.inlayHints.parameterTypes.enabled`: Enable/disable inlay hints for (lambda) parameter types. Defaults to `false`. * `java.compile.nullAnalysis.nonnull`: Specify the Nonnull annotation types to be used for null analysis. If more than one annotation is specified, then the topmost annotation will be used first if it exists in your project dependencies. This setting will be ignored if `java.compile.nullAnalysis.mode` is set to `disabled`. @@ -252,8 +250,8 @@ The following settings are supported: - macOS: `"~/Library/Caches/.jdt/index"` - Linux: First use `"$XDG_CACHE_HOME/.jdt/index"`, or `"~/.cache/.jdt/index"` if it does not exist * `java.refactoring.extract.interface.replace`: Specify whether to replace all the occurrences of the subtype with the new extracted interface. Defaults to `true`. -* `java.import.maven.disableTestClasspathFlag` : Enable/disable test classpath segregation. When enabled, this permits the usage of test resources within a Maven project as dependencies within the compile scope of other projects. Defaults to `false`. -* `java.configuration.maven.defaultMojoExecutionAction` : Specifies default mojo execution action when no associated metadata can be detected. Defaults to `ignore`. +* `java.import.maven.disableTestClasspathFlag`: Enable/disable test classpath segregation. When enabled, this permits the usage of test resources within a Maven project as dependencies within the compile scope of other projects. Defaults to `false`. +* `java.configuration.maven.defaultMojoExecutionAction`: Specifies default mojo execution action when no associated metadata can be detected. Defaults to `ignore`. * `java.completion.lazyResolveTextEdit.enabled`: [Experimental] Enable/disable lazily resolving text edits for code completion. Defaults to `true`. * `java.edit.validateAllOpenBuffersOnChanges`: Specifies whether to recheck all open Java files for diagnostics when editing a Java file. Defaults to `false`. * `java.editor.reloadChangedSources`: Specifies whether to reload the sources of the open class files when their source jar files are changed. Defaults to `ask`. @@ -271,8 +269,8 @@ The following settings are supported: * `java.jdt.ls.javac.enabled`: [Experimental] Specify whether to enable Javac-based compilation in the language server. Requires running this extension with Java 24. Defaults to `off`. * `java.completion.engine`: [Experimental] Select code completion engine. Defaults to `ecj`. * `java.references.includeDeclarations`: Include declarations when finding references. Defaults to `true` -* `java.jdt.ls.appcds.enabled` : [Experimental] Enable Java AppCDS (Application Class Data Sharing) for improvements to extension activation. When set to `auto`, AppCDS will be enabled in Visual Studio Code - Insiders, and for pre-release versions. -* `java.hover.javadoc.enabled` : Enable/disable displaying Javadoc on hover. Defaults to `true`. +* `java.jdt.ls.appcds.enabled`: [Experimental] Enable Java AppCDS (Application Class Data Sharing) for improvements to extension activation. When set to `auto`, AppCDS will be enabled in Visual Studio Code - Insiders, and for pre-release versions. +* `java.hover.javadoc.enabled`: Enable/disable displaying Javadoc on hover. Defaults to `true`. New in 1.54.0 * `java.inlayHints.formatParameters.enabled`: Enable/disable inlay hints for format specifiers in format strings (e.g. `String.format()`, `String.formatted()`, `PrintStream.printf()`). Shows which argument corresponds to each format specifier. Defaults to `false`. @@ -289,7 +287,7 @@ language tool logs for further information in case of a failure. ![ status indicator ](https://raw.githubusercontent.com/redhat-developer/vscode-java/main/images/statusMarker.png) -2. Read the [troubleshooting guide](https://github.com/redhat-developer/vscode-java/wiki/Troubleshooting) for collecting informations about issues you might encounter. +2. Read the [troubleshooting guide](https://github.com/redhat-developer/vscode-java/wiki/Troubleshooting) for collecting information about issues you might encounter. 3. Report any problems you face to the [project](https://github.com/redhat-developer/vscode-java/issues). diff --git a/USAGE_DATA.md b/USAGE_DATA.md index c977296de..0ec197e7a 100644 --- a/USAGE_DATA.md +++ b/USAGE_DATA.md @@ -7,23 +7,23 @@ vscode-java has opt-in telemetry collection, provided by [vscode-redhat-telemetr * vscode-java emits telemetry events when the extension starts and stops, which contain the common data mentioned on the [vscode-redhat-telemetry page](https://github.com/redhat-developer/vscode-redhat-telemetry/blob/main/USAGE_DATA.md#common-data). - * The name of the build tool used to import a project (eg. Maven, Gradle, Invisible (project), etc.) + * The name of the build tool used to import a project (e.g. Maven, Gradle, Invisible (project), etc.) * The total number of Java projects within the workspace - * The lowest and highest Java compiler source level used (eg. 11 & 17) - * Whether the project(s) are being imported for the first time (eg. true) + * The lowest and highest Java compiler source level used (e.g. 11 & 17) + * Whether the project(s) are being imported for the first time (e.g. true) * The elapsed time (in milliseconds) at which the language server initialized the workspace project(s), declared as ready for requests, and completed building the project(s) * The number of libraries that were indexed after project initialization * The total size (in bytes) of libraries that were indexed after project initialization * The number of error markers on the project(s) * The number of unresolved imports within the project(s) * Errors relating to running the language server, such as the message & stacktrace - * Whether there is a mismatch between the project's requested source level, and the JDK used for the project (eg. true) - * Information about the following settings. In the case of settings that store a well defined value (eg. path/url/string), we simply collect whether the setting has been set. + * Whether there is a mismatch between the project's requested source level, and the JDK used for the project (e.g. true) + * Information about the following settings. In the case of settings that store a well defined value (e.g. path, url or string), we simply collect whether the setting has been set. * `java.settings.url`, `java.format.settings.url`, `java.quickfix.showAt`, `java.symbols.includeSourceMethodDeclarations`, `java.completion.collapseCompletionItems`, `java.completion.guessMethodArguments`, `java.completion.postfix.enabled`, `java.cleanup.actionsOnSave`, `java.sharedIndexes.enabled`, `java.inlayHints.parameterNames.enabled`, `java.inlayHints.parameterNames.suppressWhenSameNameNumbered`, `java.inlayHints.variableTypes.enabled`, `java.inlayHints.parameterTypes.enabled`, `java.server.launchMode`, `java.autobuild.enabled`, `java.jdt.ls.javac.enabled` - * The extension name and the choice made when a recommendation to install a 3rd party extension is proposed + * The extension name and the choice made when a recommendation to install a third-party extension is proposed * The name of Java commands being manually executed, and any resulting errors - * The number of results (eg. 20), whether an error occurred (eg. false), engine type (eg. 'ecj', 'dom') and duration (in milliseconds) when code assist is activated - * Whether the language server ran out of memory and the maximum allocated memory at which that occurred (eg. 200m) + * The number of results (e.g. 20), whether an error occurred (e.g. false), engine type (e.g. 'ecj', 'dom') and duration (in milliseconds) when code assist is activated + * Whether the language server ran out of memory and the maximum allocated memory at which that occurred (e.g. 200m) ## What's included in the general telemetry data