Git Product home page Git Product logo

org-id-cleanup's Introduction

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.5.3.

Table of Contents

Screenshot

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

images/screenshot1.png

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

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.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

org-id-cleanup's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.