https://github.com/karimaziev/tide-extra

Misc utils for tide.el
https://github.com/karimaziev/tide-extra

Last synced: 4 days ago
JSON representation

Misc utils for tide.el

• Host: GitHub
• URL: https://github.com/karimaziev/tide-extra
• Owner: KarimAziev
• License: gpl-3.0
• Created: 2023-10-31T09:23:36.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-09T12:14:58.000Z (5 days ago)
• Last Synced: 2024-11-09T13:21:20.506Z (5 days ago)
• Language: Emacs Lisp
• Size: 46.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
#+OPTIONS: ^:nil tags:nil num:nil

* About

Misc utils for [[https://github.com/ananthakumaran/tide][tide.el]].

* Table of Contents                                       :TOC_2_gh:QUOTE:

#+BEGIN_QUOTE

- [[#about][About]]

- [[#requirements][Requirements]]

- [[#installation][Installation]]

  - [[#with-use-package-and-straightel][With use-package and straight.el]]

  - [[#manual-installation][Manual installation]]

- [[#usage][Usage]]

  - [[#transient][Transient]]

  - [[#commands][Commands]]

  - [[#customization][Customization]]

#+END_QUOTE

* Requirements

| Name        | Version |

|-------------+---------|

| Emacs       |    29.1 |

| ~tide~      |   5.1.3 |

| ~transient~ |   0.4.1 |

* Installation

** With use-package and straight.el

#+begin_src elisp :eval no

(use-package tide-extra

  :straight (tide-extra

             :repo "KarimAziev/tide-extra"

             :type git

             :host github)

  :commands (tide-extra-setup-tide-mode

             tide-extra-counsel-imenu

             tide-extra-jump-to-definition-in-other-window))

#+end_src

** Manual installation

Download the source code and put it wherever you like, e.g. into =~/.emacs.d/tide-extra/=

#+begin_src shell :eval no

git clone https://github.com/KarimAziev/tide-extra.git ~/.emacs.d/tide-extra/

#+end_src

Add the downloaded directory to the load path:

#+begin_src elisp :eval no

(add-to-list 'load-path "~/.emacs.d/tide-extra/")

(require 'tide-extra)

#+end_src

* Usage

** Transient

**** ~tide-extra-menu~

Command dispatcher for tide related commands.

** Commands

**** ~tide-extra-setup-tide-mode~

Setup tide mode.

**** ~tide-extra-counsel-imenu~

Set up Tide's imenu index function and enable =auto-rescan= if not already done.

**** ~tide-extra-jump-to-definition-in-other-window~  (&optional arg)

Jump to the definition of the symbol at point in another window. If pointed at an abstract member-declaration, will proceed to look for implementations. When invoked with a prefix =arg=. jump to the type definition.

** Customization

**** ~tide-extra-transient-suffixes~

Custom suffixes to add in transient prefix =tide-extra-menu=.