bug#43539: closed ([PATCH] gnu: vim: Automatically find vim plugins.)

[GNU bug Tracking System]

Your message dated Sun, 20 Dec 2020 13:10:03 +0200
with message-id <X98xC8njiUjMZdhw@E5400>
and subject line Re: [bug#43539] [PATCH] gnu: vim: Automatically find vim 
plugins.
has caused the debbugs.gnu.org bug report #43539,
regarding [PATCH] gnu: vim: Automatically find vim plugins.
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs@gnu.org.)


-- 
43539: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=43539
GNU Bug Tracking System
Contact help-debbugs@gnu.org with problems
> --- Begin Message ---
>
>
>
> Subject: 
>
> [PATCH] gnu: vim: Automatically find vim plugins.
>
>
>
>
> Date: 
>
> Sun, 20 Sep 2020 22:15:23 +0300
>
>
>
>
> * gnu/packages/vim.scm (vim)[arguments]: Add new 'install-guix.vim phase
> to install vendor specific vimrc.
> * gnu/packages/aux-files/guix.vim: New file.
> * Makefile.am (AUX_FILES): Register it.
> ---
>  Makefile.am                     |  1 +
>  gnu/packages/aux-files/guix.vim |  7 +++++++
>  gnu/packages/vim.scm            | 10 +++++++++-
>  3 files changed, 17 insertions(+), 1 deletion(-)
>  create mode 100644 gnu/packages/aux-files/guix.vim
>
> diff --git a/Makefile.am b/Makefile.am
> index 8e91e1e558..d0867ecd22 100644
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -332,6 +332,7 @@ dist_noinst_DATA =                          \
>  AUX_FILES =                                            \
>    gnu/packages/aux-files/chromium/master-preferences.json              \
>    gnu/packages/aux-files/emacs/guix-emacs.el           \
> +  gnu/packages/aux-files/guix.vim                      \
>    gnu/packages/aux-files/linux-libre/5.8-arm.conf       \
>    gnu/packages/aux-files/linux-libre/5.8-arm64.conf     \
>    gnu/packages/aux-files/linux-libre/5.8-i686.conf      \
> diff --git a/gnu/packages/aux-files/guix.vim b/gnu/packages/aux-files/guix.vim
> new file mode 100644
> index 0000000000..ca97f451d8
> --- /dev/null
> +++ b/gnu/packages/aux-files/guix.vim
> @@ -0,0 +1,7 @@
> +" This appends all of the vim plugins to the end of Vim's runtimepath.
> +for directory in ["/run/current-system/profile", $HOME . "/.guix-profile", 
> $GUIX_ENVIRONMENT]
> +    let testpath = directory . "/share/vim/vimfiles"
> +    if isdirectory(testpath)
> +        let &rtp = join([&rtp,testpath], ',')
> +    endif
> +endfor
> diff --git a/gnu/packages/vim.scm b/gnu/packages/vim.scm
> index c6b1092e71..dba5b5a38e 100644
> --- a/gnu/packages/vim.scm
> +++ b/gnu/packages/vim.scm
> @@ -136,7 +136,14 @@
>               (substitute* "src/testdir/test_popupwin.vim"
>                 ((".*Test_popup_drag_termwin.*" line)
>                  (string-append line "return\n")))
> -             #t)))))
> +             #t))
> +         (add-after 'install 'install-guix.vim
> +           (lambda* (#:key inputs outputs #:allow-other-keys)
> +             (let ((vimdir (string-append (assoc-ref outputs "out") 
> "/share/vim")))
> +               (mkdir-p vimdir)
> +               (copy-file (assoc-ref inputs "guix.vim")
> +                          (string-append vimdir "/vimrc"))
> +               #t))))))
>      (inputs
>       `(("gawk" ,gawk)
>         ("ncurses" ,ncurses)
> @@ -144,6 +151,7 @@
>         ("tcsh" ,tcsh)))                 ; For runtime/tools/vim32
>      (native-inputs
>       `(("libtool" ,libtool)
> +       ("guix.vim" ,(search-auxiliary-file "guix.vim"))
>  
>         ;; For tests.
>         ("tzdata" ,tzdata-for-tests)))
> -- 
> 2.28.0
>
>
>
>
> --- End Message ---

--- Begin Message --- Subject: Re: [bug#43539] [PATCH] gnu: vim: Automatically find vim plugins. Date: Sun, 20 Dec 2020 13:10:03 +0200

On Fri, Sep 25, 2020 at 07:48:34PM +0200, Marius Bakke wrote:
> Efraim Flashner <efraim@flashner.co.il> writes:
> 
> > On Sun, Sep 20, 2020 at 11:57:58PM +0300, Efraim Flashner wrote:
> >> On Sun, Sep 20, 2020 at 09:50:12PM +0200, Ricardo Wurmus wrote:
> >> > 
> >> > Efraim Flashner <efraim@flashner.co.il> writes:
> >> > 
> >> > > On Sun, Sep 20, 2020 at 09:29:27PM +0200, Ricardo Wurmus wrote:
> >> > >> 
> >> > >> Efraim Flashner <efraim@flashner.co.il> writes:
> >> > >> 
> >> > >> > diff --git a/gnu/packages/aux-files/guix.vim 
> >> > >> > b/gnu/packages/aux-files/guix.vim
> >> > >> > new file mode 100644
> >> > >> > index 0000000000..ca97f451d8
> >> > >> > --- /dev/null
> >> > >> > +++ b/gnu/packages/aux-files/guix.vim
> >> > >> > @@ -0,0 +1,7 @@
> >> > >> > +" This appends all of the vim plugins to the end of Vim's 
> >> > >> > runtimepath.
> >> > >> > +for directory in ["/run/current-system/profile", $HOME . 
> >> > >> > "/.guix-profile", $GUIX_ENVIRONMENT]
> >> > >> 
> >> > >> How about using $GUIX_PROFILE as well or instead of 
> >> > >> $HOME/.guix-profile?
> >> > >> This would allow users to keep a separate profile for Vim things.
> >> > >
> >> > > That was the one part I didn't really like about my patch. 
> >> > > Unfortunately
> >> > > I don't seem to have $GUIX_PROFILE set on my machine.
> >> > >
> >> > > (ins)efraim@E5400 ~$ echo $GUIX_PROFILE
> >> > >
> >> > > (ins)efraim@E5400 ~$
> >> > 
> >> > Me neither!  But when loading profiles we suggest this approach:
> >> > 
> >> >    export GUIX_PROFILE=/the/location/of/the/.guix-profile
> >> >    source $GUIX_PROFILE/etc/profile
> >> > 
> >> > The variable is set in that case, because that affects whether absolute
> >> > store file names are used or the symlink
> >> > “/the/location/of/the/.guix-profile”.
> >> 
> >> It seems to be the case for the default profile. And in Guix System. I
> >> could also just add $GUIX_PROFILE as another location in the list of
> >> directories to search.
> >
> > The more I think about it the more I see $HOME/.guix-profile as a
> > "special profile" which is nearly always included in $PATH and other
> > variables, similar to /run/current-system/profile. With that in mind I
> > like the attached patch which keeps that path but adds a search for
> > $GUIX_PROFILE.
> >
> > I could use environment variables to override vim's builtin search for
> > $VIM and $VIMRUNTIME, but then we would have to decide to support vim
> > installed by the user or system-wide.
> 
> So vim only expects a single vimfiles directory in those variables?
> 
> [...]
> 
> > +++ b/gnu/packages/aux-files/guix.vim
> > @@ -0,0 +1,7 @@
> > +" This appends all of the vim plugins to the end of Vim's runtimepath.
> > +for directory in ["/run/current-system/profile", $HOME . "/.guix-profile", 
> > $GUIX_PROFILE, $GUIX_ENVIRONMENT]
> > +    let vimplugins = directory . "/share/vim/vimfiles"
> > +    if isdirectory(vimplugins)
> > +        let &rtp = join([&rtp,vimplugins], ',')
> > +    endif
> > +endfor
> 
> I wonder if we could generalize this to a proper search path with
> something like (pseudo code):
> 
>   for directory in getenv("VIM_PLUGIN_PATH").split(":")
>     let vimplugins = directory . "share/vim/vimfiles"
>     ...

Note for the future, 'let vimplugins = directory' is what works here.

> 
> And then in the vim package:
> 
> (native-search-paths
>  (list
>   (search-path-specification
>    (variable "VIM_PLUGIN_PATH")
>    (files '("share/vim/vimfiles")))))
> 
> ...which makes Guix populate VIM_PLUGIN_PATH automatically as plugins
> are added to a profile/environment (as long as it contains the 'vim'
> package).
> 
> WDYT?

I wasn't able to get anything like that to work. For some reason the
only combination I got using VIM_PLUGIN_PATH to work was a
guix-environment with vim and a plugin in it.

I pushed the version with the hardcoded list of directories since I was
able to actually get that one to work.

-- 
Efraim Flashner   <efraim@flashner.co.il>   אפרים פלשנר
GPG key = A28B F40C 3E55 1372 662D  14F7 41AA E7DC CA3D 8351
Confidentiality cannot be guaranteed on emails sent or received unencrypted

signature.asc
Description: PGP signature

--- End Message ---