Add counsel-bookmarked-directory #1657

akirak · 2018-07-08T20:27:19Z

This command was originally named ivy-bookmarked-directory, but I got a suggestion to add it as an alternative command, so I added this to counsel package. If you don't mind, I would like you to add this command.

basil-conto · 2018-07-08T21:54:18Z

counsel.el

@@ -2063,6 +2063,65 @@ By default `counsel-bookmark' opens a dired buffer for directories."
   ("r" ,(counsel--apply-bookmark-fn #'counsel-find-file-as-root)
        "open as root")))

+;;** `counsel-bookmarked-directory'
+(defcustom counsel-bookmarked-directory-default-name "%s"
+  "Default bookmark name created by `counsel-bookmarked-directory-add."


Neither the variable name nor the docstring make it clear that the value should/can be a format string. I'm not familiar with how it's used yet, but at first glance a name like counsel-bookmarked-directory-format or similar would seem more intuitive.

I simply omitted this custom variable. Thanks.

basil-conto · 2018-07-08T21:54:18Z

counsel.el

+    (substring (expand-file-name "b" parent) i (1+ i))))
+
+(defconst counsel-bookmarked-directory-separator
+  (counsel-bookmarked-directory--path-separator))


You should use the function ivy--dirname-p instead of this. Even on non-POSIX systems, Emacs understands POSIX filenames, so Elisp programs should almost never have to deal with path separators, which is very brittle; see (elisp) File Names.

basil-conto · 2018-07-08T21:54:18Z

counsel.el

