diff options
| author | Kuba Clark <jakub.clark@protonmail.com> | 2019-09-20 01:02:53 +0200 |
|---|---|---|
| committer | Kevin Song <chipbuster@users.noreply.github.com> | 2019-09-19 18:02:53 -0500 |
| commit | 71f03ec3e948e7e8871657bcb19ea65aafea57e8 (patch) | |
| tree | 84140d2268bc9550a24b8e05c5337e387a85f451 /docs | |
| parent | 3eb97bd48f8207f25a45a98de7e81b0e634df8bf (diff) | |
feat: Add Java Module (#314)
Implements a Java module which shows basic Java information when inside a Java project.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 427720f6a..7aae0099b 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -93,6 +93,7 @@ prompt_order = [ "rust", "python", "golang", + "java", "nix_shell", "cmd_duration", "line_break", @@ -493,6 +494,31 @@ impure_msg = "impure shell" pure_msg = "pure shell" ``` +## Java + +The `java` module shows the currently installed version of Java. +The module will be shown if any of the following conditions are met: + +- The current directory contains a `pom.xml` or `build.gradle` file +- The current directory contains a file with the `.java`, `.class` or `.jar` extension + +### Options + +| Variable | Default | Description | +| ---------- | -------------- | -------------------------------------------------------- | +| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. | +| `style` | `"dimmed red"` | The style for the module. | +| `disabled` | `false` | Disables the `java` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[java] +symbol = "🌟 " +``` + ## NodeJS |