From 0019e50605625c1b188ff512ed0e0e44c7ba8867 Mon Sep 17 00:00:00 2001
From: Scriptim <me@scriptim.dev>
Date: Fri, 26 Jan 2024 11:57:14 +0100
Subject: [PATCH] Add hint on the PROMPT_DIRTRIM variable

Resolves #22
---
 src/App.vue                           |  3 +++
 src/components/output/PS1Variable.vue | 27 ++++++++++++++++++++-------
 2 files changed, 23 insertions(+), 7 deletions(-)

diff --git a/src/App.vue b/src/App.vue
index 5975ca2..edd6347 100644
--- a/src/App.vue
+++ b/src/App.vue
@@ -123,6 +123,9 @@ h3
   opacity: 0.6
   line-height: 1.5
 
+  &+.hint
+    margin-top: 1em
+
 .dark
   h2,
   h3
diff --git a/src/components/output/PS1Variable.vue b/src/components/output/PS1Variable.vue
index 0df3ee1..3b0fce1 100644
--- a/src/components/output/PS1Variable.vue
+++ b/src/components/output/PS1Variable.vue
@@ -9,7 +9,7 @@
   <div class="ps1" :class="{ dark: darkMode }">
     <span>{{ ps1 }}</span>
   </div>
-  <div class="hint" v-if="hasAdvancedGitPromptElement">
+  <div class="hint" v-if="hasElement('Advanced Git Prompt')">
     The <code>Advanced Git Prompt</code> element requires some extra work: Copy the
     <a
       href="https://github.com/git/git/blob/master/contrib/completion/git-prompt.sh"
@@ -23,6 +23,17 @@
     By default the status will only contain the current branch name, however you can include more information using
     global or repository-local configuration options (which are also described in <code>git-prompt.sh</code>).
   </div>
+  <div class="hint" v-if="hasElement('Working Directory') || hasElement('Working Directory (Basename)')">
+    You can limit the number of components in the working directory path by setting the
+    <a
+      href="https://www.gnu.org/software/bash/manual/html_node/Bash-Variables.html#index-PROMPT_005fDIRTRIM"
+      target="_blank"
+      rel="noopener noreferrer"
+    >
+      <code>PROMPT_DIRTRIM</code>
+    </a>
+    environment variable in your <code>~/.bashrc</code> file.
+  </div>
 </template>
 
 <script lang="ts">
@@ -251,12 +262,6 @@ export default defineComponent({
     darkMode(): boolean {
       return darkMode().enabled;
     },
-    /**
-     * Returns `true` if there exists at least one 'Advanced Git Prompt' element.
-     */
-    hasAdvancedGitPromptElement(): boolean {
-      return prompt.state().elements.some((element) => element.data.type.name === 'Advanced Git Prompt');
-    },
   },
   components: { IconButton },
   methods: {
@@ -266,6 +271,14 @@ export default defineComponent({
     copyToClipboard() {
       navigator.clipboard.writeText(this.ps1);
     },
+    /**
+     * Returns `true` if there exists at least one prompt element with the given name.
+     *
+     * @param name the case-insensitive name of the prompt element
+     */
+    hasElement(name: string): boolean {
+      return prompt.state().elements.some((element) => element.data.type.name.toLowerCase() === name.toLowerCase());
+    },
   },
 });
 </script>