Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plandes/mark-thing-at
Mark a pattern at the current point.
https://github.com/plandes/mark-thing-at
emacs emacs-lisp lisp utilities
Last synced: 4 days ago
JSON representation
Mark a pattern at the current point.
- Host: GitHub
- URL: https://github.com/plandes/mark-thing-at
- Owner: plandes
- License: gpl-2.0
- Created: 2019-07-10T03:12:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-19T11:12:00.000Z (about 1 year ago)
- Last Synced: 2024-08-05T06:03:31.173Z (3 months ago)
- Topics: emacs, emacs-lisp, lisp, utilities
- Language: Emacs Lisp
- Size: 33.2 KB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Mark a pattern at the current point.
[![MELPA badge][melpa-badge]][melpa-link]
[![MELPA stable badge][melpa-stable-badge]][melpa-stable-link]
[![Build Status][build-badge]][build-link]
This package tracks and creates bindings for region marking functions found in
`thingatpt.el`. The library adds on functionality that:
* Generates functions that marks *things* (per the parlance of `thingatpt.el`
library.
* Creates a mode-map and bindings to make it easy to mark (create a region
around) a word, URL, file, number, symbol etc (see the [usage](#usage)
section).
* Adds a *number thing*, which allows for traversing and marking numbers.
The variable `mark-thing-at-choices` defines a list of symbols for which to
make mark functions.
## Installation
To install, add [melpa] if you have not already and a `use-package`
declaration in your `~/.emacs` file:
```emacs-lisp
;; configure add melpa as an archive source
(add-to-list 'package-archives
'("melpa-stable" . "http://stable.melpa.org/packages/") t)
(use-package mark-thing-at
:bind-keymap ("C-x m" . mark-thing-at-mode-map)
:config
(mark-thing-at-make-functions)
(mark-thing-at-mode 1))
```
This binds all `mark-thing-at` functions to `C-x m`, which is the default
prefix. If you do not like this prefix, you can change it by customizing the
prefix (`M-x customize-variable mark-thing-at-keymap-prefix`) and updating the
`:bind-keymap` declaration. Once you save the customization, the change
immediately takes effect.
## Usage
To get the current set of available mark functions and their bindings, use
`mark-thing-at-keybindings-help`. Assuming you followed the
[install](#install) section and bound the prefix key to `C-x m` you can use
`C-x m ?` to get the listing of functions and their binding. Here's a list of
functions and what they mark:
| Binding | Mark Function | What's Marked |
|----------------|-----------------|-----------------------------------------------|
| C-x m s | mark-symbol | Lisp symbol |
| C-x m n | mark-number | Integer or float number |
| C-x m l | mark-line-this | Entire line (not including prompt in a shell) |
| C-x m i | mark-line | Eentire line with the newline |
| C-x m t | mark-list | List for the given language mode |
| C-M-@, C-M-SPC | mark-sexp | Lisp symbol expression |
| C-M-h | mark-defun | Function definition |
| C-x m f | mark-filename | File name |
| C-x m u | mark-url | Universal resource locator |
| M-@ | mark-word | Natural language word |
| C-x m c | mark-sentence | Natural language sentence |
| C-x m h | mark-whitespace | Tabs and spaces |
## License
Copyright (c) 2019 - 2024 Paul Landes
GNU Lesser General Public License, Version 2.0
[melpa-link]: https://melpa.org/#/mark-thing-at
[melpa-stable-link]: https://stable.melpa.org/#/mark-thing-at
[melpa-badge]: https://melpa.org/packages/mark-thing-at-badge.svg
[melpa-stable-badge]: https://stable.melpa.org/packages/mark-thing-at-badge.svg
[build-badge]: https://github.com/plandes/mark-thing-at/workflows/CI/badge.svg
[build-link]: https://github.com/plandes/mark-thing-at/actions
[melpa]: https://melpa.org/