Skip to content

fix(dotprompt-emacs): remove internal markup from end-user features #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MichaelDoyle wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −16
Open

fix(dotprompt-emacs): remove internal markup from end-user features #547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions packages/emacs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides a major mode for editing Dotprompt (`.prompt`) files with syntax highli

## Features

- **Syntax Highlighting**: Handlebars helpers, partials, Dotprompt markers
- **Syntax Highlighting**: Handlebars helpers, partials
- **LSP Integration**: Diagnostics, formatting, hover via eglot or lsp-mode
- **Format Buffer**: `C-c C-f` or `M-x dotprompt-format-buffer`
- **Format on Save**: Optional automatic formatting
Expand Down Expand Up @@ -109,10 +109,10 @@ lsp-mode integration is also automatic:

## Configuration

| Variable | Default | Description |
|----------|---------|-------------|
| `dotprompt-promptly-path` | `"promptly"` | Path to the promptly executable |
| `dotprompt-format-on-save` | `nil` | Format buffer before saving |
| Variable | Default | Description |
| -------------------------- | ------------ | ------------------------------- |
| `dotprompt-promptly-path` | `"promptly"` | Path to the promptly executable |
| `dotprompt-format-on-save` | `nil` | Format buffer before saving |

### Custom promptly path

Expand All @@ -128,20 +128,20 @@ lsp-mode integration is also automatic:

## Keybindings

| Key | Command | Description |
|-----|---------|-------------|
| Key | Command | Description |
| --------- | ------------------------- | ------------------------- |
| `C-c C-f` | `dotprompt-format-buffer` | Format the current buffer |

## LSP Features

With LSP enabled (eglot or lsp-mode), you get:

| Feature | Description |
|---------|-------------|
| **Diagnostics** | Real-time error detection for YAML and Handlebars syntax |
| **Formatting** | Format with `M-x eglot-format-buffer` or `M-x lsp-format-buffer` |
| **Hover** | Documentation with `M-x eldoc` or mouse hover |
| **Go to Definition** | Jump to partial files with `M-.` |
| Feature | Description |
| -------------------- | ---------------------------------------------------------------- |
| **Diagnostics** | Real-time error detection for YAML and Handlebars syntax |
| **Formatting** | Format with `M-x eglot-format-buffer` or `M-x lsp-format-buffer` |
| **Hover** | Documentation with `M-x eldoc` or mouse hover |
| **Go to Definition** | Jump to partial files with `M-.` |

## Commands

Expand Down
3 changes: 0 additions & 3 deletions packages/emacs/dotprompt-mode.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,6 @@
;; YAML numeric values
'(":\\s-+\\([0-9]+\\.?[0-9]*\\)$" 1 font-lock-constant-face)

;; Dotprompt markers <<<dotprompt:role:system>>> etc.
'("<<<dotprompt:[^>]+>>>" . font-lock-preprocessor-face)

;; Handlebars block comments {{!-- ... --}}
'("{{!--\\(.\\|\n\\)*?--}}" . font-lock-comment-face)

Expand Down
Loading