Git Product home page Git Product logo

comment-tasks's Introduction

comment-tasks.el

Introduction

comment-tasks.el Show tasks in comments in code.

Screenshot

comment-tasks

Installation

To use this package, put this on your directory where is added to load path, and add these lines to your init.el or .emacs file:

(require 'comment-tasks)

Basic Usage

comment-tasks-minor-mode

Enable comment-tasks-minor-mode. It searches comments on current buffer, and if a comment have a keyword defined in comment-tasks-keyword-list, the comment is displayed on comment-tasks buffer. A comment on comment-tasks buffer, simply called 'task'.

comment-tasks-major-mode

On comment-tasks buffer, comment-tasks-major-mode is enabled. You can use these commands on that mode.

Default Key Mapping

Key Description
RET Jump to the point of the task where cursor focuses
C-j Display the point of the task where cursor focuses
j Move cursor to next line
k Move cursor to previous line
q Quit the window

Customize Variables

comment-tasks-keyword-list(Default '("TODO"))

The keyword list. If the comment contains word that matches one in this list, it's displayed on buffer.

comment-tasks-auto-update(Default t)

If this value is non-nil, comment-tasks buffer is updated on after-save-hook.

comment-tasks-list-size(Default 0.3)

Size (height or width) for the comment-tasks buffer.

comment-tasks-list-position(Default below)

Position of the comment-tasks buffer. Either 'right, 'left, 'above or 'below. This value is passed directly to `split-window'.

comment-tasks-focus-after-activation(Default nil)

If this value is non-nil, the cursor is moved to the comment-tasks buffer automatically when `comment-tasks-minor-mode' is activated.

Sample Configuration

;; customize
(setq comment-tasks-keyword-list '("TODO" "WAITING"))
(setq comment-tasks-auto-update t)
(setq comment-tasks-list-size 0.4)
(setq comment-tasks-list-position 'right)
(setq comment-tasks-focus-after-activation nil)

comment-tasks's People

Contributors

kjmatsuda avatar

Watchers

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