https://github.com/8dcc/plumber.el

Run different commands depending on the selected text
https://github.com/8dcc/plumber.el

Last synced: 4 days ago
JSON representation

Run different commands depending on the selected text

• Host: GitHub
• URL: https://github.com/8dcc/plumber.el
• Owner: 8dcc
• License: gpl-3.0
• Created: 2024-10-13T14:38:07.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-10-16T22:08:16.000Z (28 days ago)
• Last Synced: 2024-10-18T21:41:26.495Z (26 days ago)
• Language: Emacs Lisp
• Homepage:
• Size: 45.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
#+TITLE: plumber.el

#+AUTHOR: 8dcc

#+OPTIONS: toc:2

#+STARTUP: nofold

*Run different commands depending on the text format.*

This simple package is an Emacs port of my [[https://github.com/8dcc/plumber][plumber]] command, inspired by the

[[https://st.suckless.org/patches/right_click_to_plumb/][right click to plumb]] patch for the [[https://st.suckless.org/][Simple Terminal]], which was inspired by

[[https://9p.io/wiki/plan9/using_plumbing/index.html][Plan9's plumber]].

In short, it allows the user to call a different function depending on the

format of the supplied text. For example, plumbing a URL might call the

=browse-url= function, plumbing the text =printf(3)= might call the =man= function,

and plumbing a path might open it in =dired=. Of course, the text formats can be

configured by the user.

* Usage

You can plumb text with the =plumber-plumb= function, which tries to match the

supplied text against a list of regular expressions; and the =plumber-plumb-as=

function, which lets the user specify the data type.

Both of these functions check their inputs against the =plumber-alist= variable,

which has the following format:

#+begin_src emacs-lisp

((TYPE REGEXP FUNC)

 ...

 (TYPE REGEXP FUNC))

#+end_src

Where =type= is a short description of the entry, =regexp= is the regular expression

used by =plumber-plumb=, and =func= is the function to be called by =plumber-plumb=

and =plumber-plumb-as= if a match is found.

By default, both functions use the region contents, or they ask the for the text

to plumb. The =plumber-plumb-as= function also asks the user for a type in the

=plumber-alist= list.

* Installing

This package is not currently on Melpa. You can install it with

=package-vc-install=:

#+begin_src emacs-lisp

(package-vc-install "https://github.com/8dcc/plumber.el")

#+end_src

Or, if you are using [[https://github.com/radian-software/straight.el][straight.el]], you can install it using =straight-use-package=:

#+begin_src emacs-lisp

(straight-use-package

 '(plumber :type git :host github :repo "8dcc/plumber.el"))

#+end_src