Luigit
repositories / pi-ext

pi-ext

bugabingas pi extensions

owned by admin

extensions/keysmash/README.md

Raw
Rendered preview
keysmash

keysmash

Pi's prompt editor is plain on purpose, so every - and 1. is typed by hand. keysmash adds small writing niceties and stays out of the way when your text is not Markdown.

Use in Pi

Nothing to invoke. Once loaded, the prompt editor gains these conditional shortcuts. Anything that does not match falls back to Pi's own behavior.

  • Newline on a list item continues it: -, *, +, 1., 1), - [ ], and > quotes. Numbers count up and finished tasks start unchecked.
  • Newline on an empty item steps out one level, then off the list.
  • Backspace on an empty marker steps out the same way.
  • Tab and Shift+Tab nest and unnest a list item, keeping the cursor on its text. Native Tab completion takes precedence, including plain filenames; no matches → nesting. Undo after list continuation removes the generated prefix first, then the newline. Shift+Tab only takes over from Pi on an indented list line.
  • Keys bound to Pi actions or extension shortcuts keep working, including Alt+Enter.
  • Newline on an indented plain line keeps the indent, which helps with pasted code.
  • Typing (, [, {, " or ` adds the closer, typing the closer skips over it, and Backspace removes an empty pair. Pairing skips word edges, emoticons like :(, and text that follows the cursor.

List rules never apply inside fenced code blocks. Pasted text is never rewritten. Enter still submits; use your newline key, or \ then Enter, to continue a list.

If another extension already replaced the prompt editor, keysmash warns and leaves it alone.

Installation

<img src="assets/banner.svg" alt="keysmash" height="70">

# keysmash

Pi's prompt editor is plain on purpose, so every `-` and `1.` is typed by hand.
keysmash adds small writing niceties and stays out of the way when your text is not Markdown.

## Use in Pi

Nothing to invoke.
Once loaded, the prompt editor gains these conditional shortcuts.
Anything that does not match falls back to Pi's own behavior.

- Newline on a list item continues it: `-`, `*`, `+`, `1.`, `1)`, `- [ ]`, and `>` quotes.
  Numbers count up and finished tasks start unchecked.
- Newline on an empty item steps out one level, then off the list.
- Backspace on an empty marker steps out the same way.
- Tab and Shift+Tab nest and unnest a list item, keeping the cursor on its text.
  Native Tab completion takes precedence, including plain filenames; no matches → nesting.
  Undo after list continuation removes the generated prefix first, then the newline.
  Shift+Tab only takes over from Pi on an indented list line.
- Keys bound to Pi actions or extension shortcuts keep working, including Alt+Enter.
- Newline on an indented plain line keeps the indent, which helps with pasted code.
- Typing `(`, `[`, `{`, `"` or `` ` `` adds the closer, typing the closer skips over it, and Backspace removes an empty pair.
  Pairing skips word edges, emoticons like `:(`, and text that follows the cursor.

List rules never apply inside fenced code blocks.
Pasted text is never rewritten.
Enter still submits; use your newline key, or `\` then Enter, to continue a list.

If another extension already replaced the prompt editor, keysmash warns and leaves it alone.

[Installation](../../README.md#install)

<!-- config:start -->
<!-- config:end -->