Match namespace prefix for project utilities with package name

site-lisp/db-projects.el

@@ -2,15 +2,16 @@
 
 ;;; Commentary:
 
-;; A project is simply a directory under `projects-main-project-directory'
+;; A project is simply a directory under `db/projects-main-project-directory'
 ;; containing either .git or .projectile.  This little collection of functions
 ;; helps to manage these project directories and integrate them consistently
 ;; with the projectile package.
 
-;; To start, first customize `projects-main-project-directory' and
-;; `projects-archive-directory' as needed.  Then use `projects-add-project' to
-;; add new projects and `projects-archive-project' to archive them (i.e., move
-;; them to `projects-archive-directory').  This package does not offer to remove
+;; To start, first customize `db/projects-main-project-directory' and
+;; `db/projects-archive-directory' as needed.  Then use
+;; `db/projects-add-project' to add new projects and
+;; `db/projects-archive-project' to archive them (i.e., move them to
+;; `db/projects-archive-directory').  This package does not offer to remove
 ;; projects; this has to be done manually.
 
 ;;; Code:
@@ -23,53 +24,53 @@
 
 
 
-(defgroup projects nil
+(defgroup db/projects nil
   "Simple directory-based project management."
   :tag "Project Management"
-  :group 'projects)
+  :group 'db/projects)
 
-(defcustom projects-main-project-directory "~/Documents/projects/"
+(defcustom db/projects-main-project-directory "~/Documents/projects/"
   "Main directory to host projects."
-  :group 'projects
+  :group 'db/projects
   :type 'directory)
 
-(defcustom projects-archive-directory "~/Documents/projects/.archive/"
+(defcustom db/projects-archive-directory "~/Documents/projects/.archive/"
   "Directory to archive projects into."
-  :group 'projects
+  :group 'db/projects
   :type 'directory)
 
 
 
-(defun projects-project-exists-p (short-name)
+(defun db/projects-project-exists-p (short-name)
   "Check whether a project named SHORT-NAME already exists."
   (or
    (file-exists-p (expand-file-name (concat (file-name-as-directory short-name)
                                             ".git")
-                                    projects-main-project-directory))
+                                    db/projects-main-project-directory))
    (file-exists-p (expand-file-name (concat (file-name-as-directory short-name)
                                             ".projectile")
-                                    projects-main-project-directory))))
+                                    db/projects-main-project-directory))))
 
-(defun projects-existing-projects ()
+(defun db/projects-existing-projects ()
   "Return list of all short-names of existing projects."
-  (cl-remove-if-not #'projects-project-exists-p
-                    (directory-files projects-main-project-directory
+  (cl-remove-if-not #'db/projects-project-exists-p
+                    (directory-files db/projects-main-project-directory
                                      nil "^[^.]")))
 
 ;;;###autoload
-(defun projects-add-project (short-name)
+(defun db/projects-add-project (short-name)
   "Add new project with SHORT-NAME.
 The project directory will be located under
 `projects-main-project-directory' within a directory named
 SHORT-NAME."
   (interactive "sShort Name: ")
-  (when (projects-project-exists-p short-name)
+  (when (db/projects-project-exists-p short-name)
     (user-error "Project %s already exists, exiting" short-name))
   (when (file-exists-p (expand-file-name short-name
-                                         projects-archive-directory))
+                                         db/projects-archive-directory))
     (user-error "Project %s already exists as archived project, exiting" short-name))
   (let* ((project-directory (expand-file-name short-name
-                                              projects-main-project-directory))
+                                              db/projects-main-project-directory))
          (default-directory project-directory))
     (make-directory project-directory)
     (if-let ((git-executable (executable-find "git")))
@@ -78,44 +79,44 @@ SHORT-NAME."
     (projectile-add-known-project project-directory)))
 
 ;;;###autoload
-(defun projects-archive-project (short-name)
+(defun db/projects-archive-project (short-name)
   "Archive existing project identified by SHORT-NAME.
 This amounts to moving the project directory SHORT-NAME under
 `projects-main-project-directory' to
 `projects-archive-directory', deleting all bookmarks into the
 project, and updating projectile's cache."
   (interactive
-   (list (completing-read "Short Name: " (projects-existing-projects) nil t)))
-  (unless (projects-project-exists-p short-name)
+   (list (completing-read "Short Name: " (db/projects-existing-projects) nil t)))
+  (unless (db/projects-project-exists-p short-name)
     (user-error "Project %s does not exist, exiting" short-name))
 
-  (let ((project-path (expand-file-name short-name projects-main-project-directory))
-        (archive-path (expand-file-name short-name projects-archive-directory)))
+  (let ((project-path (expand-file-name short-name db/projects-main-project-directory))
+        (archive-path (expand-file-name short-name db/projects-archive-directory)))
 
     (when (file-exists-p archive-path)
       (user-error "Archived project named %s already exists, aborting" short-name))
 
     ;; Move project directory into archive
-    (unless (file-exists-p projects-archive-directory)
-      (make-directory projects-archive-directory))
+    (unless (file-exists-p db/projects-archive-directory)
+      (make-directory db/projects-archive-directory))
     (rename-file project-path archive-path nil)
 
     ;; Update projectile’s cache
     (projectile-cleanup-known-projects)))
 
-(defun projects--org-files ()
+(defun db/projects--org-files ()
   "Return all Org Mode files in all known projects, recursively.
 Paths returned are absolute, but may not be canonical."
   (mapcan #'(lambda (dir)
-              (directory-files-recursively (expand-file-name dir projects-main-project-directory)
+              (directory-files-recursively (expand-file-name dir db/projects-main-project-directory)
                                            ".*\\.org" nil))
-          (projects-existing-projects)))
+          (db/projects-existing-projects)))
 
 ;; Let's keep the byte compiler happy
 (defvar org-agenda-text-search-extra-files)
 (defvar org-agenda-files)
 
-(defun projects-find-unsearched-org-files ()
+(defun db/projects-find-unsearched-org-files ()
   "Find Org Mode files in known projects that are not searched by default.
 This is done by checking all org Mode files in every project
 whether it is included in `org-agenda-text-search-extra-files' or
@@ -128,10 +129,10 @@ in `org-agenda-files'."
           (append org-agenda-files org-agenda-text-search-extra-files))
     (cl-remove-if #'(lambda (org-file)
                       (gethash (file-truename org-file) extra-files nil))
-                  (projects--org-files))))
+                  (db/projects--org-files))))
 
 ;;;###autoload
-(defun projects-lint-projects ()
+(defun db/projects-lint-projects ()
   "Check all known projects for proper configuration.
 This includes checking whether all bookmarks are in place and
 whether `org-agenda-text-search-extra-files' is set up to search
@@ -141,7 +142,7 @@ through all included Org Mode files."
 
     (erase-buffer)
 
-    (when-let ((unsearched-org-files (projects-find-unsearched-org-files)))
+    (when-let ((unsearched-org-files (db/projects-find-unsearched-org-files)))
       (insert "The following Org Mode files are not included in `org-agenda-text-search-extra-files'; you may want to add them.")
       (dolist (file unsearched-org-files)
         (insert "\n  " file))