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