summaryrefslogtreecommitdiffstats
path: root/docs/config/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/config/README.md')
-rw-r--r--docs/config/README.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 8b4682943..400f7039d 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -1362,19 +1362,22 @@ disabled = false
## Java
The `java` module shows the currently installed version of Java.
-The module will be shown if any of the following conditions are met:
+By default the module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
### Options
-| Option | Default | Description |
-| ---------- | ---------------------------------------- | ----------------------------------------------- |
-| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
-| `symbol` | `"☕ "` | A format string representing the symbol of Java |
-| `style` | `"red dimmed"` | The style for the module. |
-| `disabled` | `false` | Disables the `java` module. |
+| Option | Default | Description |
+| ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
+| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. |
+| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. |
+| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
+| `detect_folders` | `[]` | Which folders should trigger this modules. |
+| `symbol` | `"☕ "` | A format string representing the symbol of Java |
+| `style` | `"red dimmed"` | The style for the module. |
+| `disabled` | `false` | Disables the `java` module. |
### Variables