gnu: home: dotfiles: Avoid creating extra directory in $HOME.

  • Done
  • quality assurance status badge
Details
5 participants
  • paul
  • Janneke Nieuwenhuizen
  • Giacomo Leidi
  • Ludovic Courtès
  • Sergey Trofimov
Owner
unassigned
Submitted by
paul
Severity
normal
P
P
paul wrote on 31 Jan 23:15 +0100
(address . guix-patches@gnu.org)
14bc720d-7fdc-516a-3018-58294c1cafcd@autistici.org
Hello,

I'm sending a patch supposed to fix https://issues.guix.gnu.org/68848 .
Please let me know if this is ok for you and fixes your issues.


Thank you,


giacomo
G
G
Giacomo Leidi wrote on 31 Jan 23:17 +0100
(address . 68857@debbugs.gnu.org)(name . Giacomo Leidi)(address . goodoldpaul@autistici.org)
20240131221748.1190-1-goodoldpaul@autistici.org
This patch applies the fix from https://issues.guix.gnu.org/60521#43,
it is supposed to fix https://issues.guix.gnu.org/68848.

* gnu/home/services/dotfiles.scm (import-dotfiles)[strip]: Drop extra
directory.

Change-Id: I98b747396e1fc8a8925204cde2bb705019ce2c1d
---
gnu/home/services/dotfiles.scm | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)

