Compare commits

...

5 Commits

Author SHA1 Message Date
4b4f187869
Update package comment for db-projects.el 2022-10-16 21:01:59 +02:00
425792a2ee
Do not create dummy directories when setting up a new project 2022-10-16 21:00:40 +02:00
72d6904968
Minor cosmetics in personal project utilities 2022-10-16 20:59:02 +02:00
7663b82800
Stop using “long names” in personal project utilities
They have only been used in project diaries, and since these are gone now, long
names should go too.
2022-10-16 20:58:11 +02:00
137bafeb0b
Remove bookmark management from personal project utilities
I stopped using project diaries some time ago, so let's get rid of this
functinality.
2022-10-16 20:56:28 +02:00

View File

@ -1,14 +1,11 @@
;;; db-projects.el -- Simple Directory-Based Project Management -*- lexical-binding: t -*-
;; TODO: this package is deprecated and should be replaced or at least built
;; upon either project.el or projectile.
;;; Commentary:
;; A project is simply a directory under `projects-main-project-directory'
;; containing either .git or .projectile. This little collection of functions
;; helps to manage these project directories and also integration them
;; consistently with the projectile package.
;; 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
@ -24,8 +21,10 @@
(require 'bookmark)
(require 'projectile)
(defgroup projects nil
"Simple directory-based project management"
"Simple directory-based project management."
:tag "Project Management"
:group 'projects)
@ -39,6 +38,8 @@
:group 'projects
:type 'directory)
(defun projects-project-exists-p (short-name)
"Check whether a project named SHORT-NAME already exists."
(or
@ -56,14 +57,12 @@
nil "^[^.]")))
;;;###autoload
(defun projects-add-project (short-name long-name)
"Add new project with SHORT-NAME and LONG-NAME.
(defun 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. A bookmark to the project diary will be created,
using the given LONG-NAME. The project diary will be pre-filled
with some standard information like title and creation date."
(interactive "sShort Name: \nsLong Name: ")
SHORT-NAME."
(interactive "sShort Name: ")
(when (projects-project-exists-p short-name)
(user-error "Project %s already exists, exiting" short-name))
(when (file-exists-p (expand-file-name short-name
@ -73,30 +72,11 @@ with some standard information like title and creation date."
projects-main-project-directory))
(default-directory project-directory))
(make-directory project-directory)
(make-directory (expand-file-name "scripts"))
(make-directory (expand-file-name "data"))
(with-temp-buffer
(insert (format "#+title: %s\n" long-name))
(insert (format "#+created: %s\n\n"
(format-time-string "[%Y-%m-%d %a %H:%M]" (current-time))))
(write-file (expand-file-name "projekttagebuch.org"))
(bookmark-set (format "Projekttagebuch %s" long-name)))
(if-let ((git-executable (executable-find "git")))
(call-process git-executable nil nil nil "init")
(write-region "" nil (expand-file-name ".projectile")))
(projectile-add-known-project project-directory)))
(defun projects--find-bookmarks-for-path (path)
"Find all bookmark names that point into PATH."
(unless (file-name-absolute-p path)
(user-error "Given path %s is not absolute" path))
(let ((path (file-truename path)))
(cl-remove-if-not #'(lambda (bmk)
(let ((filename (bookmark-get-filename bmk)))
(and (not (file-remote-p filename))
(string-prefix-p path (file-truename filename)))))
(bookmark-all-names))))
;;;###autoload
(defun projects-archive-project (short-name)
"Archive existing project identified by SHORT-NAME.
@ -115,9 +95,6 @@ project, and updating projectile's cache."
(when (file-exists-p archive-path)
(user-error "Archived project named %s already exists, aborting" short-name))
;; Remove bookmarks first
(mapc #'bookmark-delete (projects--find-bookmarks-for-path project-path))
;; Move project directory into archive
(unless (file-exists-p projects-archive-directory)
(make-directory projects-archive-directory))
@ -153,31 +130,6 @@ in `org-agenda-files'."
(gethash (file-truename org-file) extra-files nil))
(projects--org-files))))
(defun projects-check-project-diary-bookmarks ()
"Check that all known projects have a bookmark to their diary.
Return list of short names of projects whose project diaries do
not have a corresponding bookmark."
;; Make hash table of all diary paths to all known projects; as values we
;; keep the short names, because these are the ones we want to return in the
;; end
(let ((projects (make-hash-table :test #'equal)))
(dolist (project (projects-existing-projects))
(let ((project-diary-path (expand-file-name (concat (file-name-as-directory project)
"projekttagebuch.org")
projects-main-project-directory)))
(when (file-exists-p project-diary-path)
(puthash (file-truename project-diary-path) project projects))))
;; Delete all those diary links that have a bookmark
(dolist (bmkn (bookmark-all-names))
(unless (file-remote-p (bookmark-get-filename bmkn))
(remhash (file-truename (bookmark-get-filename bmkn)) projects)))
;; Return remaining short names; those are the ones that do not have a
;; bookmark yet
(hash-table-values projects)))
;;;###autoload
(defun projects-lint-projects ()
"Check all known projects for proper configuration.
@ -195,9 +147,6 @@ through all included Org Mode files."
(insert "\n " file))
(insert "\n\n"))
(when-let ((missing-bookmarks (projects-check-project-diary-bookmarks)))
(insert "The following projects do not have a project diary bookmark: " (apply #'concat missing-bookmarks)))
(display-buffer (current-buffer))))
(provide 'db-projects)