From 837cfe07c76df5e464e3cfc7e9a1f0e64a91c4b5 Mon Sep 17 00:00:00 2001 From: William Carroll Date: Fri, 31 Jan 2020 15:27:48 +0000 Subject: [PATCH] Rename dotfiles -> briefcase Renaming my mono-repo briefcase. I first introduced this commit in master, but it introduced a bug where one of two things would happen: 1. Emacs wouldn't start and would crash X. 2. Emacs would start but my keyboard wouldn't work. I learned some valuable debugging skills in the process. Here are some of them: When my keyboard was broken, I wanted to control my computer using my laptop. Thankfully this is possible by using `x2x`, which forward X events from the SSH client to the SSH host. ```shell > # I'm unsure if this is the *exact* command > ssh -X desktop x2x -west :0.0 ``` Git commit-local bisecting. I didn't need to do a `git bisect` because I knew which commit introduced the bug; it was HEAD, master. But -- as you can see from the size of this commit -- there are many changes involved. I wanted to binary search through the changes, so I did the following workflow using `magit`: - git reset --soft HEAD^ - git stash 1/2 of the files changed - re-run `nix-env -f ~/briefcase/emacs -i` - restart X session - If the problem persists, the bug exists in the non-stashed files. Repeat the process until you find the bug. In my case, the bug was pretty benign. Calling `(exwm/switch "Dotfiles")` at the bottom of `window-manager.el` was failing because "Dotfiles" is the name of a non-existent workspace; it should've been `(exwm/switch "Briefcase")`. There may have been more problems. I changed a few other things along the way, including exposing the env vars BRIEFCASE to `wpcarros-emacs` inside of `emacs/default.nix`. The important part is that this was a valuable learning opportunity, and I'm glad that I'm walking away from the two days of "lost productivity" feeling actually productive. --- .envrc | 6 ++++-- Makefile | 4 ++-- README.md | 19 +++++++++---------- blog/default.nix | 4 ++-- clojure/buildClojure.nix | 6 +++--- configs/install | 2 +- configs/shared/.config/fish/config.fish | 2 +- configs/shared/.config/lf/marks | 4 ++-- configs/shared/.profile | 2 +- configs/uninstall | 2 +- emacs/.emacs.d/wpc/bookmark.el | 9 +++------ emacs/.emacs.d/wpc/constants.el | 2 +- emacs/.emacs.d/wpc/dotfiles.el | 9 ++++++--- emacs/.emacs.d/wpc/window-manager.el | 10 ++++------ emacs/.emacs.d/wpc/wpc-nix.el | 20 +++++++++++--------- fish/config.fish | 2 +- lisp/f/default.nix | 4 ++-- third_party/lisp/cl-colors.nix | 4 ++-- third_party/lisp/let-plus.nix | 4 ++-- third_party/lisp/prove.nix | 4 ++-- 20 files changed, 60 insertions(+), 59 deletions(-) diff --git a/.envrc b/.envrc index b8a3c45f6..1e44420ed 100644 --- a/.envrc +++ b/.envrc @@ -1,5 +1,7 @@ -export DOTFILES=~/dotfiles +export BRIEFCASE=~/briefcase +export DEPOT=~/depot +export NIXPKGS=$HOME/nixpkgs export DESKTOP=zeno.lon.corp.google.com export LAPTOP=seneca export CLOUDTOP=wpcarro.c.googlers.com -NIX_PATH=nixpkgs=$HOME/nixpkgs:depot=$HOME/depot:universe=$HOME/universe +NIX_PATH=nixpkgs=$NIXPKGS:depot=$DEPOT:briefcase=$BRIEFCASE diff --git a/Makefile b/Makefile index 1be62c668..6ef5116e3 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,8 @@ install: - source "${DOTFILES}/configs/install" + source "${BRIEFCASE}/configs/install" uninstall: - source "${DOTFILES}/configs/uninstall" + source "${BRIEFCASE}/configs/uninstall" list-broken-links: find "${HOME}" -maxdepth 1 -xtype l && \ diff --git a/README.md b/README.md index b63be11c4..36121cc5f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,16 @@ -# dotfiles +# briefcase -This is my mono-repo. Having a personal mono-repo is a new idea for me, so at -the time of this writing, the state of this repository is fledgling. +Welcome to my briefcase: my monorepo. -I'm attempting to amass a collection of functions across a variety of languages -while minimizing the costs of sharing the code across a projects. Stay tuned for -more updates as my definition of the mono-repo becomes more clear, my opinions -evolve, and my preferences change. +I'm attempting to amass a collection of packages that span a variety of +languages while minimizing the costs of sharing the code. This also includes +configuration for things like emacs, tmux, ssh, and other tools. -My configuration also lives inside of my mono-repo. Things like Emacs, Tmux, -SSH, and other tools are configured herein. +# Installation (Deprecated) -# Installation +The installation instructions here are deprecated. I'd like to manage packaging +and installing with Nix, but that is only partially supported at the +moment. ## wpgtk and gvcci diff --git a/blog/default.nix b/blog/default.nix index 5359a0ab6..1b1cc3974 100644 --- a/blog/default.nix +++ b/blog/default.nix @@ -1,7 +1,7 @@ { nixpkgs ? import {}, depot ? import {}, - universe ? import {}, + briefcase ? import {}, ... }: @@ -16,7 +16,7 @@ let ''; in depot.nix.buildLisp.program { name = "server"; - deps = with depot.third_party.lisp; with universe.third_party.lisp; [ + deps = with depot.third_party.lisp; with briefcase.third_party.lisp; [ hunchentoot cl-arrows ]; diff --git a/clojure/buildClojure.nix b/clojure/buildClojure.nix index 1596279de..2c0275d3c 100644 --- a/clojure/buildClojure.nix +++ b/clojure/buildClojure.nix @@ -1,8 +1,8 @@ -{ universe ? import {}, ... }: +{ briefcase ? import {}, ... }: -universe.nix.buildClojure.program { +briefcase.nix.buildClojure.program { name = "test"; - deps = with universe.third_party.clojure; [ + deps = with briefcase.third_party.clojure; [ ]; srcs = [ diff --git a/configs/install b/configs/install index 4aedf35be..c810dfd4f 100755 --- a/configs/install +++ b/configs/install @@ -1,6 +1,6 @@ #!/usr/bin/env bash -configs="$DOTFILES/configs" +configs="$BRIEFCASE/configs" case $(hostname) in $DESKTOP) diff --git a/configs/shared/.config/fish/config.fish b/configs/shared/.config/fish/config.fish index 754470618..20de7a7f7 100644 --- a/configs/shared/.config/fish/config.fish +++ b/configs/shared/.config/fish/config.fish @@ -286,7 +286,7 @@ abbr --add ef e ~/functions.zsh abbr --add el e ~/variables.zsh abbr --add ex e ~/.Xresources abbr --add em e ~/.tmux.conf -abbr --add er e ~/Dropbox/dotfiles/README.md +abbr --add er e $BRIEFCASE/README.md # Couple the s* aliases to the s* kbds in vim. abbr --add sz source ~/.zshrc diff --git a/configs/shared/.config/lf/marks b/configs/shared/.config/lf/marks index 295576a0d..4aff94c32 100644 --- a/configs/shared/.config/lf/marks +++ b/configs/shared/.config/lf/marks @@ -1,6 +1,6 @@ D:~/Dropbox G:/usr/local/google/home/wpcarro/Downloads M:/usr/local/google/home/wpcarro/Downloads -c:~/dotfiles/configs -d:~/dotfiles +c:~/briefcase/configs +d:~/briefcase s:~/Pictures/screenshots diff --git a/configs/shared/.profile b/configs/shared/.profile index 6513c2c9b..30b980469 100644 --- a/configs/shared/.profile +++ b/configs/shared/.profile @@ -52,7 +52,7 @@ LOCALE_ARCHIVE=$(readlink ~/.nix-profile/lib/locale)/locale-archive export LOCALE_ARCHIVE # Set environment variables for Nix. Don't run this for systems running NixOS. -# TODO: Learn why I can't use the variables from ~/dotfiles/.envrc. +# TODO: Learn why I can't use the variables from ~/briefcase/.envrc. case $(hostname) in zeno.lon.corp.google.com) . ~/.nix-profile/etc/profile.d/nix.sh;; seneca) . ~/.nix-profile/etc/profile.d/nix.sh;; diff --git a/configs/uninstall b/configs/uninstall index 526c32113..7151843d6 100755 --- a/configs/uninstall +++ b/configs/uninstall @@ -1,6 +1,6 @@ #!/usr/bin/env bash -configs="$DOTFILES/configs" +configs="$BRIEFCASE/configs" case $(hostname) in $DESKTOP) diff --git a/emacs/.emacs.d/wpc/bookmark.el b/emacs/.emacs.d/wpc/bookmark.el index 734ddaa13..01c28ff00 100644 --- a/emacs/.emacs.d/wpc/bookmark.el +++ b/emacs/.emacs.d/wpc/bookmark.el @@ -62,11 +62,8 @@ Otherwise, open with `counsel-find-file'." (make-bookmark :label "org" :path "~/Dropbox/org" :kbd "o") - (make-bookmark :label "universe" - :path "~/universe" - :kbd "m") - (make-bookmark :label "dotfiles" - :path "~/dotfiles" + (make-bookmark :label "briefcase" + :path (getenv "BRIEFCASE") :kbd "d") (make-bookmark :label "current project" :path constants/current-project @@ -81,7 +78,7 @@ Otherwise, open with `counsel-find-file'." (defun bookmark/magit-status () "Use ivy to select a bookmark and jump to its `magit-status' buffer." (interactive) - (let ((labels (set/new "dotfiles" "universe" "depot")) + (let ((labels (set/new "briefcase" "depot")) (all-labels (->> bookmark/whitelist (list/map (>> bookmark-label)) set/from-list))) diff --git a/emacs/.emacs.d/wpc/constants.el b/emacs/.emacs.d/wpc/constants.el index 5bfedf555..9f12e249f 100644 --- a/emacs/.emacs.d/wpc/constants.el +++ b/emacs/.emacs.d/wpc/constants.el @@ -21,7 +21,7 @@ ;; current consumers of these constants, and I'm unsure if the indirection that ;; globally defined constants introduces is worth it. -(defconst constants/current-project "~/universe" +(defconst constants/current-project "~/briefcase/blog" "Variable holding the directory for my currently active project.") (prelude/assert (f-directory? constants/current-project)) diff --git a/emacs/.emacs.d/wpc/dotfiles.el b/emacs/.emacs.d/wpc/dotfiles.el index 2e78cf213..d27815c9e 100644 --- a/emacs/.emacs.d/wpc/dotfiles.el +++ b/emacs/.emacs.d/wpc/dotfiles.el @@ -20,9 +20,12 @@ (defconst dotfiles/install-kbds? t "When t, install the keybindings.") +(defconst dotfiles/directory (getenv "BRIEFCASE") + "The root directory of my configuration files.") + (defconst dotfiles/whitelist - '(("compton" . "~/.config/compton.conf") - ("dotfiles" . "~/dotfiles/") + `(("compton" . "~/.config/compton.conf") + ("dotfiles" . ,dotfiles/directory) ("functions" . "~/functions.zsh") ("aliases" . "~/aliases.zsh") ("variables" . "~/variables.zsh") @@ -47,7 +50,7 @@ (defun dotfiles/find-emacs-file (name) "Call `find-file' on NAME located in dotfiles's emacs.d directory." (find-file - (f-join "~/dotfiles/configs/shared/.emacs.d" name))) + (f-join dotfiles/directory "emacs/.emacs.d" name))) (provide 'dotfiles) ;;; dotfiles.el ends here diff --git a/emacs/.emacs.d/wpc/window-manager.el b/emacs/.emacs.d/wpc/window-manager.el index cf7f1efeb..b6caa8adf 100644 --- a/emacs/.emacs.d/wpc/window-manager.el +++ b/emacs/.emacs.d/wpc/window-manager.el @@ -78,7 +78,7 @@ :index 1 :kbd "p") (make-exwm/named-workspace - :label "Dotfiles" + :label "Briefcase" :index 2 :kbd "d") (make-exwm/named-workspace @@ -611,10 +611,8 @@ Currently using super- as the prefix for switching workspaces." ;; Dotfiles ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (progn - (exwm/switch "Dotfiles") - (dotfiles/find-emacs-file "init.el") - (wpc/evil-window-vsplit-right) - (dotfiles/find-emacs-file "wpc/window-manager.el")) + (exwm/switch "Briefcase") + (dotfiles/find-emacs-file "init.el")) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Chatter ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -641,7 +639,7 @@ Currently using super- as the prefix for switching workspaces." ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Reset to default ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - (exwm/switch "Dotfiles")))) + (exwm/switch "Briefcase")))) (provide 'window-manager) ;;; window-manager.el ends here diff --git a/emacs/.emacs.d/wpc/wpc-nix.el b/emacs/.emacs.d/wpc/wpc-nix.el index 68d542e01..7407e02bf 100644 --- a/emacs/.emacs.d/wpc/wpc-nix.el +++ b/emacs/.emacs.d/wpc/wpc-nix.el @@ -8,8 +8,10 @@ ;; Dependencies ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(prelude/assert (f-exists? "~/universe")) -(prelude/assert (f-exists? "~/depot")) +;; TODO: These may fail at startup. How can I make sure that the .envrc is +;; consulted when Emacs starts? +(prelude/assert (f-exists? (getenv "BRIEFCASE"))) +(prelude/assert (f-exists? (getenv "DEPOT"))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Library @@ -19,7 +21,7 @@ (use-package nix-mode :mode "\\.nix\\'") -(defun nix/sly-from-universe (attribute) +(defun nix/sly-from-briefcase (attribute) "Start a Sly REPL configured with a Lisp matching a derivation from my monorepo. @@ -29,12 +31,12 @@ This function was taken from @tazjin's depot and adapted for my monorepo. asynchronously. The build output is included in the error thrown on build failures." (interactive "sAttribute: ") - (lexical-let* ((outbuf (get-buffer-create (format "*universe-out/%s*" attribute))) - (errbuf (get-buffer-create (format "*universe-errors/%s*" attribute))) - (expression (format "let depot = import {}; universe = import {}; in depot.nix.buildLisp.sbclWith [ universe.%s ]" attribute)) + (lexical-let* ((outbuf (get-buffer-create (format "*briefcase-out/%s*" attribute))) + (errbuf (get-buffer-create (format "*briefcase-errors/%s*" attribute))) + (expression (format "let depot = import {}; briefcase = import {}; in depot.nix.buildLisp.sbclWith [ briefcase.%s ]" attribute)) (command (list "nix-build" "-E" expression))) - (message "Acquiring Lisp for .%s" attribute) - (make-process :name (format "depot-nix-build/%s" attribute) + (message "Acquiring Lisp for .%s" attribute) + (make-process :name (format "nix-build/%s" attribute) :buffer outbuf :stderr errbuf :command command @@ -45,7 +47,7 @@ This function was taken from @tazjin's depot and adapted for my monorepo. ("finished\n" (let* ((outpath (s-trim (with-current-buffer outbuf (buffer-string)))) (lisp-path (s-concat outpath "/bin/sbcl"))) - (message "Acquired Lisp for .%s at %s" attribute lisp-path) + (message "Acquired Lisp for .%s at %s" attribute lisp-path) (sly lisp-path))) (_ (with-current-buffer errbuf (error "Failed to build '%s':\n%s" attribute (buffer-string))))) diff --git a/fish/config.fish b/fish/config.fish index 948339314..e989c7364 100644 --- a/fish/config.fish +++ b/fish/config.fish @@ -292,7 +292,7 @@ abbr --add ef e ~/functions.zsh abbr --add el e ~/variables.zsh abbr --add ex e ~/.Xresources abbr --add em e ~/.tmux.conf -abbr --add er e ~/Dropbox/dotfiles/README.md +abbr --add er e $BRIEFCASE/README.md # TODO: consider DRYing this up with `e`. Unfortunately, `sudo` won't support # aliases. abbr --add en sudo ALTERNATE_EDITOR=nvim emacsclient --no-wait --create-frame /etc/nixos/configuration.nix diff --git a/lisp/f/default.nix b/lisp/f/default.nix index 6911b2102..0ca6898b6 100644 --- a/lisp/f/default.nix +++ b/lisp/f/default.nix @@ -1,12 +1,12 @@ { depot ? import {}, - universe ? import {}, + briefcase ? import {}, ... }: depot.nix.buildLisp.library { name = "f"; - deps = with universe.lisp; [ + deps = with briefcase.lisp; [ prelude ]; srcs = [ diff --git a/third_party/lisp/cl-colors.nix b/third_party/lisp/cl-colors.nix index 2217e68ce..6d49dd7aa 100644 --- a/third_party/lisp/cl-colors.nix +++ b/third_party/lisp/cl-colors.nix @@ -1,6 +1,6 @@ { depot ? import {}, - universe ? import {}, + briefcase ? import {}, ... }: @@ -13,7 +13,7 @@ in depot.nix.buildLisp.library { name = "cl-colors"; deps = [ depot.third_party.lisp.alexandria - universe.third_party.lisp.let-plus + briefcase.third_party.lisp.let-plus ]; srcs = [ "${src}/package.lisp" diff --git a/third_party/lisp/let-plus.nix b/third_party/lisp/let-plus.nix index a3a15776b..6e74b9622 100644 --- a/third_party/lisp/let-plus.nix +++ b/third_party/lisp/let-plus.nix @@ -1,6 +1,6 @@ { depot ? import {}, - universe ? import {}, + briefcase ? import {}, ... }: @@ -13,7 +13,7 @@ in depot.nix.buildLisp.library { name = "let-plus"; deps = [ depot.third_party.lisp.alexandria - universe.third_party.lisp.anaphora + briefcase.third_party.lisp.anaphora ]; srcs = [ "${src}/package.lisp" diff --git a/third_party/lisp/prove.nix b/third_party/lisp/prove.nix index d6c0fe741..2579d0392 100644 --- a/third_party/lisp/prove.nix +++ b/third_party/lisp/prove.nix @@ -1,6 +1,6 @@ { depot ? import {}, - universe? import {}, + briefcase ? import {}, ... }: @@ -16,7 +16,7 @@ in depot.nix.buildLisp.library { depot.third_party.lisp.cl-ansi-text depot.third_party.lisp.alexandria depot.third_party.lisp.uiop - universe.third_party.lisp.cl-colors + briefcase.third_party.lisp.cl-colors ]; srcs = [ "${src}/src/asdf.lisp"