add `write_perm` func and doc #340

phineas0fog · 2018-01-21T00:08:06Z

Description

Add segment who display a padlock (by default) if current dir is write protected or if current user has not enought rights to write in current directory.

Screenshot

maximbaz

So simple and yet so cool - definitely going to use myself!

maximbaz · 2018-01-21T00:25:39Z

spaceship.zsh

@@ -42,6 +42,7 @@ if [ -z "$SPACESHIP_PROMPT_ORDER" ]; then
  SPACESHIP_PROMPT_ORDER=(
    time          # Time stampts section
    user          # Username section
+    write_perm    # Write permission in current directory


I think it makes more sense to show the lock icon after the directory name, not before.

nfischer · 2018-01-21T03:03:16Z

docs/Options.md

+| `SPACESHIP_WRITE_PERM_PREFIX` | `` | Prefix before section |
+| `SPACESHIP_WRITE_PERM_SUFFIX` | `·` | Suffix after section |
+| `SPACESHIP_WRITE_PERM_COLOR` | `red` | Color of the icon |
+| `SPACESHIP_WRITE_PERM_ICON` | `` | Icon displayed |


What does this icon look like? In my terminal, that doesn't look like a padlock, but 🔒 does (link).

Also, I think this should be SYMBOL, not ICON (for consistency with the rest of spaceship).

Apparently the currently used icon is from FontAwesome and I didn't even notice this because I have FontAwesome installed, but I agree that the default icon should be from Unicode standard.

The lock symbol from Powerline font actually looks not bad too, since other sections use Powerline symbols already maybe it can be a default?

I would still prefer default unicode symbols when suitable ones exist. Many users forget to install powerline fonts. Some things are fairly obvious (e.g.  master), but some things aren't so clear
(e.g. /etc  vs. /etc 🔒)

agreed 👍

We already require powerline font, so why not? Powerline lock icon looks more native that Unicode one.

Powerline lock icon looks more native that Unicode one.

I agree, but I think the argument was that it's you and me who installed Powerline fonts, but others might decided to not install it. So far it was mostly needed for git branch icon, and it is possible that many users decided that they are fine not installing Powerline font and seeing  master instead of  master. Such users will now start seeing /etc .

I'll let @nfischer continue, I'm fine with any icon as default 😛

denysdovhan · 2018-01-21T10:57:14Z

@phineas0fog pull request template requires attaching a screenshot when you someone propose a new section. You're not an exception, so, please, provide a screenshot.

salmanulfarzy

Possibility about combining with dir section.

salmanulfarzy · 2018-01-21T11:51:20Z

spaceship.zsh

@@ -43,6 +43,7 @@ if [ -z "$SPACESHIP_PROMPT_ORDER" ]; then
    time          # Time stampts section
    user          # Username section
    dir           # Current directory section
+    write_perm    # Write permission in current directory


It doesn't have to be a separate section, Can we combine this dir section ?

I like this idea!

Another reason why I think it would be nice to have this as part of the dir section is because I'd like to move the "lock sign" closer to the directory name:

It's not as important for lock symbol, but personally I think I'll be using *, as lock is too massive in my mind:

Like this ?

spaceship_dir() { [[ $SPACESHIP_DIR_SHOW == false ]] && return local dir # Threat repo root as a top-level directory or not if [[ $SPACESHIP_DIR_TRUNC_REPO == true ]] && spaceship::is_git; then local git_root=$(git rev-parse --show-toplevel) dir="$git_root:t${$(expr $(pwd) : "$git_root$.*$")}" else dir="%${SPACESHIP_DIR_TRUNC}~" fi spaceship::section \ "$SPACESHIP_DIR_COLOR" \ "$SPACESHIP_DIR_PREFIX" \ "$dir" \ "$SPACESHIP_DIR_SUFFIX" [[ $SPACESHIP_WRITE_PERM_SHOW == false ]] && return [[ -w . ]] && return spaceship::section \ "$SPACESHIP_WRITE_PERM_COLOR" \ "$SPACESHIP_WRITE_PERM_PREFIX" \ "$SPACESHIP_WRITE_PERM_SYMBOL" \ "$SPACESHIP_WRITE_PERM_SUFFIX" }

Such approach won't allow moving PERM_SYMBOL closer to the directory name, but I can live without it, I think I'll be using Powerline's lock symbol and it looks better with a space anyway.

Wait for @salmanulfarzy to reply if this is what he had in mind code-wise though.

Do we need all this options ? In my opinion, Only SPACESHIP_WRITE_PERM_COLOR and SPACESHIP_WRITE_PERM_SYMBOL are needed.

I would rather replace/append lock symbol to SPACESHIP_DIR_SUFFIX than making it a separate section. Altering SPACESHIP_DIR_PREFIX might not be visible if dir is first section, Which is common.

SPACESHIP_DIR_WRITE_LOCK_SYMBOL="${SPACESHIP_DIR_WRITE_LOCK_SYMBOL=" 🔒 "}" # Before invoking the section if [[ ! -w . ]]; then SPACESHIP_DIR_SUFFIX="${SPACESHIP_DIR_WRITE_LOCK_SYMBOL}" fi

It doesn't allow to change colour of symbol, But I don't see myself changing colour of lock symbol. If needed we could make use of escape codes in assignment.

I think it's better if we can change color of lock, to make it more visible...

Now we have two options

Make it separate section. But still have this issue add write_perm func and doc #340 (comment)

If color is the only option missing, We could hack around it using,

if [[ ! -w . ]]; then SPACESHIP_DIR_SUFFIX="%F{$SPACESHIP_DIR_LOCK_COLOR}$SPACESHIP_DIR_WRITE_LOCK_SYMBOL%f" fi

I'm open to both options. Suggestion ?

Is it just me or the lock symbol stays opaque ? Tried with iTerm and Terminal.

…-theme into write_perm

And remove old files and adapt documentatiion

phineas0fog · 2018-01-22T11:51:27Z

I think is now better (?)

And for the icon, personnally I use FuraMonoForPowerline NF (it's from Nerd Fonts, a set of powerline fonts with more glyphs). But the padlock unicode symbol (🔒, U+1F512) is not displayed and I dont know why. This is why I put that of Powerline.

maximbaz · 2018-01-22T11:56:26Z

sections/dir.zsh

@@ -23,6 +25,8 @@ spaceship_dir() {

  local dir

+  [[ -w . ]] && SPACESHIP_WRITE_PERM_SYMBOL=''


this line is not needed, right?

maximbaz · 2018-01-22T12:01:17Z

sections/dir.zsh

@@ -31,6 +35,10 @@ spaceship_dir() {
    dir="%${SPACESHIP_DIR_TRUNC}~"
  fi

+  if [[ ! -w . ]]; then
+    SPACESHIP_DIR_SUFFIX="%F{$SPACESHIP_DIR_LOCK_COLOR} $SPACESHIP_DIR_LOCK_SYMBOL %f"


Since you are using this approach, I suggest these improvements:

Remove space here before and after $SPACESHIP_DIR_LOCK_SYMBOL, instead add spaces before and after the lock icon in the default value of SPACESHIP_DIR_LOCK_SYMBOL above - this will allow this:

You are overriding the value of $SPACESHIP_DIR_SUFFIX, I think you should keep it in case users configured it.

So this line I guess should become something like:

SPACESHIP_DIR_SUFFIX="%F{$SPACESHIP_DIR_LOCK_COLOR}${SPACESHIP_DIR_LOCK_SYMBOL}%f${SPACESHIP_DIR_SUFFIX}"

@phineas0fog I updated the last line ^^ a little after publishing, just so you know.

For readability, I think this is the best:

SPACESHIP_DIR_SUFFIX="%F{$SPACESHIP_DIR_LOCK_COLOR}${SPACESHIP_DIR_LOCK_SYMBOL}%f${SPACESHIP_DIR_SUFFIX}"

maximbaz · 2018-01-22T12:01:53Z

docs/Options.md

-| `SPACESHIP_DIR_COLOR` | `cyan` | Color of directory section |
+| `SPACESHIP_DIR_COLOR` | `cyan` | Color of directory section |''
+| `SPACESHIP_DIR_LOCK_SYMBOL` | `🔒` | The symbol displayed if directory is write-protected |
+| `SPACESHIP_DIR_LOCK_COLOR` | `red` | Color for the symbol |


for the lock symbol

maximbaz · 2018-01-22T12:02:53Z

docs/Options.md

@@ -127,6 +127,7 @@ Hostname is shown only when you're connected via SSH unless you change this beha
 ### Directory (`dir`)

 Directory is always shown and truncated to the value of `SPACESHIP_DIR_TRUNC`. While you are in repository, it shows only root directory and folders inside it.
+If current directory is write-protected or if current user has not enought rights to write in, a padlock (by default) s displayed as suffix.


tiny: if current user has not enought rights to write in it, a padlock (by default) is displayed as a suffix

…-theme into write_perm

maximbaz

awesome

maximbaz · 2018-01-22T17:15:46Z

docs/Options.md

@@ -135,7 +136,9 @@ Directory is always shown and truncated to the value of `SPACESHIP_DIR_TRUNC`. W
 | `SPACESHIP_DIR_SUFFIX` | `$SPACESHIP_PROMPT_DEFAULT_SUFFIX` | Suffix after current directory |
 | `SPACESHIP_DIR_TRUNC` | `3` | Number of folders of cwd to show in prompt, 0 to show all |
 | `SPACESHIP_DIR_TRUNC_REPO` | `true` | While in `git` repo, show only root directory and folders inside it |
-| `SPACESHIP_DIR_COLOR` | `cyan` | Color of directory section |
+| `SPACESHIP_DIR_COLOR` | `cyan` | Color of directory section |''
+| `SPACESHIP_DIR_LOCK_SYMBOL` | `🔒` | The symbol displayed if directory is write-protected |


Space into the docs ·🔒 🙂

salmanulfarzy · 2018-01-22T17:23:05Z

docs/Options.md

@@ -135,7 +136,9 @@ Directory is always shown and truncated to the value of `SPACESHIP_DIR_TRUNC`. W
 | `SPACESHIP_DIR_SUFFIX` | `$SPACESHIP_PROMPT_DEFAULT_SUFFIX` | Suffix after current directory |
 | `SPACESHIP_DIR_TRUNC` | `3` | Number of folders of cwd to show in prompt, 0 to show all |
 | `SPACESHIP_DIR_TRUNC_REPO` | `true` | While in `git` repo, show only root directory and folders inside it |
-| `SPACESHIP_DIR_COLOR` | `cyan` | Color of directory section |
+| `SPACESHIP_DIR_COLOR` | `cyan` | Color of directory section |''


Remove empty string after the last column separator.

salmanulfarzy · 2018-01-22T17:29:31Z

sections/dir.zsh

@@ -13,6 +13,8 @@ SPACESHIP_DIR_SUFFIX="${SPACESHIP_DIR_SUFFIX="$SPACESHIP_PROMPT_DEFAULT_SUFFIX"}
 SPACESHIP_DIR_TRUNC="${SPACESHIP_DIR_TRUNC=3}"
 SPACESHIP_DIR_TRUNC_REPO="${SPACESHIP_DIR_TRUNC_REPO=true}"
 SPACESHIP_DIR_COLOR="${SPACESHIP_DIR_COLOR="cyan"}"
+SPACESHIP_DIR_LOCK_SYMBOL="${SPACESHIP_DIR_LOCK_SYMBOL=" 🔒"}"
+SPACESHIP_DIR_LOCK_COLOR="${SPACESHIP_DIR_LOCK_COLOR=red}"


Please quote the color variable.

denysdovhan · 2018-01-22T23:25:01Z

I wouldn't agree with @salmanulfarzy. As you may notice from git and hg sections, the section should be as atomic and composable as it can. That's why we have git_branch and git_status.

I like the idea to have it as a separate section, but write_perm as a name is not obvious (write permission for what?). By the way, it might be useful for some users to see other permissions (rwx) as a status (like in git section).

As an alternative solution, we can use a diferent color for dir section when write-access is not provides.

maximbaz · 2018-01-22T23:48:11Z

rwx is probably an overkill... I think you won't be able to enter a unreadable directory, so r will always be present. As for x, it is possible, but very very few directories are mounted with noexec, so I don't really think it is worth even considering this until at least one person shows up and says that they want it for such and such reason.

As an alternative solution, we can use a diferent color for dir section when write-access is not provides.

This will make directory names stand out too much, I personally prefer a very small indicator, such as * or poweline lock icon.

Sections have spaces between them, that's also why I like the icon being part of the dir module, I think it looks kinda neat 🙂 But as mentioned earlier, I'm fine with it being a separate section too.

salmanulfarzy · 2018-01-23T02:58:40Z

As I said before, I'm open to both options. Just that I don't see what possible options _SUFFIX and _PREFIX could get here and find it better with this suggestion by @maximbaz

Agree with @maximbaz on rwx functionality.

phineas0fog · 2018-01-26T16:12:28Z

So, what should I do ?

denysdovhan

Consider my suggestions

denysdovhan · 2018-01-30T10:24:22Z

docs/Options.md

@@ -136,6 +137,8 @@ Directory is always shown and truncated to the value of `SPACESHIP_DIR_TRUNC`. W
 | `SPACESHIP_DIR_TRUNC` | `3` | Number of folders of cwd to show in prompt, 0 to show all |
 | `SPACESHIP_DIR_TRUNC_REPO` | `true` | While in `git` repo, show only root directory and folders inside it |
 | `SPACESHIP_DIR_COLOR` | `cyan` | Color of directory section |
+| `SPACESHIP_DIR_LOCK_SYMBOL` | `·🔒` | The symbol displayed if directory is write-protected |


Please, use powerline lock icon.

@denysdovhan just to confirm, have you seen this thread? I'm personally using powerline lock icon too, but I kinda agree with the argument there.

We already require powerline patched font, why don't we use all of its power?

Updated with powerline lock symbol, Allows the color to be modified.

denysdovhan · 2018-01-30T10:25:32Z

docs/README.md

@@ -56,4 +56,3 @@
  * [spaceship::displaytime](/docs/API.md#spaceshipdisplaytime-seconds)
  * [spaceship::union](/docs/API.md#spaceshipunion-arr1-arr2-)
 * [Troubleshooting](/docs/Troubleshooting.md)
-


Do not remove the last empty line. You can use .editorconfig which is already present in our repo.

Reverted to original file.

sections/dir.zsh

denysdovhan · 2018-01-30T10:29:21Z

We will definitely have some users that would open tons of issues like:

What is a strange * appears right after dir? Am I doing something wrong?

How to disable my broken dir section?

salmanulfarzy · 2018-05-05T03:05:56Z

@phineas0fog still interested in updating this ?

Suggestions fixed on PR

salmanulfarzy · 2018-09-29T16:08:43Z

This has been open for awhile, Fixed the suggestions and merging.

…pt#340)

add write_perm func and doc

15b133e

maximbaz approved these changes Jan 21, 2018

View reviewed changes

move write_perm segment after dir segment

c29b8f0

nfischer reviewed Jan 21, 2018

View reviewed changes

salmanulfarzy reviewed Jan 21, 2018

View reviewed changes

maximbaz added the new-feature A PR that implement feature (section, specific behavior, etc). label Jan 21, 2018

phineas0fog added 2 commits January 22, 2018 12:46

Merge branch 'master' of https://github.com/denysdovhan/spaceship-zsh…

2fa3268

…-theme into write_perm

Move write-lock in dir section

a98b1f1

And remove old files and adapt documentatiion

maximbaz suggested changes Jan 22, 2018

View reviewed changes

phineas0fog added 2 commits January 22, 2018 18:05

Merge branch 'master' of https://github.com/denysdovhan/spaceship-zsh…

18678ac

…-theme into write_perm

correct typo mistakes, remove useless lines, update symbol display

03e8804

maximbaz previously approved these changes Jan 22, 2018

View reviewed changes

correct mistake

dd75056

salmanulfarzy requested changes Jan 22, 2018

View reviewed changes

phineas0fog added 2 commits January 22, 2018 19:28

correct mistakes

5a63d9d

correct mistakes

dfe3e60

denysdovhan previously requested changes Jan 30, 2018

View reviewed changes

Use powerline lock symbol

afa34d7

salmanulfarzy dismissed maximbaz’s stale review via afa34d7 September 29, 2018 15:52

Update docs for dir lock symbol

bd910dd

salmanulfarzy approved these changes Sep 29, 2018

View reviewed changes

salmanulfarzy merged commit a5d5d31 into spaceship-prompt:master Sep 29, 2018

matchai mentioned this pull request Sep 29, 2018

Add "write permission" feature to dir section matchai/spacefish#75

Closed

salmanulfarzy mentioned this pull request Oct 13, 2018

Add Elm Section #528

Merged

This was referenced Oct 22, 2018

Strange character inside the snap folder on Ubuntu #538

Closed

Add image for powerline dir lock symbol #517

Merged

dedene pushed a commit to zenjoy/spaceship-prompt that referenced this pull request Feb 24, 2019

Display lock symbol as suffix on no-write directories (spaceship-prom…

bf41c03

…pt#340)

denysdovhan pushed a commit that referenced this pull request May 27, 2021

Display lock symbol as suffix on no-write directories (#340)

4ab3ef3

		@@ -23,6 +25,8 @@ spaceship_dir() {

		local dir

		[[ -w . ]] && SPACESHIP_WRITE_PERM_SYMBOL=''

add write_perm func and doc #340

add write_perm func and doc #340

Conversation

phineas0fog commented Jan 21, 2018 • edited

Description

Screenshot

maximbaz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

denysdovhan commented Jan 21, 2018

salmanulfarzy left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maximbaz Jan 21, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

salmanulfarzy Jan 22, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phineas0fog commented Jan 22, 2018 • edited

Choose a reason for hiding this comment

maximbaz Jan 22, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maximbaz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

denysdovhan commented Jan 22, 2018

maximbaz commented Jan 22, 2018

salmanulfarzy commented Jan 23, 2018 • edited

phineas0fog commented Jan 26, 2018

denysdovhan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

salmanulfarzy Sep 29, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

denysdovhan commented Jan 30, 2018

salmanulfarzy commented May 5, 2018

salmanulfarzy commented Sep 29, 2018 • edited

add `write_perm` func and doc #340

add `write_perm` func and doc #340

phineas0fog commented Jan 21, 2018 •

edited

salmanulfarzy left a comment •

edited

maximbaz Jan 21, 2018 •

edited

salmanulfarzy Jan 22, 2018 •

edited

phineas0fog commented Jan 22, 2018 •

edited

maximbaz Jan 22, 2018 •

edited

salmanulfarzy commented Jan 23, 2018 •

edited

salmanulfarzy Sep 29, 2018 •

edited

salmanulfarzy commented Sep 29, 2018 •

edited