diff mbox series

[bug#58652] Creating home-emacs-service-type

Message ID CAH+UbWQRoqsgSWpFyb5xjvGsepp0mG86W6g_a4SU04yHFc_mgw@mail.gmail.com
State New
Headers show
Series [bug#58652] Creating home-emacs-service-type | expand

Checks

Context Check Description
cbaines/applying patch fail View Laminar job
cbaines/issue success View issue

Commit Message

Zain Jabbar Oct. 20, 2022, 1:59 a.m. UTC
Aloha Guix Development Team,

First submission of a patch to this mail service. Hopefully this
works. I welcome any and all feedback.

Attached is a patch which creates a new file
=/gnu/home/services/emacs.scm= which defines a new service
=home-emacs-service-type= and a configuration for said service
=home-emacs-configuration=. The configuration contains a list of
packages to add to the home-profile, and a list of expressions to add
into Emacs' =init.el= and =early-init.el=.

Here is an example of a home environment file which:

Adds the following packages:
- =bash=
- =emacs-next=
- =emacs-debbugs=
- =emacs-evil=
- =emacs-paredit=
- =emacs-anzu=

Overwrites the =.config/emacs/init.el= with:
#+BEGIN_SRC emacs-lisp
(evil-mode 1)
#+END_SRC

Overwrites the =.config/emacs/early-init.el= with:
#+BEGIN_SRC emacs-lisp
(setq warning-suppress-log-types '((comp) (comp))) (setq
warning-suppress-types '((comp) (comp)))
#+END_SRC

#+BEGIN_SRC scheme
(use-modules (gnu home services emacs)
     (gnu home)
     (gnu packages)
     (ice-9 pretty-print)
     (gnu services))

(define-public minimal-home-environment
  (home-environment
   (services
    (list
     (service home-emacs-service-type
      (home-emacs-configuration
       (packages
(list
(specification->package "bash")
(specification->package "emacs-next")
(specification->package "emacs-debbugs")
(specification->package "emacs-evil")
(specification->package "emacs-paredit")
(specification->package "emacs-anzu")))
       (init '((evil-mode 1)))
       (early-init '((setq warning-suppress-log-types '((comp) (comp)))
     (setq warning-suppress-types '((comp) (comp)))))))))))

minimal-home-environment
#+END_SRC

Saving this text into a file =minimal-working-example.scm= allows us
to run this configuration with =guix home -N --share=/tmp container
./minimal-working-example.scm=.

Comments

Liliana Marie Prikler Oct. 20, 2022, 12:53 p.m. UTC | #1
Am Mittwoch, dem 19.10.2022 um 15:59 -1000 schrieb Zain Jabbar:
> Aloha Guix Development Team,
> 
> First submission of a patch to this mail service. Hopefully this
> works. I welcome any and all feedback.
> 
> Attached is a patch which creates a new file
> =/gnu/home/services/emacs.scm= which defines a new service
> =home-emacs-service-type= and a configuration for said service
> =home-emacs-configuration=. The configuration contains a list of
> packages to add to the home-profile, and a list of expressions to add
> into Emacs' =init.el= and =early-init.el=.
Note that you reverted the patch direction.

> Here is an example of a home environment file which:
> 
> Adds the following packages:
> - =bash=
> - =emacs-next=
> - =emacs-debbugs=
> - =emacs-evil=
> - =emacs-paredit=
> - =emacs-anzu=
> 
> Overwrites the =.config/emacs/init.el= with:
> #+BEGIN_SRC emacs-lisp
> (evil-mode 1)
> #+END_SRC
> 
> Overwrites the =.config/emacs/early-init.el= with:
> #+BEGIN_SRC emacs-lisp
> (setq warning-suppress-log-types '((comp) (comp))) (setq
> warning-suppress-types '((comp) (comp)))
> #+END_SRC
> 
> #+BEGIN_SRC scheme
> (use-modules (gnu home services emacs)
>      (gnu home)
>      (gnu packages)
>      (ice-9 pretty-print)
>      (gnu services))
> 
> (define-public minimal-home-environment
>   (home-environment
>    (services
>     (list
>      (service home-emacs-service-type
>       (home-emacs-configuration
>        (packages
> (list
> (specification->package "bash")
> (specification->package "emacs-next")
> (specification->package "emacs-debbugs")
> (specification->package "emacs-evil")
> (specification->package "emacs-paredit")
> (specification->package "emacs-anzu")))
>        (init '((evil-mode 1)))
>        (early-init '((setq warning-suppress-log-types '((comp)
> (comp)))
>      (setq warning-suppress-types '((comp) (comp)))))))))))
> 
> minimal-home-environment
> #+END_SRC
You should also take an extra-files argument, e.g. to add custom.el or
other elisp files that init.el might refer to.

Also, I'm not certain if "scheme-file" is the right primitve here –
Emacs Lisp does differ from Scheme, e.g. in keyword syntax among
others.

Cheers
Zain Jabbar Oct. 20, 2022, 9:30 p.m. UTC | #2
Aloha All,

Thank you for your input.

> Note that you reverted the patch direction.

Please forgive me for that. Is it possible to explain what I did
wrong? I will outline my steps to help you figure out what I did
incorrectly.

1. I cloned the repo
2. Used =guix shell -D guix=
3. Ran =./bootstrap=
4. Ran =./configure --localstatedir=/var=
5. Ran =make && make check=. By the way, my =make check= had a failed
test, I don't know if that was expected.
6. Made some commits
7. I used =git diff HEAD origin/HEAD > my-guix-patch.patch=.

I might have messed around too much in my cloned repo, throwing something off.

> You should also take an extra-files argument, e.g. to add custom.el or
> other elisp files that init.el might refer to.

Understood. Attached as a new patch. =home-emacs-configuration= now
has an extra field =extra-files=. To use it, input a list of file
objects. The service will splice them into
=$XDG_CONFIG_HOME/emacs/{FILE}=. Here is an example configuration.
Using =guix home container= will allow you to see the file =greetings=
with contents "hello world" in =.config/emacs/=.

#+BEGIN_SRC scheme
(use-modules (gnu home services emacs)
     (gnu home)
     (guix gexp)
     (gnu packages)
     (ice-9 pretty-print)
     (gnu services))

(home-environment
 (services
  (list
   (service home-emacs-service-type
    (home-emacs-configuration
     (packages
      (list
       (specification->package "bash")
       (specification->package "emacs-next")))
     (extra-files (list (scheme-file "greetings" '(hello world)
#:splice? #:t))))))))
#+END_SRC

> Also, I'm not certain if "scheme-file" is the right primitive here –
> Emacs Lisp does differ from Scheme, e.g. in keyword syntax among
> others.

I agree; using =scheme-file= for =emacs-lisp= feels blasphemous. There
are some odd errors associated with this method too. For example,
=#'foo= is the shorthand for =(function foo)= in Emacs Lisp but gets
turned into =(syntax foo)= when using Guile. Meaning a pure drag and
drop =init.el >> guile-sexp= has some things that need to be changed.
The fact that Emacs-Lisp and Guile Scheme use S-Expressions was
something I wanted to leverage. It becomes easy to write Elisp in the
parens of the =init= parameter because there is no context switching
(e.g. lispy works, cape-symbols works for Elisp in Scheme).

I am open to other forms of inputting the text in the files. This is a
bit high maka maka, but I would also like to see how "elegant" the
other methods of inserting Elisp look. That is, can we make it
desirable for people to integrate Elisp into Guile Scheme moreso than
a =local-file= declaration. Using backquotes and S-Expressions allows
for some variables from Guile to be placed into the Emacs
configuration like the system type, user names, and emails.

On Thu, Oct 20, 2022 at 2:54 AM Liliana Marie Prikler
<liliana.prikler@ist.tugraz.at> wrote:
>
> Am Mittwoch, dem 19.10.2022 um 15:59 -1000 schrieb Zain Jabbar:
> > Aloha Guix Development Team,
> >
> > First submission of a patch to this mail service. Hopefully this
> > works. I welcome any and all feedback.
> >
> > Attached is a patch which creates a new file
> > =/gnu/home/services/emacs.scm= which defines a new service
> > =home-emacs-service-type= and a configuration for said service
> > =home-emacs-configuration=. The configuration contains a list of
> > packages to add to the home-profile, and a list of expressions to add
> > into Emacs' =init.el= and =early-init.el=.
> Note that you reverted the patch direction.
>
> > Here is an example of a home environment file which:
> >
> > Adds the following packages:
> > - =bash=
> > - =emacs-next=
> > - =emacs-debbugs=
> > - =emacs-evil=
> > - =emacs-paredit=
> > - =emacs-anzu=
> >
> > Overwrites the =.config/emacs/init.el= with:
> > #+BEGIN_SRC emacs-lisp
> > (evil-mode 1)
> > #+END_SRC
> >
> > Overwrites the =.config/emacs/early-init.el= with:
> > #+BEGIN_SRC emacs-lisp
> > (setq warning-suppress-log-types '((comp) (comp))) (setq
> > warning-suppress-types '((comp) (comp)))
> > #+END_SRC
> >
> > #+BEGIN_SRC scheme
> > (use-modules (gnu home services emacs)
> >      (gnu home)
> >      (gnu packages)
> >      (ice-9 pretty-print)
> >      (gnu services))
> >
> > (define-public minimal-home-environment
> >   (home-environment
> >    (services
> >     (list
> >      (service home-emacs-service-type
> >       (home-emacs-configuration
> >        (packages
> > (list
> > (specification->package "bash")
> > (specification->package "emacs-next")
> > (specification->package "emacs-debbugs")
> > (specification->package "emacs-evil")
> > (specification->package "emacs-paredit")
> > (specification->package "emacs-anzu")))
> >        (init '((evil-mode 1)))
> >        (early-init '((setq warning-suppress-log-types '((comp)
> > (comp)))
> >      (setq warning-suppress-types '((comp) (comp)))))))))))
> >
> > minimal-home-environment
> > #+END_SRC
> You should also take an extra-files argument, e.g. to add custom.el or
> other elisp files that init.el might refer to.
>
> Also, I'm not certain if "scheme-file" is the right primitve here –
> Emacs Lisp does differ from Scheme, e.g. in keyword syntax among
> others.
>
> Cheers



--
Mahalo,
Zain Jabbar
Liliana Marie Prikler Oct. 21, 2022, 6:05 a.m. UTC | #3
Am Donnerstag, dem 20.10.2022 um 11:30 -1000 schrieb Zain Jabbar:
> Aloha All,
> 
> Thank you for your input.
> 
> > Note that you reverted the patch direction.
> 
> Please forgive me for that. Is it possible to explain what I did
> wrong? I will outline my steps to help you figure out what I did
> incorrectly.
> 
> 1. I cloned the repo
> 2. Used =guix shell -D guix=
> 3. Ran =./bootstrap=
> 4. Ran =./configure --localstatedir=/var=
> 5. Ran =make && make check=. By the way, my =make check= had a failed
> test, I don't know if that was expected.
> 6. Made some commits
> 7. I used =git diff HEAD origin/HEAD > my-guix-patch.patch=.
> 
> I might have messed around too much in my cloned repo, throwing
> something off.
Instead of 6+7, write a single commit and use =git format-patch=.

You can of course do multi-patch series, but this feature seems not to
be one that requires that.  Always clean up your commit log after a
hacking session ;)

> > You should also take an extra-files argument, e.g. to add custom.el
> > or other elisp files that init.el might refer to.
> 
> Understood. Attached as a new patch. =home-emacs-configuration= now
> has an extra field =extra-files=. To use it, input a list of file
> objects. The service will splice them into
> =$XDG_CONFIG_HOME/emacs/{FILE}=. Here is an example configuration.
> Using =guix home container= will allow you to see the file
> =greetings=
> with contents "hello world" in =.config/emacs/=.
> 
> #+BEGIN_SRC scheme
> (use-modules (gnu home services emacs)
>      (gnu home)
>      (guix gexp)
>      (gnu packages)
>      (ice-9 pretty-print)
>      (gnu services))
> 
> (home-environment
>  (services
>   (list
>    (service home-emacs-service-type
>     (home-emacs-configuration
>      (packages
>       (list
>        (specification->package "bash")
>        (specification->package "emacs-next")))
>      (extra-files (list (scheme-file "greetings" '(hello world)
> #:splice? #:t))))))))
> #+END_SRC
Is that #:splice? #t meant to be there?

Also, why is bash required here?  You should perhaps also distinguish
the emacs package and the emacs-* packages like so:

(emacs emacs-next)
(packages (list emacs-dash emacs-tempel))

As a future extension, it'd be nice if we could use this service to
easily specify native compilation for emacs packages, but for this one
would have to lay some groundwork in emacs-build-system.

> > Also, I'm not certain if "scheme-file" is the right primitive here
> > – Emacs Lisp does differ from Scheme, e.g. in keyword syntax among
> > others.
> 
> I agree; using =scheme-file= for =emacs-lisp= feels blasphemous.
> There are some odd errors associated with this method too. For
> example, =#'foo= is the shorthand for =(function foo)= in Emacs Lisp
> but gets turned into =(syntax foo)= when using Guile. Meaning a pure
> drag and drop =init.el >> guile-sexp= has some things that need to be
> changed.
> The fact that Emacs-Lisp and Guile Scheme use S-Expressions was
> something I wanted to leverage. It becomes easy to write Elisp in the
> parens of the =init= parameter because there is no context switching
> (e.g. lispy works, cape-symbols works for Elisp in Scheme).
Note that Guile has an elisp reader, albeit a broken one, but no means
to switch languages inside files.

> I am open to other forms of inputting the text in the files. This is
> a bit high maka maka, but I would also like to see how "elegant" the
> other methods of inserting Elisp look. That is, can we make it
> desirable for people to integrate Elisp into Guile Scheme moreso than
> a =local-file= declaration. Using backquotes and S-Expressions allows
> for some variables from Guile to be placed into the Emacs
> configuration like the system type, user names, and emails.
I think taking a list of file-like objects and concatenating their
contents might be worth considering.  That's a bit more overhead, but
we'd have a cleaner separation between fragments that have the same
semantics in Scheme and those that don't.

Cheers
Joshua Branson Oct. 21, 2022, 3:42 p.m. UTC | #4
Liliana Marie Prikler <liliana.prikler@ist.tugraz.at> writes:

> Am Donnerstag, dem 20.10.2022 um 11:30 -1000 schrieb Zain Jabbar:
>> Aloha All,
>> 
>> Thank you for your input.
>> 
>> > Note that you reverted the patch direction.
>> 
>> Please forgive me for that. Is it possible to explain what I did
>> wrong? I will outline my steps to help you figure out what I did
>> incorrectly.
>> 
>> 1. I cloned the repo
>> 2. Used =guix shell -D guix=
>> 3. Ran =./bootstrap=
>> 4. Ran =./configure --localstatedir=/var=
>> 5. Ran =make && make check=. By the way, my =make check= had a failed
>> test, I don't know if that was expected.
>> 6. Made some commits
>> 7. I used =git diff HEAD origin/HEAD > my-guix-patch.patch=.
>> 
>> I might have messed around too much in my cloned repo, throwing
>> something off.
> Instead of 6+7, write a single commit and use =git format-patch=.
>
> You can of course do multi-patch series, but this feature seems not to
> be one that requires that.  Always clean up your commit log after a
> hacking session ;)

I personally find it really easy to use git send-email.  :)

Assuming you are in the guix git directory, then this command will send
the latest commit as a patch to the guix-patches email list.

#+BEGIN_SRC sh
git send-email --to='guix-patches@gnu.org' \
--cc='efraim@flashner.co.il' \
--subject-prefix='Patch staging '  --annotate  HEAD^
#+END_SRC

This website will walk you through setting up git send email.

https://git-send-email.io/
diff mbox series

Patch

diff --git a/gnu/home/services/emacs.scm b/gnu/home/services/emacs.scm
deleted file mode 100644
index a3951c2a85..0000000000
--- a/gnu/home/services/emacs.scm
+++ /dev/null
@@ -1,63 +0,0 @@ 
-;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2022 Zain Jabbar <zaijab2000@gmail.com>
-;;;
-;;; This file is part of GNU Guix.
-;;;
-;;; GNU Guix is free software; you can redistribute it and/or modify it
-;;; under the terms of the GNU General Public License as published by
-;;; the Free Software Foundation; either version 3 of the License, or (at
-;;; your option) any later version.
-;;;
-;;; GNU Guix is distributed in the hope that it will be useful, but
-;;; WITHOUT ANY WARRANTY; without even the implied warranty of
-;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-;;; GNU General Public License for more details.
-;;;
-;;; You should have received a copy of the GNU General Public License
-;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
-
-(define-module (gnu home services emacs)
-  #:use-module (gnu home)
-  #:use-module (gnu packages)
-  #:use-module (gnu services)
-  #:use-module (gnu home services)
-  #:use-module (gnu services)
-  #:use-module (gnu services configuration)
-  #:use-module (guix gexp)
-
-  #:export (home-emacs-service-type
-	    home-emacs-configuration))
-
-(define file-likes? (list-of file-like?))
-
-(define-configuration/no-serialization home-emacs-configuration
-  (packages
-   (file-likes (list (specification->package "emacs")))
-   "The packages this configuration will add to home-profile. Usually these will be emacs-* packages.")
-  (early-init
-   (list '())
-   "A list whose contents will inserted into @file{$XDG_CONFIG_HOME/emacs/early-init.el}")
-  (init
-   (list '())
-   "A list whose contents will inserted into @file{$XDG_CONFIG_HOME/emacs/init.el}"))
-
-(define home-emacs-service-type
-  (service-type (name 'emacs-configuration)
-		(extensions
-		 (list (service-extension
-			home-profile-service-type
-			(lambda (config) (home-emacs-configuration-packages config)))
-		       (service-extension
-			home-xdg-configuration-files-service-type
-			(lambda (config)
-			  (list
-                           `("emacs/early-init.el"
-			     ,(scheme-file "early-init.el"
-					   (home-emacs-configuration-early-init config)
-					   #:splice? #:t))
-			   `("emacs/init.el"
-			     ,(scheme-file "init.el"
-					   (home-emacs-configuration-init config)
-					   #:splice? #:t)))))))
-		(default-value (home-emacs-configuration))
-		(description "Configures Emacs and installs packages to home-profile.")))