Toggle diff (21 lines)
diff --git a/gnu/home/services/dotfiles.scm b/gnu/home/services/dotfiles.scm
index 6a740c42ce..fc842f1fb3 100644
--- a/gnu/home/services/dotfiles.scm
+++ b/gnu/home/services/dotfiles.scm
@@ -58,7 +58,11 @@ (define (import-dotfiles directory files)
generated by recursively visiting DIRECTORY and mapping its contents to the
user's home directory, excluding files that match any of the patterns in EXCLUDED."
(define (strip file)
- (string-drop file (+ 1 (string-length directory))))
+ (string-join
+ (cdr
+ (string-split (string-drop file (+ 1 (string-length directory)))
+ #\/))
+ "/"))
(define (format file)
;; Remove from FILE characters that cannot be used in the store.

base-commit: bf7991a8c767abd32cfb2c92e3d57665a7cabf00
--
2.41.0
P
J
J
Janneke Nieuwenhuizen wrote on 7 Feb 09:05 +0100
(name . paul)(address . goodoldpaul@autistici.org)
87cyt8d7hu.fsf@gnu.org
paul writes:

Hi Paul,

Toggle quote (3 lines)
> could you try whether this patch solves
> https://issues.guix.gnu.org/68848 for you?

Yes, that fixes it. Although I would rather write it something like

Toggle snippet (7 lines)
(define (strip file-name)
(let ((dotfile-name (string-drop file-name (+1 (string-length directory)))))
(match (string-split dotfile-name #\/)
((package parts ...)
(string-join parts "/")))))

Toggle quote (2 lines)
> Thank you for your time,

No problem, somehow I looked for a patch and didn't see it before.

Thanks for the ping and for fixing this.

Greetings,
Janneke

--
Janneke Nieuwenhuizen <janneke@gnu.org> | GNU LilyPond https://LilyPond.org
Freelance IT https://www.JoyOfSource.com| Avatar® https://AvatarAcademy.com
J
J
Janneke Nieuwenhuizen wrote on 7 Feb 09:37 +0100
(name . paul)(address . goodoldpaul@autistici.org)
878r3wd60l.fsf@gnu.org
Janneke Nieuwenhuizen writes:

Toggle quote (12 lines)
> paul writes:
>
> Hi Paul,
>
>> could you try whether this patch solves
>> https://issues.guix.gnu.org/68848 for you?
>
> Yes, that fixes it. Although I would rather write it something like
>
> (define (strip file-name)
> (let ((dotfile-name (string-drop file-name (+1 (string-length directory)))))

Err that should have been 1+, of course, so

Toggle snippet (7 lines)
(define (strip file-name)
(let ((dotfile-name (string-drop file-name (1+ (string-length directory)))))
(match (string-split dotfile-name #\/)
((package parts ...)
(string-join parts "/")))))

--
Janneke Nieuwenhuizen <janneke@gnu.org> | GNU LilyPond https://LilyPond.org
Freelance IT https://www.JoyOfSource.com| Avatar® https://AvatarAcademy.com
P
P
paul wrote on 16 Feb 18:16 +0100
(address . 68857@debbugs.gnu.org)
736b3c27-c913-38b2-f89a-ccc5f486a665@autistici.org
Hi everyone,

thank you for your help and comments so far. I have a proposal that should:


- allow for both plain and GNU Stow's layouts

- for GNU Stow layouts, allows to select a subset of application
dotfiles to be provisioned in the user's home directory. Please Sergey
let me know if this covers your use case .


Ludo' , Janneke, let me know your thoughts on this v2 and if it works
for your directory layouts. Thank you again everyone for your efforts.


giacomo
G
G
Giacomo Leidi wrote on 16 Feb 18:17 +0100
[PATCH v2] gnu: home: dotfiles: Properly support both plain and Stow directory layouts.
(address . 68857@debbugs.gnu.org)(name . Giacomo Leidi)(address . goodoldpaul@autistici.org)
20240216171724.22171-1-goodoldpaul@autistici.org
The current implementation of the home-dotfiles-service-type contradicts
the Guix manual (see https://issues.guix.gnu.org/68848). This patch
properly implements both the plain and Stow dotfiles directory layouts.

It does so by creating a new record type for each directory layout. This
approach, compared to having a single field in
home-dotfiles-configuration,
allows for having different layouts for different directories and to
carry additional information that might be required for some layouts.

Implementing a new layout should just be a matter of creating a new
record type, defining a strip-*-dotfile procedure and plugging them into
the home-dotfiles-service-type.

* gnu/home/services/dotfiles (home-dotfiles-stow-directory): New
variable;
(home-dotfiles-plain-directory): new variable;
(home-dotfiles-configuration): migrate to (gnu services configuration);
(strip-stow-dotfile): new variable;
(strip-plain-dotfile): new variable;
(home-dotfiles-configuration->files): use the new record types;
[directory-contents]: allow for
selecting a subset of application dotfile directories;
* doc/guix.texi: document the new layouts.

Change-Id: I2e96037608353e360828290f055ec5271cfdfd48
---
doc/guix.texi | 147 ++++++++++++++++++++++++++++-----
gnu/home/services/dotfiles.scm | 143 ++++++++++++++++++++++++++------
2 files changed, 244 insertions(+), 46 deletions(-)

Toggle diff (399 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index 04119a5955..21adfb1fc0 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -44368,17 +44368,39 @@ directory, and some way of automatically deploy changes to their user home.
@cindex Stow-like dot file management
The @code{home-dotfiles-service-type} from @code{(gnu home services dotfiles)}
is designed to ease the way into using Guix Home for this kind of users,
-allowing them to point the service to their dotfiles directory, which must
-follow the layout suggested by
-@uref{https://www.gnu.org/software/stow/, GNU Stow},
-and have their dotfiles automatically deployed to their user home, without
+allowing them to point the service to their dotfiles directory without
migrating them to Guix native configurations.
-The dotfiles directory layout is expected to be structured as follows. Please
-keep in mind that it is advisable to keep your dotfiles directories under
+Please keep in mind that it is advisable to keep your dotfiles directories under
version control, for example in the same repository where you'd track your
Guix Home configuration.
+There are two supported dotfiles directory layouts, for now. The
+@code{home-dotfiles-plain-directory} layout, which is structured as follows:
+
+@example
+~$ tree -a ./dotfiles/
+dotfiles/
+??? .gitconfig
+??? .gnupg
+? ??? gpg-agent.conf
+? ??? gpg.conf
+??? .guile
+??? .config
+? ??? guix
+? ? ??? channels.scm
+? ??? nixpkgs
+? ??? config.nix
+??? .nix-channels
+??? .tmux.conf
+??? .vimrc
+@end example
+
+and the @code{home-dotfiles-stow-directory} layout, which must
+follow the layout suggested by
+@uref{https://www.gnu.org/software/stow/, GNU Stow} and presents and additional
+application specific directory layer, just like:
+
@example
~$ tree -a ./dotfiles/
dotfiles/
@@ -44408,8 +44430,9 @@ dotfiles/
@end example
For an informal specification please refer to the Stow manual
-(@pxref{Top,,, stow, Introduction}). A suitable configuration would then
-be:
+(@pxref{Top,,, stow, Introduction}).
+
+A suitable configuration with a @emph{plain} layout could be:
@lisp
(home-environment
@@ -44417,7 +44440,10 @@ be:
(services
(service home-dotfiles-service-type
(home-dotfiles-configuration
- (directories (list "./dotfiles"))))))
+ (directories
+ (list
+ (home-dotfiles-plain-directory
+ (name "./dotfiles"))))))))
@end lisp
The expected home directory state would then be:
@@ -44444,32 +44470,113 @@ Return a service which is very similiar to @code{home-files-service-type}
(and actually extends it), but designed to ease the way into using Guix
Home for users that already track their dotfiles under some kind of version
control. This service allows users to point Guix Home to their dotfiles
-directory and have their files automatically deployed to their home directory
-just like Stow would, without migrating all of their dotfiles to Guix native
+directory and have their files automatically provisioned to their home
+directory, without migrating all of their dotfiles to Guix native
configurations.
@end defvar
+@c %start of fragment
+
@deftp {Data Type} home-dotfiles-configuration
Available @code{home-dotfiles-configuration} fields are:
@table @asis
-@item @code{source-directory} (default: @code{(current-source-directory)})
-The path where dotfile directories are resolved. By default dotfile directories
-are resolved relative the source location where
+@item @code{source-directory} (default: @code{(current-source-directory)}) (type: string)
+The path where dotfile directories are resolved. By default dotfile
+directories are resolved relative the source location where
@code{home-dotfiles-configuration} appears.
-@item @code{directories} (type: list-of-strings)
-The list of dotfiles directories where @code{home-dotfiles-service-type} will
-look for application dotfiles.
+@item @code{directories} (default: @code{'()}) (type: list-of-plain-or-stow-directories)
+The list of dotfiles directories where @code{home-dotfiles-service-type}
+will look for application dotfiles. Each element of the list is supposed to be
+either a @code{home-dotfiles-plain-directory} or a
+@code{home-dotfiles-stow-directory} record.
+
+@item @code{excluded} (default: @code{'(".*~" ".*\\.swp" "\\.git" "\\.gitignore")}) (type: list-of-strings)
+The list of file patterns @code{home-dotfiles-service-type} will exclude
+while visiting each one of the @code{directories}.
+
+@end table
+
+@end deftp
+
+
+@c %end of fragment
+
+@c %start of fragment
+
+@deftp {Data Type} home-dotfiles-plain-directory
+
+This record represents the simplest layout supported. In this layout the
+dotfiles directory contains a tree of files which will be directly mapped into
+the user directory:
+
+@example
+~$ tree -a ./dotfiles/
+dotfiles/
+??? .guile
+??? .config
+? ??? guix
+? ??? channels.scm
+??? .tmux.conf
+??? .vimrc
+@end example
+
+Available @code{home-dotfiles-plain-directory} fields are:
-@item @code{exclude} (default: @code{'(".*~" ".*\\.swp" "\\.git" "\\.gitignore")})
-The list of file patterns @code{home-dotfiles-service-type} will exclude while
-visiting each one of the @code{directories}.
+@table @asis
+@item @code{name} (type: string)
+The name of the dotfile directory where
+@code{home-dotfiles-service-type} will look for plain dotfiles.
@end table
@end deftp
+@c %start of fragment
+
+@deftp {Data Type} home-dotfiles-stow-directory
+
+This record represents GNU Stow's usual layout. In this layout the
+dotfiles directory contains a layer of application directories, each one
+containing a home file tree. The @code{home-dotfiles-service-type} will
+take care of provisioning dotfiles just like Stow would.
+
+@example
+~$ tree -a ./dotfiles/
+dotfiles/
+??? guile
+? ??? .guile
+??? guix
+? ??? .config
+? ??? guix
+? ??? channels.scm
+??? tmux
+? ??? .tmux.conf
+??? vim
+ ??? .vimrc
+
+@end example
+
+Available @code{home-dotfiles-stow-directory} fields are:
+
+@table @asis
+@item @code{name} (type: string)
+The name of the dotfile directory where
+@code{home-dotfiles-service-type} will look for application dotfiles.
+
+@item @code{applications} (type: maybe-list-of-strings)
+A subset of the names of the application layer directories. When
+provided the @code{home-dotfiles-service-type} will only provision
+dotfiles from this subset of applications.
+
+@end table
+
+@end deftp
+
+
+@c %end of fragment
+
@defvar home-xdg-configuration-files-service-type
The service is very similar to @code{home-files-service-type} (and
actually extends it), but used for defining files, which will go to
diff --git a/gnu/home/services/dotfiles.scm b/gnu/home/services/dotfiles.scm
index 6a740c42ce..ebe9600585 100644
--- a/gnu/home/services/dotfiles.scm
+++ b/gnu/home/services/dotfiles.scm
@@ -20,16 +20,33 @@
(define-module (gnu home services dotfiles)
#:use-module (gnu home services)
#:use-module (gnu services)
+ #:use-module (gnu services configuration)
#:autoload (guix build utils) (find-files)
+ #:use-module (guix diagnostics)
#:use-module (guix gexp)
- #:use-module (guix records)
+ #:use-module (guix i18n)
#:use-module ((guix utils) #:select (current-source-directory))
#:use-module (srfi srfi-1)
#:use-module (ice-9 ftw)
+ #:use-module (ice-9 match)
#:use-module (ice-9 regex)
#:export (home-dotfiles-service-type
+ home-dotfiles-configuration->files
+
+ home-dotfiles-stow-directory
+ home-dotfiles-stow-directory?
+ home-dotfiles-stow-directory-fields
+ home-dotfiles-stow-directory-name
+ home-dotfiles-stow-directory-applications
+
+ home-dotfiles-plain-directory
+ home-dotfiles-plain-directory?
+ home-dotfiles-plain-directory-fields
+ home-dotfiles-plain-directory-name
+
home-dotfiles-configuration
home-dotfiles-configuration?
+ home-dotfiles-configuration-fields
home-dotfiles-configuration-source-directory
home-dotfiles-configuration-directories
home-dotfiles-configuration-excluded))
@@ -40,26 +57,79 @@ (define %home-dotfiles-excluded
"\\.git"
"\\.gitignore"))
-(define-record-type* <home-dotfiles-configuration>
- home-dotfiles-configuration make-home-dotfiles-configuration
- home-dotfiles-configuration?
- (source-directory home-dotfiles-configuration-source-directory
- (default (current-source-directory))
- (innate))
- (directories home-dotfiles-configuration-directories ;list of strings
- (default '()))
- (excluded home-dotfiles-configuration-excluded ;list of strings
- (default %home-dotfiles-excluded)))
-
-(define (import-dotfiles directory files)
+(define list-of-strings?
+ (list-of string?))
+
+(define-maybe list-of-strings)
+
+(define-configuration/no-serialization home-dotfiles-stow-directory
+ (name
+ (string)
+ "The name of the dotfile directory where @code{home-dotfiles-service-type}
+will look for application dotfiles.")
+ (applications
+ (maybe-list-of-strings)
+ "A subset of the names of the application layer directories. When provided
+the @code{home-dotfiles-service-type} will only provision dotfiles from this
+subset of applications."))
+
+(define-configuration/no-serialization home-dotfiles-plain-directory
+ (name
+ (string)
+ "The name of the dotfile directory where @code{home-dotfiles-service-type}
+will look for plain dotfiles."))
+
+(define (list-of-plain-or-stow-directories? value)
+ (unless (list? value)
+ (raise
+ (formatted-message
+ (G_ "directories field of home-dotfiles-configuration should be a list but
+~a was found.")
+ value)))
+ (for-each
+ (lambda (d)
+ (unless (or (home-dotfiles-plain-directory? d)
+ (home-dotfiles-stow-directory? d))
+ (raise
+ (formatted-message
+ (G_ "directories field of home-dotfiles-configuration should contain
+only home-dotfiles-plain-directory or home-dotfiles-stow-directory records, but
+~a was found.")
+ d))))
+ value))
+
+(define-configuration/no-serialization home-dotfiles-configuration
+ (source-directory
+ (string (current-source-directory))
+ "The path where dotfile directories are resolved. By default dotfile
+directories are resolved relative the source location where
+@code{home-dotfiles-configuration} appears.")
+ (directories
+ (list-of-plain-or-stow-directories '())
+ "The list of dotfiles directories where @code{home-dotfiles-service-type}
+will look for application dotfiles. Each element of the list is supposed to be
+either a @code{home-dotfiles-plain-directory} or a
+@code{home-dotfiles-stow-directory} record.")
+ (excluded
+ (list-of-strings %home-dotfiles-excluded)
+ "The list of file patterns @code{home-dotfiles-service-type} will exclude
+while visiting each one of the @code{directories}."))
+
+(define (strip-stow-dotfile file-name directory)
+ (let ((dotfile-name (string-drop file-name (1+ (string-length directory)))))
+ (match (string-split dotfile-name #\/)
+ ((package parts ...)
+ (string-join parts "/")))))
+
+(define (strip-plain-dotfile file-name directory)
+ (string-drop file-name (+ 1 (string-length directory))))
+
+(define (import-dotfiles directory files strip)
"Return a list of objects compatible with @code{home-files-service-type}'s
value. Each object is a pair where the first element is the relative path
of a file and the second is a gexp representing the file content. Objects are
generated by recursively visiting DIRECTORY and mapping its contents to the
user's home directory, excluding files that match any of the patterns in EXCLUDED."
- (define (strip file)
- (string-drop file (+ 1 (string-length directory))))
-
(define (format file)
;; Remove from FILE characters that cannot be used in the store.
(string-append
@@ -73,7 +143,7 @@ (define (format file)
file)))
(map (lambda (file)
- (let ((stripped (strip file)))
+ (let ((stripped (strip file directory)))
(list stripped
(local-file file (format stripped)
#:recursive? #t))))
@@ -88,11 +158,18 @@ (define excluded
(define exclusion-rx
(make-regexp (string-append "^.*(" (string-join excluded "|") ")$")))
- (define (directory-contents directory)
- (find-files directory
- (lambda (file stat)
- (not (regexp-exec exclusion-rx
- (basename file))))))
+ (define* (directory-contents directory #:key (applications #f))
+ (define (filter-files directory)
+ (find-files directory
+ (lambda (file stat)
+ (not (regexp-exec exclusion-rx
+ (basename file))))))
+ (if applications
+ (append-map filter-files
+ (map (lambda (app)
+ (string-append directory "/" app))
+ applications))
+ (filter-files directory)))
(define (resolve directory)
;; Resolve DIRECTORY relative to the 'source-directory' field of CONFIG.
@@ -101,10 +178,24 @@ (define (resolve directory)
(in-vicinity (home-dotfiles-configuration-source-directory config)
directory)))
- (append-map (lambda (directory)
- (let* ((directory (resolve directory))
- (contents (directory-contents directory)))
- (import-dotfiles directory contents)))
+ (append-map (lambda (record)
+ (let* ((name (if (home-dotfiles-plain-directory? record)
+ (home-dotfiles-plain-directory-name record)
+ (home-dotfiles-stow-directory-name record)))
+ (strip (if (home-dotfiles-plain-directory? record)
+ strip-plain-dotfile
+ strip-stow-dotfile))
+ (applications
+ (and (home-dotfiles-stow-directory? record)
+ (let ((apps
+ (home-dotfiles-stow-directory-applications
+ record)))
+ (and (maybe-value-set? apps) apps))))
+ (directory (resolve name))
+ (contents
+ (directory-contents directory
+ #:applications applications)))
+ (import-dotfiles directory contents strip)))
(home-dotfiles-configuration-directories config)))
(define-public home-dotfiles-service-type

base-commit: bd87416648929f38c0173f047776d7675ea8a10d
--
2.41.0
S
S
Sergey Trofimov wrote on 16 Feb 19:57 +0100
Re: [bug#68857] [PATCH] gnu: home: dotfiles: Avoid creating extra directory in $HOME.
(name . paul)(address . goodoldpaul@autistici.org)
87le7kmdpq.fsf@sarg.org.ru
Hi Paul,

paul <goodoldpaul@autistici.org> writes:

Toggle quote (17 lines)
> Hi everyone,
>
> thank you for your help and comments so far. I have a proposal
> that should:
>
> - solve https://issues.guix.gnu.org/68848
>
> - allow for both plain and GNU Stow's layouts
>
> - for GNU Stow layouts, allows to select a subset of application
> dotfiles to be
> provisioned in the user's home directory. Please Sergey let me
> know if this
> covers your use case .
>


My dotfiles tree is (relative to ~/.dotfiles):
./guix/home.scm
./backup/.config/..
./android/.config/..
...

It works with such config:

Toggle snippet (16 lines)
(service home-dotfiles-service-type
(home-dotfiles-configuration
(directories
(list
(home-dotfiles-stow-directory
(name "..")
(applications
'("backup"
"android"
"email"
"xsession"
"git"
"qutebrowser"
"desktop")))))))

`name` is in fact a relative path, so this field should be
renamed.
`applications` are called `PACKAGES` in `stow` man page, so I'd
rename it to match.
L
L
Ludovic Courtès wrote on 20 Feb 10:37 +0100
Re: bug#68857: gnu: home: dotfiles: Avoid creating extra directory in $HOME.
(name . Giacomo Leidi)(address . goodoldpaul@autistici.org)(address . 68857@debbugs.gnu.org)
87msrvmq7v.fsf_-_@gnu.org
Hello Giacomo!

Giacomo Leidi <goodoldpaul@autistici.org> skribis:

Toggle quote (27 lines)
> The current implementation of the home-dotfiles-service-type contradicts
> the Guix manual (see https://issues.guix.gnu.org/68848 ). This patch
> properly implements both the plain and Stow dotfiles directory layouts.
>
> It does so by creating a new record type for each directory layout. This
> approach, compared to having a single field in
> home-dotfiles-configuration,
> allows for having different layouts for different directories and to
> carry additional information that might be required for some layouts.
>
> Implementing a new layout should just be a matter of creating a new
> record type, defining a strip-*-dotfile procedure and plugging them into
> the home-dotfiles-service-type.
>
> * gnu/home/services/dotfiles (home-dotfiles-stow-directory): New
> variable;
> (home-dotfiles-plain-directory): new variable;
> (home-dotfiles-configuration): migrate to (gnu services configuration);
> (strip-stow-dotfile): new variable;
> (strip-plain-dotfile): new variable;
> (home-dotfiles-configuration->files): use the new record types;
> [directory-contents]: allow for
> selecting a subset of application dotfile directories;
> * doc/guix.texi: document the new layouts.
>
> Change-Id: I2e96037608353e360828290f055ec5271cfdfd48

Thanks for working on it!

Toggle quote (21 lines)
> +There are two supported dotfiles directory layouts, for now. The
> +@code{home-dotfiles-plain-directory} layout, which is structured as follows:
> +
> +@example
> +~$ tree -a ./dotfiles/
> +dotfiles/
> +??? .gitconfig
> +??? .gnupg
> +? ??? gpg-agent.conf
> +? ??? gpg.conf
> +??? .guile
> +??? .config
> +? ??? guix
> +? ? ??? channels.scm
> +? ??? nixpkgs
> +? ??? config.nix
> +??? .nix-channels
> +??? .tmux.conf
> +??? .vimrc
> +@end example

I’d add a sentence like: “This tree structure is installed as is to the
home directory upon @command{guix home reconfigure}.”

Toggle quote (19 lines)
> -(define-record-type* <home-dotfiles-configuration>
> - home-dotfiles-configuration make-home-dotfiles-configuration
> - home-dotfiles-configuration?
> - (source-directory home-dotfiles-configuration-source-directory
> - (default (current-source-directory))
> - (innate))
> - (directories home-dotfiles-configuration-directories ;list of strings
> - (default '()))
> - (excluded home-dotfiles-configuration-excluded ;list of strings
> - (default %home-dotfiles-excluded)))
> -
> -(define (import-dotfiles directory files)
> +(define list-of-strings?
> + (list-of string?))
> +
> +(define-maybe list-of-strings)
> +
> +(define-configuration/no-serialization home-dotfiles-stow-directory

[...]

Toggle quote (2 lines)
> +(define-configuration/no-serialization home-dotfiles-configuration

I think we should keep ‘home-dotfiles-configuration’ for compatibility
(this patch keeps the exports but removes the actual
<home-dotfiles-configuration> definition IIUC).

Also, as a rule of thumb, the configuration of a given service type is
usually monomorphic (always the same configuration record type), which I
find clearer.

Instead of having these two record types, would it be an option to add a
‘type’ field (or similar) to <home-dotfiles-configuration>, as discussed
earlier?

Thanks,
Ludo’.
P
P
paul wrote on 20 Feb 19:38 +0100
(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 68857@debbugs.gnu.org)
24f9f59a-79e8-27bc-5fe4-da160ed64187@autistici.org
Hi Ludo’ ,

On 2/20/24 10:37, Ludovic Courtès wrote:
Toggle quote (54 lines)
> Hello Giacomo!
>
> Giacomo Leidi <goodoldpaul@autistici.org> skribis:
>
>> The current implementation of the home-dotfiles-service-type contradicts
>> the Guix manual (see https://issues.guix.gnu.org/68848 ). This patch
>> properly implements both the plain and Stow dotfiles directory layouts.
>>
>> It does so by creating a new record type for each directory layout. This
>> approach, compared to having a single field in
>> home-dotfiles-configuration,
>> allows for having different layouts for different directories and to
>> carry additional information that might be required for some layouts.
>>
>> Implementing a new layout should just be a matter of creating a new
>> record type, defining a strip-*-dotfile procedure and plugging them into
>> the home-dotfiles-service-type.
>>
>> * gnu/home/services/dotfiles (home-dotfiles-stow-directory): New
>> variable;
>> (home-dotfiles-plain-directory): new variable;
>> (home-dotfiles-configuration): migrate to (gnu services configuration);
>> (strip-stow-dotfile): new variable;
>> (strip-plain-dotfile): new variable;
>> (home-dotfiles-configuration->files): use the new record types;
>> [directory-contents]: allow for
>> selecting a subset of application dotfile directories;
>> * doc/guix.texi: document the new layouts.
>>
>> Change-Id: I2e96037608353e360828290f055ec5271cfdfd48
> Thanks for working on it!
>
>> +There are two supported dotfiles directory layouts, for now. The
>> +@code{home-dotfiles-plain-directory} layout, which is structured as follows:
>> +
>> +@example
>> +~$ tree -a ./dotfiles/
>> +dotfiles/
>> +??? .gitconfig
>> +??? .gnupg
>> +? ??? gpg-agent.conf
>> +? ??? gpg.conf
>> +??? .guile
>> +??? .config
>> +? ??? guix
>> +? ? ??? channels.scm
>> +? ??? nixpkgs
>> +? ??? config.nix
>> +??? .nix-channels
>> +??? .tmux.conf
>> +??? .vimrc
>> +@end example
> I’d add a sentence like: “This tree structure is installed as is to the
> home directory upon @command{guix home reconfigure}.”
I'm adding this to the manual, thanks!
Toggle quote (4 lines)
>> +(define-configuration/no-serialization home-dotfiles-configuration
> I think we should keep ‘home-dotfiles-configuration’ for compatibility
> (this patch keeps the exports but removes the actual
> <home-dotfiles-configuration> definition IIUC).
We are keeping home-dotfiles-configuration , it's just now it is
implemented with validation from (gnu services configuration) . The only
thing changing is that home-dotfiles-configuration's directories field
is now a list of either home-dotfiles-plain-directory or
home-dotfiles-stow-directory records.
Toggle quote (8 lines)
> Also, as a rule of thumb, the configuration of a given service type is
> usually monomorphic (always the same configuration record type), which I
> find clearer.
>
> Instead of having these two record types, would it be an option to add a
> ‘type’ field (or similar) to <home-dotfiles-configuration>, as discussed
> earlier?

As I tried explaining in the commit message, this approach, compared to
having a single field in home-dotfiles-configuration , allows for having
different layouts for different directories and to carry additional
information that might be needed for a given layout type. Such as the
application field required to support some Stow's users workflows. What
do you think about this approach? It should be general enough to support
any kind of layout.

Thank you for your time,

giacomo
L
L
Ludovic Courtès wrote on 27 Feb 11:17 +0100
(name . paul)(address . goodoldpaul@autistici.org)(address . 68857@debbugs.gnu.org)
87bk82i53w.fsf_-_@gnu.org
Hi,

paul <goodoldpaul@autistici.org> skribis:

Toggle quote (8 lines)
> As I tried explaining in the commit message, this approach, compared
> to having a single field in home-dotfiles-configuration , allows for
> having different layouts for different directories and to carry
> additional information that might be needed for a given layout
> type. Such as the application field required to support some Stow's
> users workflows. What do you think about this approach? It should be
> general enough to support any kind of layout.

I think we’ll only want to support two layouts: Stow and “plain”; we
should avoid overengineering that. That’s why a simple (layout 'stow)
field seems good enough for me.

WDYT?

Ludo’.
P
P
paul wrote on 27 Feb 12:32 +0100
(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 68857@debbugs.gnu.org)
91b3e9ec-b07d-342b-c525-63c6a4ffc09b@autistici.org
Ah obviously I replied to you with the wrong address
(leidigiacomo@outlook.com) thanks to Thunderbird :( apologies for the
confusion.


giacomo
G
G
Giacomo Leidi wrote on 27 Feb 13:35 +0100
[PATCH v3] gnu: home: dotfiles: Properly support both plain and Stow directory layouts.
(address . 68857@debbugs.gnu.org)(name . Giacomo Leidi)(address . goodoldpaul@autistici.org)
413c752eb714951dfe350517fd0f783710a26386.1709037308.git.goodoldpaul@autistici.org
The current implementation of the home-dotfiles-service-type contradicts
the Guix manual (see https://issues.guix.gnu.org/68848). This patch
properly implements both the plain and Stow dotfiles directory layouts.

It does so by refactoring home-dotfiles-configuration, renaming the
directories field to a single directory, adding a new packages field to
support GNU Stow's users workflow and introducing a new layout field to
switch between the two directory layouts.

* gnu/home/services/dotfiles (home-dotfiles-configuration): Migrate to
(gnu services configuration);
[directories]: rename to...;
[directory]: ...this, new field;
[packages]: new field;
[layout]: new field;
(strip-stow-dotfile): new variable;
(strip-plain-dotfile): new variable;
(home-dotfiles-configuration->files): use the new fields;
[directory-contents]: allow for
selecting a subset of application dotfile directories;
* doc/guix.texi: document the new layouts.

Change-Id: I2e96037608353e360828290f055ec5271cfdfd48
---
doc/guix.texi | 84 ++++++++++++++++------
gnu/home/services/dotfiles.scm | 123 ++++++++++++++++++++++++---------
2 files changed, 154 insertions(+), 53 deletions(-)

Toggle diff (333 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index f6476e0d81..89f9887fe3 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -111,7 +111,7 @@
Copyright @copyright{} 2022 John Kehayias@*
Copyright @copyright{} 2022?–?2023 Bruno Victal@*
Copyright @copyright{} 2022 Ivan Vilata-i-Balaguer@*
-Copyright @copyright{} 2023 Giacomo Leidi@*
+Copyright @copyright{} 2023-2024 Giacomo Leidi@*
Copyright @copyright{} 2022 Antero Mejr@*
Copyright @copyright{} 2023 Karl Hallsby@*
Copyright @copyright{} 2023 Nathaniel Nicandro@*
@@ -44444,17 +44444,42 @@ Essential Home Services
@cindex Stow-like dot file management
The @code{home-dotfiles-service-type} from @code{(gnu home services dotfiles)}
is designed to ease the way into using Guix Home for this kind of users,
-allowing them to point the service to their dotfiles directory, which must
-follow the layout suggested by
-@uref{https://www.gnu.org/software/stow/, GNU Stow},
-and have their dotfiles automatically deployed to their user home, without
+allowing them to point the service to their dotfiles directory without
migrating them to Guix native configurations.
-The dotfiles directory layout is expected to be structured as follows. Please
-keep in mind that it is advisable to keep your dotfiles directories under
+Please keep in mind that it is advisable to keep your dotfiles directories under
version control, for example in the same repository where you'd track your
Guix Home configuration.
+There are two supported dotfiles directory layouts, for now. The
+@code{'plain} layout, which is structured as follows:
+
+@example
+~$ tree -a ./dotfiles/
+dotfiles/
+??? .gitconfig
+??? .gnupg
+? ??? gpg-agent.conf
+? ??? gpg.conf
+??? .guile
+??? .config
+? ??? guix
+? ? ??? channels.scm
+? ??? nixpkgs
+? ??? config.nix
+??? .nix-channels
+??? .tmux.conf
+??? .vimrc
+@end example
+
+This tree structure is installed as is to the
+home directory upon @command{guix home reconfigure}.
+
+The @code{'stow} layout, which must
+follow the layout suggested by
+@uref{https://www.gnu.org/software/stow/, GNU Stow} presents an additional
+application specific directory layer, just like:
+
@example
~$ tree -a ./dotfiles/
dotfiles/
@@ -44484,8 +44509,10 @@ Essential Home Services
@end example
For an informal specification please refer to the Stow manual
-(@pxref{Top,,, stow, Introduction}). A suitable configuration would then
-be:
+(@pxref{Top,,, stow, Introduction}). This tree structure is installed following
+GNU Stow's logic to the home directory upon @command{guix home reconfigure}.
+
+A suitable configuration with a @code{'plain} layout could be:
@lisp
(home-environment
@@ -44493,7 +44520,7 @@ Essential Home Services
(services
(service home-dotfiles-service-type
(home-dotfiles-configuration
- (directories (list "./dotfiles"))))))
+ (directory "./dotfiles")))))
@end lisp
The expected home directory state would then be:
@@ -44520,32 +44547,47 @@ Essential Home Services
(and actually extends it), but designed to ease the way into using Guix
Home for users that already track their dotfiles under some kind of version
control. This service allows users to point Guix Home to their dotfiles
-directory and have their files automatically deployed to their home directory
-just like Stow would, without migrating all of their dotfiles to Guix native
+directory and have their files automatically provisioned to their home
+directory, without migrating all of their dotfiles to Guix native
configurations.
@end defvar
+@c %start of fragment
+
@deftp {Data Type} home-dotfiles-configuration
Available @code{home-dotfiles-configuration} fields are:
@table @asis
-@item @code{source-directory} (default: @code{(current-source-directory)})
-The path where dotfile directories are resolved. By default dotfile directories
-are resolved relative the source location where
+@item @code{source-directory} (default: @code{(current-source-directory)}) (type: string)
+The path where dotfile directories are resolved. By default dotfile
+directories are resolved relative the source location where
@code{home-dotfiles-configuration} appears.
-@item @code{directories} (type: list-of-strings)
-The list of dotfiles directories where @code{home-dotfiles-service-type} will
-look for application dotfiles.
+@item @code{layout} (default: @code{'plain}) (type: symbol)
+The intended layout of the specified @code{directory}. It can be either
+@code{'stow} or @code{'plain}.
+
+@item @code{directory} (type: string)
+The dotfiles directory where @code{home-dotfiles-service-type}
+will look for application dotfiles.
+
+@item @code{packages} (type: maybe-list-of-strings)
+The names of a subset of the GNU Stow package layer directories. When provided
+the @code{home-dotfiles-service-type} will only provision dotfiles from this
+subset of applications. This field will be ignored if @code{layout} is set
+to @code{'plain}.
-@item @code{exclude} (default: @code{'(".*~" ".*\\.swp" "\\.git" "\\.gitignore")})
-The list of file patterns @code{home-dotfiles-service-type} will exclude while
-visiting each one of the @code{directories}.
+@item @code{excluded} (default: @code{'(".*~" ".*\\.swp" "\\.git" "\\.gitignore")}) (type: list-of-strings)
+The list of file patterns @code{home-dotfiles-service-type} will exclude
+while visiting each one of the @code{directories}.
@end table
@end deftp
+
+@c %end of fragment
+
@defvar home-xdg-configuration-files-service-type
The service is very similar to @code{home-files-service-type} (and
actually extends it), but used for defining files, which will go to
diff --git a/gnu/home/services/dotfiles.scm b/gnu/home/services/dotfiles.scm
index 6a740c42ce..c7886e3763 100644
--- a/gnu/home/services/dotfiles.scm
+++ b/gnu/home/services/dotfiles.scm
@@ -20,18 +20,26 @@
(define-module (gnu home services dotfiles)
#:use-module (gnu home services)
#:use-module (gnu services)
+ #:use-module (gnu services configuration)
#:autoload (guix build utils) (find-files)
+ #:use-module (guix diagnostics)
#:use-module (guix gexp)
- #:use-module (guix records)
+ #:use-module (guix i18n)
#:use-module ((guix utils) #:select (current-source-directory))
#:use-module (srfi srfi-1)
#:use-module (ice-9 ftw)
+ #:use-module (ice-9 match)
#:use-module (ice-9 regex)
#:export (home-dotfiles-service-type
+ home-dotfiles-configuration->files
+
home-dotfiles-configuration
home-dotfiles-configuration?
+ home-dotfiles-configuration-fields
+ home-dotfiles-configuration-layout
home-dotfiles-configuration-source-directory
- home-dotfiles-configuration-directories
+ home-dotfiles-configuration-packages
+ home-dotfiles-configuration-directory
home-dotfiles-configuration-excluded))
(define %home-dotfiles-excluded
@@ -40,26 +48,64 @@ (define %home-dotfiles-excluded
"\\.git"
"\\.gitignore"))
-(define-record-type* <home-dotfiles-configuration>
- home-dotfiles-configuration make-home-dotfiles-configuration
- home-dotfiles-configuration?
- (source-directory home-dotfiles-configuration-source-directory
- (default (current-source-directory))
- (innate))
- (directories home-dotfiles-configuration-directories ;list of strings
- (default '()))
- (excluded home-dotfiles-configuration-excluded ;list of strings
- (default %home-dotfiles-excluded)))
-
-(define (import-dotfiles directory files)
+(define %home-dotfiles-layouts
+ '(plain stow))
+
+(define (sanitize-layout value)
+ (if (member value %home-dotfiles-layouts)
+ value
+ (raise
+ (formatted-message
+ (G_ "layout field of home-dotfiles-configuration should be either 'plain
+or 'stow, but ~a was found.")
+ value))))
+
+(define list-of-strings?
+ (list-of string?))
+
+(define-maybe list-of-strings)
+
+(define-configuration/no-serialization home-dotfiles-configuration
+ (source-directory
+ (string (current-source-directory))
+ "The path where dotfile directories are resolved. By default dotfile
+directories are resolved relative the source location where
+@code{home-dotfiles-configuration} appears.")
+ (layout
+ (symbol 'plain)
+ "The intended layout of the specified @code{directory}. It can be either
+@code{'stow} or @code{'plain}."
+ (sanitizer sanitize-layout))
+ (directory
+ (string)
+ "The dotfiles directory where @code{home-dotfiles-service-type}
+will look for application dotfiles.")
+ (packages
+ (maybe-list-of-strings)
+ "The names of a subset of the GNU Stow package layer directories. When provided
+the @code{home-dotfiles-service-type} will only provision dotfiles from this
+subset of applications. This field will be ignored if @code{layout} is set
+to @code{'plain}.")
+ (excluded
+ (list-of-strings %home-dotfiles-excluded)
+ "The list of file patterns @code{home-dotfiles-service-type} will exclude
+while visiting @code{directory}."))
+
+(define (strip-stow-dotfile file-name directory)
+ (let ((dotfile-name (string-drop file-name (1+ (string-length directory)))))
+ (match (string-split dotfile-name #\/)
+ ((package parts ...)
+ (string-join parts "/")))))
+
+(define (strip-plain-dotfile file-name directory)
+ (string-drop file-name (+ 1 (string-length directory))))
+
+(define (import-dotfiles directory files strip)
"Return a list of objects compatible with @code{home-files-service-type}'s
value. Each object is a pair where the first element is the relative path
of a file and the second is a gexp representing the file content. Objects are
generated by recursively visiting DIRECTORY and mapping its contents to the
user's home directory, excluding files that match any of the patterns in EXCLUDED."
- (define (strip file)
- (string-drop file (+ 1 (string-length directory))))
-
(define (format file)
;; Remove from FILE characters that cannot be used in the store.
(string-append
@@ -73,7 +119,7 @@ (define (import-dotfiles directory files)
file)))
(map (lambda (file)
- (let ((stripped (strip file)))
+ (let ((stripped (strip file directory)))
(list stripped
(local-file file (format stripped)
#:recursive? #t))))
@@ -81,18 +127,25 @@ (define (import-dotfiles directory files)
(define (home-dotfiles-configuration->files config)
"Return a list of objects compatible with @code{home-files-service-type}'s
-value, generated following GNU Stow's algorithm for each of the
-directories in CONFIG, excluding files that match any of the patterns configured."
+value, excluding files that match any of the patterns configured."
+ (define stow? (eq? (home-dotfiles-configuration-layout config) 'stow))
(define excluded
(home-dotfiles-configuration-excluded config))
(define exclusion-rx
(make-regexp (string-append "^.*(" (string-join excluded "|") ")$")))
- (define (directory-contents directory)
- (find-files directory
- (lambda (file stat)
- (not (regexp-exec exclusion-rx
- (basename file))))))
+ (define* (directory-contents directory #:key (packages #f))
+ (define (filter-files directory)
+ (find-files directory
+ (lambda (file stat)
+ (not (regexp-exec exclusion-rx
+ (basename file))))))
+ (if (and stow? packages (maybe-value-set? packages))
+ (append-map filter-files
+ (map (lambda (pkg)
+ (string-append directory "/" pkg))
+ packages))
+ (filter-files directory)))
(define (resolve directory)
;; Resolve DIRECTORY relative to the 'source-directory' field of CONFIG.
@@ -101,17 +154,23 @@ (define (home-dotfiles-configuration->files config)
(in-vicinity (home-dotfiles-configuration-source-directory config)
directory)))
- (append-map (lambda (directory)
- (let* ((directory (resolve directory))
- (contents (directory-contents directory)))
- (import-dotfiles directory contents)))
- (home-dotfiles-configuration-directories config)))
+ (let* ((directory (resolve (home-dotfiles-configuration-directory config)))
+ (packages
+ (home-dotfiles-configuration-packages config))
+ (contents
+ (directory-contents directory
+ #:packages packages))
+ (strip
+ (if stow? strip-stow-dotfile strip-plain-dotfile)))
+ (import-dotfiles directory contents strip)))
(define-public home-dotfiles-service-type
(service-type (name 'home-dotfiles)
(extensions
(list (service-extension home-files-service-type
- home-dotfiles-configuration->files)))
- (default-value (home-dotfiles-configuration))
+ (lambda (config)
+ (when config
+ (home-dotfiles-configuration->files config))))))
+ (default-value #f)
(description "Files that will be put in the user's home directory
following GNU Stow's algorithm, and further processed during activation.")))

base-commit: 75bad75367fcf2c289fae3b40dbcc850f92177be
--
2.41.0
G
G
Giacomo Leidi wrote on 27 Feb 12:30 +0100
Re: [bug#68857] gnu: home: dotfiles: Avoid creating extra directory in $HOME.
(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 68857@debbugs.gnu.org)
AM8P189MB13961838B34C0483F3B2E9E9D0592@AM8P189MB1396.EURP189.PROD.OUTLOOK.COM
Hi Ludo' ,

First of all thank you for putting the time for working on this, I hope
we are close to a solution :)

On 2/27/24 11:17, Ludovic Courtès wrote:
Toggle quote (6 lines)
> I think we’ll only want to support two layouts: Stow and “plain”; we
> should avoid overengineering that. That’s why a simple (layout 'stow)
> field seems good enough for me.
>
> WDYT?

I think it is important, if the effort is feasible, to not leave anyone
behind (in terms of what the features of this service are) . Having a
single field without further changes will introduce some ambiguity imo.
We have these requirements in my understanding:

1. The service should support Stow's users workflows. This is a hard
requirement in my opinion. Hence we need a way to select a subset
the applications directories (the applications field of
home-dotfiles-stow-directory in v2 of the patch).
2. The service should support Stow's users workflows. This is also a
hard requirement. For this we just need the path of the dotfiles
directory.
3. The service should support multiple dotfiles directories. This is
not a hard requirement i believe, but we currently have this feature
(the directories field of home-dotfiles-configuration is a list of
strings not a string).

Introducing a single layout field makes it impossible to unambiguously
implement requirement 1. If the user has more than directory it really
makes no sense to select the same subset of applications for each one of
them. This is to say that I believe it makes little sense to have
multiple directories if the layout and applications information are not
linked somehow with each directory. I wouldn't call this
overengineering, just implementing the features users need from this
service. I hope you agree.

Also since I first sent this service around Jan 2023 (when it was still
the home-stow-migration-service), and it has been broken on master for
some time I'd like to provide a fix for this situation as soon as
possible (clearly the definition of brokennes and what changes to the
API would be breaking user configs depends on the requirements one
intends for the home-dotfiles-service-type, especially since the changes
that broke master were introduced without consensus).

I'm changing the code to: use the layout field, support Stow's users
workflow adding a new optional field called packages, which makes sense
only if the layout is 'stow, and I'm making the directories field a
string instead of a list of strings. Please let me know your thoughts on
this v3.


Thank your for your work,


giacomo
Attachment: file
L
L
Ludovic Courtès wrote on 4 Mar 16:46 +0100
Re: bug#68857: gnu: home: dotfiles: Avoid creating extra directory in $HOME.
(name . Giacomo Leidi)(address . goodoldpaul@autistici.org)
87bk7uf19g.fsf_-_@gnu.org
Hi,

Giacomo Leidi <goodoldpaul@autistici.org> skribis:

Toggle quote (24 lines)
> The current implementation of the home-dotfiles-service-type contradicts
> the Guix manual (see https://issues.guix.gnu.org/68848 ). This patch
> properly implements both the plain and Stow dotfiles directory layouts.
>
> It does so by refactoring home-dotfiles-configuration, renaming the
> directories field to a single directory, adding a new packages field to
> support GNU Stow's users workflow and introducing a new layout field to
> switch between the two directory layouts.
>
> * gnu/home/services/dotfiles (home-dotfiles-configuration): Migrate to
> (gnu services configuration);
> [directories]: rename to...;
> [directory]: ...this, new field;
> [packages]: new field;
> [layout]: new field;
> (strip-stow-dotfile): new variable;
> (strip-plain-dotfile): new variable;
> (home-dotfiles-configuration->files): use the new fields;
> [directory-contents]: allow for
> selecting a subset of application dotfile directories;
> * doc/guix.texi: document the new layouts.
>
> Change-Id: I2e96037608353e360828290f055ec5271cfdfd48

LGTM, but…

Toggle quote (3 lines)
> - (directories home-dotfiles-configuration-directories ;list of strings
> - (default '()))

[...]

Toggle quote (5 lines)
> + (directory
> + (string)
> + "The dotfiles directory where @code{home-dotfiles-service-type}
> +will look for application dotfiles.")

This is an incompatible change. Can we keep the old ‘directories’
field?

(Maybe this change is worthwhile, but it’s beyond the scope of this
patch series IMO, so I’d suggest discussing it separately.)

Toggle quote (11 lines)
> (define-public home-dotfiles-service-type
> (service-type (name 'home-dotfiles)
> (extensions
> (list (service-extension home-files-service-type
> - home-dotfiles-configuration->files)))
> - (default-value (home-dotfiles-configuration))
> + (lambda (config)
> + (when config
> + (home-dotfiles-configuration->files config))))))
> + (default-value #f)

Better not provide a default value than provide one that is invalid. My
suggestion would be to remove the ‘default-value’ field here.

Apologies for the delays and thanks for your work and for your patience!

Ludo’.
P
P
paul wrote on 6 Mar 21:51 +0100
(name . Ludovic Courtès)(address . ludo@gnu.org)
01faf36b-11a8-4cd4-7d15-89b6dd072a96@autistici.org
Hi Ludo ,

I should have addressed everything, I hope. Thank you again for your
time reviewing this.

I'm sending a  v4.


giacomo
G
G
Giacomo Leidi wrote on 6 Mar 21:52 +0100
[PATCH v4] gnu: home: dotfiles: Properly support both plain and Stow directory layouts.
(address . 68857@debbugs.gnu.org)(name . Giacomo Leidi)(address . goodoldpaul@autistici.org)
a1ad5e20a171804eea603bc33cde2e0f4a86b113.1709758362.git.goodoldpaul@autistici.org
The current implementation of the home-dotfiles-service-type contradicts
the Guix manual (see https://issues.guix.gnu.org/68848). This patch
properly implements both the plain and Stow dotfiles directory layouts.

It does so by refactoring home-dotfiles-configuration adding a new
packages field to support GNU Stow's users workflow and introducing
a new layout field to switch between the two directory layouts.

* gnu/home/services/dotfiles (home-dotfiles-configuration): Migrate to
(gnu services configuration);
[packages]: new field;
[layout]: new field;
(strip-stow-dotfile): new variable;
(strip-plain-dotfile): new variable;
(home-dotfiles-configuration->files): use the new fields;
[directory-contents]: allow for
selecting a subset of application dotfile directories;
* doc/guix.texi: document the new layouts.

Change-Id: I2e96037608353e360828290f055ec5271cfdfd48
---
doc/guix.texi | 84 ++++++++++++++++++------
gnu/home/services/dotfiles.scm | 115 +++++++++++++++++++++++++--------
2 files changed, 151 insertions(+), 48 deletions(-)

Toggle diff (327 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index 87fe9f803c..8a33c4aa55 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -111,7 +111,7 @@
Copyright @copyright{} 2022 John Kehayias@*
Copyright @copyright{} 2022?–?2023 Bruno Victal@*
Copyright @copyright{} 2022 Ivan Vilata-i-Balaguer@*
-Copyright @copyright{} 2023 Giacomo Leidi@*
+Copyright @copyright{} 2023-2024 Giacomo Leidi@*
Copyright @copyright{} 2022 Antero Mejr@*
Copyright @copyright{} 2023 Karl Hallsby@*
Copyright @copyright{} 2023 Nathaniel Nicandro@*
@@ -44667,17 +44667,42 @@ Essential Home Services
@cindex Stow-like dot file management
The @code{home-dotfiles-service-type} from @code{(gnu home services dotfiles)}
is designed to ease the way into using Guix Home for this kind of users,
-allowing them to point the service to their dotfiles directory, which must
-follow the layout suggested by
-@uref{https://www.gnu.org/software/stow/, GNU Stow},
-and have their dotfiles automatically deployed to their user home, without
+allowing them to point the service to their dotfiles directory without
migrating them to Guix native configurations.
-The dotfiles directory layout is expected to be structured as follows. Please
-keep in mind that it is advisable to keep your dotfiles directories under
+Please keep in mind that it is advisable to keep your dotfiles directories under
version control, for example in the same repository where you'd track your
Guix Home configuration.
+There are two supported dotfiles directory layouts, for now. The
+@code{'plain} layout, which is structured as follows:
+
+@example
+~$ tree -a ./dotfiles/
+dotfiles/
+??? .gitconfig
+??? .gnupg
+? ??? gpg-agent.conf
+? ??? gpg.conf
+??? .guile
+??? .config
+? ??? guix
+? ? ??? channels.scm
+? ??? nixpkgs
+? ??? config.nix
+??? .nix-channels
+??? .tmux.conf
+??? .vimrc
+@end example
+
+This tree structure is installed as is to the
+home directory upon @command{guix home reconfigure}.
+
+The @code{'stow} layout, which must
+follow the layout suggested by
+@uref{https://www.gnu.org/software/stow/, GNU Stow} presents an additional
+application specific directory layer, just like:
+
@example
~$ tree -a ./dotfiles/
dotfiles/
@@ -44707,8 +44732,10 @@ Essential Home Services
@end example
For an informal specification please refer to the Stow manual
-(@pxref{Top,,, stow, Introduction}). A suitable configuration would then
-be:
+(@pxref{Top,,, stow, Introduction}). This tree structure is installed following
+GNU Stow's logic to the home directory upon @command{guix home reconfigure}.
+
+A suitable configuration with a @code{'plain} layout could be:
@lisp
(home-environment
@@ -44716,7 +44743,7 @@ Essential Home Services
(services
(service home-dotfiles-service-type
(home-dotfiles-configuration
- (directories (list "./dotfiles"))))))
+ (directories '("./dotfiles"))))))
@end lisp
The expected home directory state would then be:
@@ -44743,32 +44770,47 @@ Essential Home Services
(and actually extends it), but designed to ease the way into using Guix
Home for users that already track their dotfiles under some kind of version
control. This service allows users to point Guix Home to their dotfiles
-directory and have their files automatically deployed to their home directory
-just like Stow would, without migrating all of their dotfiles to Guix native
+directory and have their files automatically provisioned to their home
+directory, without migrating all of their dotfiles to Guix native
configurations.
@end defvar
+@c %start of fragment
+
@deftp {Data Type} home-dotfiles-configuration
Available @code{home-dotfiles-configuration} fields are:
@table @asis
-@item @code{source-directory} (default: @code{(current-source-directory)})
-The path where dotfile directories are resolved. By default dotfile directories
-are resolved relative the source location where
+@item @code{source-directory} (default: @code{(current-source-directory)}) (type: string)
+The path where dotfile directories are resolved. By default dotfile
+directories are resolved relative the source location where
@code{home-dotfiles-configuration} appears.
-@item @code{directories} (type: list-of-strings)
-The list of dotfiles directories where @code{home-dotfiles-service-type} will
-look for application dotfiles.
+@item @code{layout} (default: @code{'plain}) (type: symbol)
+The intended layout of the specified @code{directory}. It can be either
+@code{'stow} or @code{'plain}.
+
+@item @code{directories} (default: @code{'()}) (type: list-of-strings)
+The list of dotfiles directories where @code{home-dotfiles-service-type}
+will look for application dotfiles.
+
+@item @code{packages} (type: maybe-list-of-strings)
+The names of a subset of the GNU Stow package layer directories. When provided
+the @code{home-dotfiles-service-type} will only provision dotfiles from this
+subset of applications. This field will be ignored if @code{layout} is set
+to @code{'plain}.
-@item @code{exclude} (default: @code{'(".*~" ".*\\.swp" "\\.git" "\\.gitignore")})
-The list of file patterns @code{home-dotfiles-service-type} will exclude while
-visiting each one of the @code{directories}.
+@item @code{excluded} (default: @code{'(".*~" ".*\\.swp" "\\.git" "\\.gitignore")}) (type: list-of-strings)
+The list of file patterns @code{home-dotfiles-service-type} will exclude
+while visiting each one of the @code{directories}.
@end table
@end deftp
+
+@c %end of fragment
+
@defvar home-xdg-configuration-files-service-type
The service is very similar to @code{home-files-service-type} (and
actually extends it), but used for defining files, which will go to
diff --git a/gnu/home/services/dotfiles.scm b/gnu/home/services/dotfiles.scm
index 6a740c42ce..823bdb03fb 100644
--- a/gnu/home/services/dotfiles.scm
+++ b/gnu/home/services/dotfiles.scm
@@ -20,17 +20,25 @@
(define-module (gnu home services dotfiles)
#:use-module (gnu home services)
#:use-module (gnu services)
+ #:use-module (gnu services configuration)
#:autoload (guix build utils) (find-files)
+ #:use-module (guix diagnostics)
#:use-module (guix gexp)
- #:use-module (guix records)
+ #:use-module (guix i18n)
#:use-module ((guix utils) #:select (current-source-directory))
#:use-module (srfi srfi-1)
#:use-module (ice-9 ftw)
+ #:use-module (ice-9 match)
#:use-module (ice-9 regex)
#:export (home-dotfiles-service-type
+ home-dotfiles-configuration->files
+
home-dotfiles-configuration
home-dotfiles-configuration?
+ home-dotfiles-configuration-fields
+ home-dotfiles-configuration-layout
home-dotfiles-configuration-source-directory
+ home-dotfiles-configuration-packages
home-dotfiles-configuration-directories
home-dotfiles-configuration-excluded))
@@ -40,26 +48,64 @@ (define %home-dotfiles-excluded
"\\.git"
"\\.gitignore"))
-(define-record-type* <home-dotfiles-configuration>
- home-dotfiles-configuration make-home-dotfiles-configuration
- home-dotfiles-configuration?
- (source-directory home-dotfiles-configuration-source-directory
- (default (current-source-directory))
- (innate))
- (directories home-dotfiles-configuration-directories ;list of strings
- (default '()))
- (excluded home-dotfiles-configuration-excluded ;list of strings
- (default %home-dotfiles-excluded)))
-
-(define (import-dotfiles directory files)
+(define %home-dotfiles-layouts
+ '(plain stow))
+
+(define (sanitize-layout value)
+ (if (member value %home-dotfiles-layouts)
+ value
+ (raise
+ (formatted-message
+ (G_ "layout field of home-dotfiles-configuration should be either 'plain
+or 'stow, but ~a was found.")
+ value))))
+
+(define list-of-strings?
+ (list-of string?))
+
+(define-maybe list-of-strings)
+
+(define-configuration/no-serialization home-dotfiles-configuration
+ (source-directory
+ (string (current-source-directory))
+ "The path where dotfile directories are resolved. By default dotfile
+directories are resolved relative the source location where
+@code{home-dotfiles-configuration} appears.")
+ (layout
+ (symbol 'plain)
+ "The intended layout of the specified @code{directory}. It can be either
+@code{'stow} or @code{'plain}."
+ (sanitizer sanitize-layout))
+ (directories
+ (list-of-strings '())
+ "The list of dotfiles directories where @code{home-dotfiles-service-type}
+will look for application dotfiles.")
+ (packages
+ (maybe-list-of-strings)
+ "The names of a subset of the GNU Stow package layer directories. When provided
+the @code{home-dotfiles-service-type} will only provision dotfiles from this
+subset of applications. This field will be ignored if @code{layout} is set
+to @code{'plain}.")
+ (excluded
+ (list-of-strings %home-dotfiles-excluded)
+ "The list of file patterns @code{home-dotfiles-service-type} will exclude
+while visiting @code{directory}."))
+
+(define (strip-stow-dotfile file-name directory)
+ (let ((dotfile-name (string-drop file-name (1+ (string-length directory)))))
+ (match (string-split dotfile-name #\/)
+ ((package parts ...)
+ (string-join parts "/")))))
+
+(define (strip-plain-dotfile file-name directory)
+ (string-drop file-name (+ 1 (string-length directory))))
+
+(define (import-dotfiles directory files strip)
"Return a list of objects compatible with @code{home-files-service-type}'s
value. Each object is a pair where the first element is the relative path
of a file and the second is a gexp representing the file content. Objects are
generated by recursively visiting DIRECTORY and mapping its contents to the
user's home directory, excluding files that match any of the patterns in EXCLUDED."
- (define (strip file)
- (string-drop file (+ 1 (string-length directory))))
-
(define (format file)
;; Remove from FILE characters that cannot be used in the store.
(string-append
@@ -73,7 +119,7 @@ (define (import-dotfiles directory files)
file)))
(map (lambda (file)
- (let ((stripped (strip file)))
+ (let ((stripped (strip file directory)))
(list stripped
(local-file file (format stripped)
#:recursive? #t))))
@@ -81,18 +127,25 @@ (define (import-dotfiles directory files)
(define (home-dotfiles-configuration->files config)
"Return a list of objects compatible with @code{home-files-service-type}'s
-value, generated following GNU Stow's algorithm for each of the
-directories in CONFIG, excluding files that match any of the patterns configured."
+value, excluding files that match any of the patterns configured."
+ (define stow? (eq? (home-dotfiles-configuration-layout config) 'stow))
(define excluded
(home-dotfiles-configuration-excluded config))
(define exclusion-rx
(make-regexp (string-append "^.*(" (string-join excluded "|") ")$")))
- (define (directory-contents directory)
- (find-files directory
- (lambda (file stat)
- (not (regexp-exec exclusion-rx
- (basename file))))))
+ (define* (directory-contents directory #:key (packages #f))
+ (define (filter-files directory)
+ (find-files directory
+ (lambda (file stat)
+ (not (regexp-exec exclusion-rx
+ (basename file))))))
+ (if (and stow? packages (maybe-value-set? packages))
+ (append-map filter-files
+ (map (lambda (pkg)
+ (string-append directory "/" pkg))
+ packages))
+ (filter-files directory)))
(define (resolve directory)
;; Resolve DIRECTORY relative to the 'source-directory' field of CONFIG.
@@ -103,15 +156,23 @@ (define (home-dotfiles-configuration->files config)
(append-map (lambda (directory)
(let* ((directory (resolve directory))
- (contents (directory-contents directory)))
- (import-dotfiles directory contents)))
+ (packages
+ (home-dotfiles-configuration-packages config))
+ (contents
+ (directory-contents directory
+ #:packages packages))
+ (strip
+ (if stow? strip-stow-dotfile strip-plain-dotfile)))
+ (import-dotfiles directory contents strip)))
(home-dotfiles-configuration-directories config)))
(define-public home-dotfiles-service-type
(service-type (name 'home-dotfiles)
(extensions
(list (service-extension home-files-service-type
- home-dotfiles-configuration->files)))
+ (lambda (config)
+ (when config
+ (home-dotfiles-configuration->files config))))))
(default-value (home-dotfiles-configuration))
(description "Files that will be put in the user's home directory
following GNU Stow's algorithm, and further processed during activation.")))

base-commit: f18d13b5f89c161c6ee88d15ecdaa8d973ee4503
--
2.41.0
L
L
Ludovic Courtès wrote on 6 Mar 23:15 +0100
Re: bug#68857: gnu: home: dotfiles: Avoid creating extra directory in $HOME.
(name . Giacomo Leidi)(address . goodoldpaul@autistici.org)
87v85z6m8o.fsf_-_@gnu.org
Hi,

Giacomo Leidi <goodoldpaul@autistici.org> skribis:

Toggle quote (21 lines)
> The current implementation of the home-dotfiles-service-type contradicts
> the Guix manual (see https://issues.guix.gnu.org/68848 ). This patch
> properly implements both the plain and Stow dotfiles directory layouts.
>
> It does so by refactoring home-dotfiles-configuration adding a new
> packages field to support GNU Stow's users workflow and introducing
> a new layout field to switch between the two directory layouts.
>
> * gnu/home/services/dotfiles (home-dotfiles-configuration): Migrate to
> (gnu services configuration);
> [packages]: new field;
> [layout]: new field;
> (strip-stow-dotfile): new variable;
> (strip-plain-dotfile): new variable;
> (home-dotfiles-configuration->files): use the new fields;
> [directory-contents]: allow for
> selecting a subset of application dotfile directories;
> * doc/guix.texi: document the new layouts.
>
> Change-Id: I2e96037608353e360828290f055ec5271cfdfd48

Applied, thanks again!

Ludo’.
Closed
?