+(defun counsel-bookmarked-directory--candidates ()
+  "Get a list of bookmarked directories sorted by file path."
+  (bookmark-maybe-load-default-file)
+  (cl-sort (cl-remove-if-not


You can use the built-in sort instead of cl-sort here.

basil-conto · 2018-07-08T21:54:18Z

counsel.el

+  (bookmark-maybe-load-default-file)
+  (cl-sort (cl-remove-if-not
+            (lambda (filename)
+              (string-suffix-p counsel-bookmarked-directory-separator filename))


Given my previous comment, this lambda can be replaced with #'ivy--dirname-p.

basil-conto · 2018-07-08T21:54:18Z

counsel.el

+
+;;;###autoload
+(defun counsel-bookmarked-directory-add (dir name)
+  "Add a bookmark to DIR with NAME."


The docstring should mention what values DIR and NAME default to when called interactively.

I have updated the function.

basil-conto · 2018-07-08T21:54:18Z

counsel.el

+                                                     path)
+                                             (format counsel-bookmarked-directory-default-name
+                                                     path)))))
+  (let* ((record `((filename . ,(abbreviate-file-name (file-name-as-directory (expand-file-name dir))))


You can use let instead of let* here.

basil-conto · 2018-07-08T21:54:18Z

counsel.el

+                       (read-from-minibuffer (format "Name of the new bookmark to %s: "
+                                                     path)
+                                             (format counsel-bookmarked-directory-default-name
+                                                     path)))))


Why are DIR and NAME separate arguments, rather than a single file name argument?

Why is read-from-minibuffer being used instead of read-directory-name?

If counsel-bookmarked-directory-default-name is always going to be formatted based on default-directory, then what's its purpose? Manipulating file names as strings (e.g. by interpolation) is usually a bad idea, so why not provide a user option counsel-bookmarked-directory-default of type 'directory which will act as the second argument to read-directory-name instead?

basil-conto · 2018-07-08T21:54:18Z

counsel.el

+current value of `default-directory'."
+  (interactive)
+  (if current-prefix-arg
+      (call-interactively 'counsel-bookmarked-directory-add)


Nitpick: Use #' instead of '.

basil-conto · 2018-07-08T21:54:18Z

counsel.el

+    (ivy-read "Bookmarked directory: "
+              (counsel-bookmarked-directory--candidates)
+              :caller 'counsel-bookmarked-directory
+              :action 'dired)))


basil-conto · 2018-07-08T21:54:18Z

counsel.el

+              :action 'dired)))
+
+(ivy-set-actions 'counsel-bookmarked-directory
+                 '(("j" dired-other-window "dired-other-window")


Usually Counsel just calls this "other window".

akirak · 2018-07-09T06:09:53Z

Thanks for the review. I pushed a new commit that would fix those issues.

basil-conto · 2018-07-09T08:55:46Z

counsel.el

+    (ivy-read "Bookmarked directory: "
+              (counsel-bookmarked-directory--candidates)
+              :caller 'counsel-bookmarked-directory
+              :action 'dired)))


Nitpick: use #' instead of '.

basil-conto · 2018-07-09T08:55:46Z

counsel.el

+This function prompts for the bookmark name, which defaults to the
+abbreviate path of the directory.
+
+When called-interactively, DIR defaults to he current value of


Typo: the instead of he.

basil-conto · 2018-07-09T08:55:46Z

counsel.el

+         (default-name abbr-path)
+         (name (read-string (format "Name of the new directory bookmark [%s]: "
+                                    default-name)
+                            nil nil default-name))


OK, I understand now that this is just meant to be a bookmark name, rather than a directory, which is why read-directory-name isn't used. Either way, no need for both abbr-path and default-name; pick a single descriptive variable name, e.g. abbr-dir, and use that consistently. In fact, I would reuse the argument dir:

(setq dir (abbreviate-file-name (expand-file-name dir))) (let ((name (read-string (format "Name of new directory bookmark [%s]: " dir) nil nil dir)) (record `((filename . ,(file-name-as-directory dir)) (front-context-string) (rear-context-string)))) (bookmark-maybe-load-default-file) (bookmark-store name record nil))

basil-conto · 2018-07-09T09:03:21Z

By the way, these are significant changes (more than ~15 lines), so you need to assign copyright to the FSF in order for them to be merged. Have you already done so? If not, are you willing to? See https://github.com/abo-abo/swiper/blob/master/CONTRIBUTING.org#copyright-assignment for some more details on this.

I'm also wondering whether the copyright story is at all affected by the fact that this code already exists as a separate package ivy-bookmarked-directory.

abo-abo · 2018-07-09T15:46:31Z

I'm also wondering whether the copyright story is at all affected by the fact that this code already exists as a separate package ivy-bookmarked-directory.

This isn't an issue as long as we have CA on the commits that we merge here. But yes, if someone without a CA commits to upstream, then we couldn't merge it here.

abo-abo · 2018-07-09T15:47:17Z

counsel.el

+  (bookmark-maybe-load-default-file)
+  (sort (cl-remove-if-not
+         #'ivy--dirname-p
+         (mapcar #'bookmark-get-filename bookmark-alist))


Please wrap with (delq nil).

basil-conto · 2018-08-09T13:36:30Z

@akirak Are you willing to start or have you already started the copyright assignment process?

akirak · 2018-08-10T15:39:58Z

I sent a signed PDF two weeks ago, and the registration process has been just completed!

abo-abo · 2018-08-13T16:23:29Z

@akirak Merged, thanks. I didn't merge the counsel-bookmarked-directory-add for now; I'm not convinced that it belongs in counsel, since it simply calls read-string with no completion. And it's very similar to the built in C-x r m (bookmark-set).

Can you explain why you added it and the advantages over bookmark-set? If it's really needed, open a new PR.

counsel.el (counsel-bookmarked-directory): Load required feature and declare its definitions. Re: abo-abo#1657

akirak · 2018-08-14T06:25:21Z

counsel-bookmarked-directory-add adds a bookmark to the directory rather than to the file. This behaves differently from bookmark-set in many cases, e.g. when the current buffer is a file. Maybe it should be named counsel-add-directory-bookmark, since it is now in counsel package and it needs only counsel- as its naming prefix.

abo-abo · 2018-08-14T12:16:57Z

But how is it different when you're in a dired buffer and call bookmark-set?

akirak · 2018-08-14T14:24:48Z

It doesn't make much difference in a dired buffer, but it gives an abbreviate absolute path as the default name.

abo-abo · 2018-08-14T15:22:24Z

It doesn't make much difference in a dired buffer

Then I'm not convinced we should have it. If I want to bookmark a directory, I always do it from a dired buffer.

akirak · 2018-08-14T15:24:35Z

I see. I don't mind if the command won't be added to counsel package. Thank you for your comment.

basil-conto reviewed Jul 8, 2018

View changes

akirak force-pushed the bookmarked-directory branch from 52856ae to 00fda1d Compare Jul 9, 2018

basil-conto reviewed Jul 9, 2018

View changes

abo-abo reviewed Jul 9, 2018

View changes

Add counsel-bookmarked-directory

6402bd0

akirak force-pushed the bookmarked-directory branch from b414500 to 6402bd0 Compare Jul 16, 2018

abo-abo closed this in abo-abo/swiper@e975622 Aug 13, 2018

basil-conto added a commit to basil-conto/swiper that referenced this issue Aug 13, 2018

Pacify counsel-bookmarked-directory warnings

71cfa9b

counsel.el (counsel-bookmarked-directory): Load required feature and declare its definitions. Re: abo-abo#1657

basil-conto mentioned this pull request Aug 13, 2018

Pacify counsel-bookmarked-directory warnings #1715

Merged

abo-abo / swiper Public

Add counsel-bookmarked-directory #1657

Add counsel-bookmarked-directory #1657

akirak commented Jul 8, 2018 •

edited

basil-conto Jul 8, 2018

akirak Jul 9, 2018

basil-conto Jul 8, 2018

basil-conto Jul 8, 2018

basil-conto Jul 8, 2018

basil-conto Jul 8, 2018

akirak Jul 9, 2018

basil-conto Jul 8, 2018

basil-conto Jul 8, 2018 •

edited

basil-conto Jul 8, 2018

basil-conto Jul 8, 2018

basil-conto Jul 8, 2018

akirak commented Jul 9, 2018

basil-conto Jul 9, 2018

basil-conto Jul 9, 2018

basil-conto Jul 9, 2018

basil-conto commented Jul 9, 2018

abo-abo commented Jul 9, 2018

abo-abo Jul 9, 2018

basil-conto commented Aug 9, 2018

akirak commented Aug 10, 2018

abo-abo commented Aug 13, 2018

akirak commented Aug 14, 2018

abo-abo commented Aug 14, 2018

akirak commented Aug 14, 2018

abo-abo commented Aug 14, 2018

akirak commented Aug 14, 2018

abo-abo / swiper Public

Add counsel-bookmarked-directory #1657

Add counsel-bookmarked-directory #1657

Conversation

akirak commented Jul 8, 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

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

basil-conto Jul 8, 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

akirak commented Jul 9, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

basil-conto commented Jul 9, 2018

abo-abo commented Jul 9, 2018

Choose a reason for hiding this comment

basil-conto commented Aug 9, 2018

akirak commented Aug 10, 2018

abo-abo commented Aug 13, 2018

akirak commented Aug 14, 2018

abo-abo commented Aug 14, 2018

akirak commented Aug 14, 2018

abo-abo commented Aug 14, 2018

akirak commented Aug 14, 2018

akirak commented Jul 8, 2018 •

edited

basil-conto Jul 8, 2018 •

edited