mirror of
https://github.com/jimeh/yank-indent.git
synced 2026-02-19 09:36:40 +00:00
fix(setup)!: simplify package/load setup by not using a global advice
Use buffer-local post-commad-hook instead of global function advice on yank and yank-pop. This avoids any global changes to Emacs' runtime environment outside of the specific buffers within which yank-indent-mode is enabled. BREAKING CHANGE: Removed yank-indent-setup and yank-indent-teardown functions.
This commit is contained in:
16
README.md
16
README.md
@@ -59,14 +59,6 @@ Place `yank-indent.el` somewhere in your `load-path` and require it. For example
|
||||
(global-yank-indent-mode t)
|
||||
```
|
||||
|
||||
## Setup & Teardown
|
||||
|
||||
Required setup that registers advice on `yank` and `yank-pop` commands is
|
||||
automatically done the first time that `yank-indent-mode` is enabled.
|
||||
|
||||
Should you want to though you can manually add/remove the required advice with
|
||||
`yank-indent-setup` and `yank-indent-teardown`.
|
||||
|
||||
## Usage
|
||||
|
||||
### `global-yank-indent-mode`
|
||||
@@ -92,11 +84,3 @@ Keep in mind that the include/exclude major-mode customizations only affect the
|
||||
global mode and which buffers it enables `yank-indent-mode` in. If you
|
||||
explicitly enable `yank-indent-mode` in a buffer, it will operate like normal
|
||||
regardless of what major-mode the buffer is using.
|
||||
|
||||
## Under the Hood
|
||||
|
||||
`yank-indent` registers an advice for after `yank` and `yank-pop` commands. The
|
||||
advice function verifies that `yank-indent-mode` mode is enabled in the current
|
||||
buffer, prefix argument was not given, and the yanked/pasted text was within the
|
||||
`yank-indent-threshold` in size. If all true, it will trigger indentation,
|
||||
otherwise it does nothing.
|
||||
|
||||
Reference in New Issue
Block a user