marcIhm / org-id-cleanup

Interactively find, present and maybe delete unused IDs of org-id. Available on MELPA.

org-id-cleanup

Interactively cleanup unreferenced IDs of org-id.

org-id-cleanup is a package for org-mode within emacs.

Read below for a description.

The current version is 1.7.1.

Table of Contents

• Screenshot
• About this Package
• Files
• Releasing a new version
• Latest Change Log

Screenshot

The screenshot shows step 2 of the assistant after pushing the go-button.

About this Package

Purpose

Interactively find and clean up unused IDs of org-id. The term ‘unused’ refers to IDs, that have been created by org-id regularly, but are now no longer referenced from anywhere within in org. This might e.g. happen by deleting a link, that once referenced such an id.

Normal usage of org-id does not lead to a lot of such unused IDs, and org-id does not suffer much from them.

However, some usage patterns or packages (like org-working-set) may produce a larger number of such unused IDs; in such cases it might be helpful to clean up with org-id-cleanup.

Setup

org-id-cleanup should be installed with package.el or use-package

Files

Implementation

org-id-cleanup.el

The complete lisp source

Building

Rakefile

Helpful Ruby-Tasks for building

Tests

In subdir tests.

oidclpt.el

ert-tests for org-id-cleanup

run-tests.ps1

Windows command file to start an emacs, which is specifically prepared for the tests

run-tests.el

Customizations for the tests

Releasing a new version

Testing and checking

• rake test
• (byte-compile-file “org-id-cleanup.el”)
• elint-current-buffer
• checkdoc
• package-lint-current-buffer ;; ignore messages about org-ws–prefix

Preparing

• Update Version number in org-id-cleanup.el
• Update Change Log in org-id-cleanup.el
• Check and update Commentary in org-id-cleanup.el
• Run rake to copy those pieces of information into README.org and ChangeLog.org
• git add/commit as appropriate
• v=x.y.z ; git tag -a -m $v $v ; git push ; git push –tags

Latest Change Log

See ChangeLog.org for older entries.

1.7

• Compute differences to previous invocation and offer files to be added back
• Show headings along with IDs for deletion

1.6

• Restructured instructions
• Various clarifications

1.5

• Scan more files for IDs
• Write list of files to log
• Offer to revert all changes
• More hints

1.4

• Clarification regarding archives
• Rely on org-id-files
• Refactoring

1.3

• Write a log of deleted IDs

1.2

• Adding tests
• Preparing for melpa

1.1

• Respecting attachments
• Refactoring

1.0

• Initial Version