steelbrain / intentions

Base package for showing intentions in Atom
MIT License
53 stars 11 forks source link

Intentions

CI

Intentions is a base package that provides an easy-to-use API to show intentions based in Atom.

Usage

intentions-list

vim-mode-plus users can add these keymap entries to use j and k to navigate the actions list

'atom-text-editor.intentions-list:not([mini])':
  'enter': 'intentions:confirm'
  'j': 'core:move-up'
  'k': 'core:move-down'

Note: This package does not work on older Atoms. You should install the latest version of Atom from: https://atom.io/

APIs

Intentions provides two kinds of APIs, there's Intentions List API that allows you to add items to intentions list. Here is what it looks like,

Intentions List API

The second type of API is highlight API. It allows packages to mark buffer ranges and do cool thing with them. It can be jump-to-declaration click, show type on mouse move and show color as underline. Here is what it looks like

You can find docs about both of these in Intentions Wiki

License

This package is licensed under the terms of MIT License, see the license file for more info.