https://github.com/liuyinz/consult-todo

https://github.com/liuyinz/consult-todo

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/liuyinz/consult-todo
• Owner: liuyinz
• License: gpl-3.0
• Created: 2021-07-17T07:57:23.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T04:10:21.000Z (15 days ago)
• Last Synced: 2024-10-29T04:32:06.708Z (15 days ago)
• Language: Emacs Lisp
• Size: 163 KB
• Stars: 46
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# consult-todo

[![License GPL 3](https://img.shields.io/badge/license-GPL_3-green.svg?style=flat)](LICENSE)

[![MELPA](http://melpa.org/packages/consult-todo-badge.svg)](http://melpa.org/#/consult-todo)

Search and jump hl-todo keywords in buffers with consult.

## Contents

- [consult-todo](#consult-todo)

  - [Screenshot](#screenshot)

  - [Install](#install)

    - [dependencies](#dependencies)

    - [package](#package)

  - [Usage](#usage)

  - [Customization](#customization)

  - [Todo](#todo)

  - [License](#license)

## Screenshot

- `consult-todo`: Jump to hl-todo keywords in current buffer.

![consult-todo](image/consult-todo.jpg)

- `consult-todo-all`: Jump to hl-todo keywords in all live buffers.

![consult-todo-all](image/consult-todo-all.jpg)

## Install

### dependencies

- Emacs, version >= 29.1

- [hl-todo](https://github.com/tarsius/hl-todo)

- [consult](https://github.com/minad/consult)

### package

- Manually

Clone and add to `load-path`, require the package.

- Melpa

Install with `M-x package-install` `RET` `consult-todo` within Emacs.

## Usage

```elisp

;; Directly

(require 'consult-todo)

;; Or with use-package

(use-package consult-todo :demand t)

```

- `consult-todo`: search in current buffer

- `consult-todo-all`: search in all `hl-todo-mode` enabled buffers

**Warning**: commands below is still buggy, use it as little as possible

- `consult-todo-dir`: search in current directory

- `consult-todo-project`: search in current project

## Customization

- `consult-todo-narrow`: Mapping of narrows and keywords, if it's nil, use default value below instead.

```emacs-lisp

(defconst consult-todo--narrow

  '((?t . "TODO")

    (?f . "FIXME")

    (?b . "BUG")

    (?h . "HACK"))

  "Default mapping of narrow and keywords.")

```

- `consult-todo-other`: Cons for other missing keywords, `(?. . "OTHER")` by default.

- `consult-todo-only-comment`: toggle whether only search keywords in comment, only effective on buffers

## Todo

- [x] search keywords in all project files

## License

See [LICENSE](LICENSE).

[melpa]: http://melpa.org/#/consult-todo