Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdgriffith/atom-inline-messenger
Inline Messaging in the Atom Editor
https://github.com/mdgriffith/atom-inline-messenger
Last synced: 2 months ago
JSON representation
Inline Messaging in the Atom Editor
- Host: GitHub
- URL: https://github.com/mdgriffith/atom-inline-messenger
- Owner: mdgriffith
- License: mit
- Created: 2015-07-09T21:00:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-10-31T16:43:23.000Z (about 8 years ago)
- Last Synced: 2024-05-21T12:51:45.499Z (7 months ago)
- Language: CoffeeScript
- Size: 68.4 KB
- Stars: 14
- Watchers: 3
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Inline Messenger for the Atom Editor
This package provides an inline messaging service for other packages.
With it, a package can show messages next to the relevant, highlighted code, and optionally make a code suggestion for the selected text.
An example of an inline message. Single line messages are underlined. Multiline messages have a dotted line annotation to the left.
An example of a message with a code suggestion. The code suggestion is then accepted
## Getting Started
The [Inline Messenger Example](https://github.com/mdgriffith/atom-inline-messenger-example) has example code on how to work with this package.
## Design Considerations
The goal was to create a service for inline messaging as you see this functionality reimplemented in many packages.
Design-wise, the priority was to be as unobtrusive to the code as possible. For one line messages, the standard dotted underline was used to highlight a piece of code.
Though for multiline highlights this seemed to be obtrusive. The solution was to have a dashed line along the gutter. When the section of code is highlighted, it's obvious that the gutter annotation is connected to the highlighted text and the message. It also doesn't interfere with the [git-diff](https://github.com/atom/git-diff) package.
### Message Positioning
In case the user doesn't want messages to overlap with any code, you can set the message positioning setting to `Right` instead of `Below`.
