Skip to content

Latest commit

 

History

History
239 lines (191 loc) · 8.92 KB

README.md

File metadata and controls

239 lines (191 loc) · 8.92 KB
Raw

Sidekick.el

------------------------------
------------ ----    ----
************ ****   ****
----         ----  ----
************ *********       SIDEKICK
------------ ---------    --------------
       ***** ****  ****
------------ ----   ----
************ ****    ****
------------------------------

Sidekick is an Emacs package that's aim is to provide information about a symbol inside a single window. It's still in its infancy, and at this point in time only searches for references using ripgrep. It will however be in active development and I hope to extend it in the near future to support things such as getting a symbols documentation and extracting other time saving information.

If you experience any issues or there's a feature you would like to recommend, please open a new issue.

Screenshot of sidekick

Installation

Important: ripgrep (rg) is required! Please make sure you have it installed and available in your system path, see Installing ripgrep.

Manual installation

Clone this repository locally, and add the load path to your .emacs:

(add-to-list 'load-path "/path/to/sidekick.el/folder/")
(require 'sidekick)

;; If your part of the dark side (Evil User), uncomment this:
;; (with-eval-after-load 'sidekick (require 'sidekick-evil))

;; Set some default bindings.
(global-set-key (kbd "C-c k") 'sidekick-at-point)
(global-set-key (kbd "C-c K") 'sidekick-focus-toggle)
(global-set-key (kbd "C-c C-k") 'sidekick-search-for-literal)

;; Optional:
;; Maybe customize a mode's file assosiations?
(sidekick-set-file-associations "php-mode" "*.{php,twig,blade,phtml}")
(sidekick-set-file-associations "web-mode" "*.{php,html,scss,sass}")

;; Maybe, make sidekick take focus after update?
;; (setq sidekick-window-take-focus t)

;; Notes:
;; On Windows, use this path format:
;; (add-to-list 'load-path "C:\\Users\\your-name\\path\\to\\sidekick.el\\folder\\")

Usage

Default key bindings

The following keybindings are available inside the Sidekick window/mode.

Key Command Description
q sidekick-quit Closes the Sidekick window and kills it's buffer.
g sidekick-refresh Re-runs the previous operations, refreshing the results.
n sidekick-open-next-match Displays the next match.
p sidekick-open-previous-match Displays the previous match.
RET sidekick-open-match Go's directly to the matched symbol.

You can customize keybindings that are local to the Sidekick window, like this:

;; Adding custom Sidekick window local bindings.
(add-hook 'sidekick-mode-hook
  (lambda ()
   (local-set-key (kbd "<up>") 'sidekick-open-previous-match)
   (local-set-key (kbd "<down>") 'sidekick-open-next-match)))

Unbound commands

Command Description
sidekick-at-point Takes the symbol at point and triggers the update call.
sidekick-focus Focuses on the Sidekick window, if visible.
sidekick-focus-toggle Toggle between sidekick window and previous buffer's window.
sidekick-search-for-literal Input a literal string and triggers the update call.

You can define custom key bindings for any of the above commands. See the below example:

(global-set-key (kbd "C-c k") 'sidekick-at-point)
(global-set-key (kbd "C-c K") 'sidekick-focus-toggle)
(global-set-key (kbd "C-c C-k") 'sidekick-search-for-literal)

Evil key bindings

Key Command Description
q sidekick-quit Closes the Sidekick window and kills it's buffer.
g sidekick-refresh Re-runs the previous operations, refreshing the results.
n sidekick-open-next-match Displays the next match.
N sidekick-open-previous-match Displays the previous match.
RET sidekick-open-match Go's directly to the matched symbol.

Evil-mode integration is provided by sidekick-evil. Use the following to load it:

;; Add this line after (require 'sidekick).
(with-eval-after-load 'sidekick (require 'sidekick-evil))

Configuration

How the projects root directory is determined

A projects root directory is determined by having one of the following files.

  • A file named .sidekick (highest priority)
  • A file named .projectile
  • A git repository .git

Available customizations

  • sidekick-search-minimum-symbol-length: The minimum symbol / term length in order for Sidekick to update. The lowest number possible is 2.

    • Type: integer
    • Default: 2
    • Example: 
      (setq sidekick-search-minimum-symbol-length 3)

  • sidekick-search-max-line-length: The maximum line width of a search result in columns. Useful for to limit large minified files.

    • Type: integer
    • Default: 500
    • Example: 
      (setq sidekick-search-max-line-length 1000)

  • sidekick-window-take-focus: If non-nil, automatically select the sidekick window after every update.

    • Type: boolean
    • Default: nil
    • Example: 
      (setq sidekick-window-take-focus t)

  • sidekick-window-width: The width of the sidekick window in normalized percentage.

    • Type: float
    • Default: 0.3
    • Example: 
      (setq sidekick-window-width 0.225)

  • sidekick-window-side: The Sidekick window position, left or right.

    • Type: symbol
    • Default: 'right
    • Example: 
      (setq sidekick-window-side 'left)

  • sidekick-window-hide-footer: Remove the Sidekick footer branding.

    • Type: boolean
    • Default: nil
    • Example: 
      (setq sidekick-window-hide-footer t)

Modifying a mode's associated files

The blow list specifies the default mode - file associations. These associations allow you to search for specific file types on a per mode basis. For example, if your using web-mode for HTML files, it might also be useful to search for a symbol inside SCSS and Javascirpt files.

Mode Files
c++-mode "*.{cpp,h,hh}"
c-mode "*.{c,cc,h,hh}"
cperl-mode "*.{pl,PL}"
css-mode "*.css"
scss-mode "*.{css,sass,scss}"
emacs-lisp-mode "*.{el,emacs}"
go-mode "*.go"
java-mode "*.java"
js-mode "*.{js,es,es6}"
json-mode "*.json"
markdown-mode "*.md"
text-mode "*.txt"
php-mode "*.{php,phtml,twig}"
phps-mode "*.{php,phtml,twig}"
python-mode "*.py"
ruby-mode "*.rb"
rust-mode "*.rs"
typescript-mode "*.ts"
web-mode ""
nxml-mode "*.{xml,xml.dist}"
yaml-mode "*.yml"

If the provided glob pattern is an empty string, Sidekick will just search for files with the same extension as the active buffer's file. To add or update an existing mode's file associations, the following helper function has been provided. See the below usage example:

;; Adds a new mode, glob pair.
(sidekick-set-file-associations "example-mode" "*.{exam,examp}")

;; Replace an existing mode's file globs.
(sidekick-set-file-associations "web-mode" "*.{php,html,scss,sass}")

Credits

The following tools and educational resources where invaluable during the development of this package.