https://github.com/savetheclocktower/hyperlink-helper
Atom package that wraps selected text in a hyperlink using a URL copied to the clipboard.
https://github.com/savetheclocktower/hyperlink-helper
Last synced: about 1 month ago
JSON representation
Atom package that wraps selected text in a hyperlink using a URL copied to the clipboard.
- Host: GitHub
- URL: https://github.com/savetheclocktower/hyperlink-helper
- Owner: savetheclocktower
- License: mit
- Created: 2017-11-20T04:50:29.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-28T04:20:50.000Z (over 8 years ago)
- Last Synced: 2025-02-26T17:55:15.160Z (over 1 year ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Hyperlink Helper
An [Atom](https://atom.io) package for wrapping selected text in a hyperlink. The URL for the hyperlink comes from your clipboard.
Inspired by the [similar bundle for TextMate](https://github.com/textmate/hyperlink-helper.tmbundle).
## Usage
In a supported language, highlight the text you want to use as the anchor text, and invoke the **Hyperlink Helper: Insert** command (by default mapped to Ctrl-Alt-L, or Ctrl-Opt-L on OS X).
If your clipboard holds a piece of text that could plausibly be a URL, it'll be used as the `href` for the link. The hyperlink will get inserted as a snippet, and the URL will be highlighted in case you need to type in something. Pressing Tab will move the cursor to the end of the hyperlink.
### Supported formats
HTML and Markdown are supported out of the box. The package makes an intelligent guess as to which format to use: if the language scope is `source.gfm` or contains the string `markdown`, it'll use the Markdown anchor syntax. Otherwise it'll assume HTML.
### Defining custom formats
If you need to write in a markup language that uses a different syntax for anchors (Textile, BBCode, JIRA, whatever), you can use [scoped settings](http://flight-manual.atom.io/behind-atom/sections/scoped-settings-scopes-and-scope-descriptors/) to tell Hyperlink Helper about that format.
To illustrate, here's the built-in format string for HTML:
```
{{text}}
```
Nothing fancy is going on here. Any occurrence of `{{text}}` in the string will be replaced with the anchor text. Any occurrence of `{{url}}` will be replaced with the URL.
Here's what a format string for Textile would look like:
```
"{{text}}":{{url}}
```
And to define it in Textile files, you'd add this to your `config.cson`:
```cson
".text.html.textile":
"hyperlink-helper":
format: "\"{{text}}\":{{url}}"
```
In other words, the command will use any `hyperlink-helper.format` config value it finds for the specific scope. This will supersede the "guessing" behavior [described above](#supported-formats), so you **should not** set this key globally in your `config.cson`. Even defining the key for a broad scope selector like `.text` or `.source` is probably not wise.
### Commands
Command | Description
-----------------------|--------------
`hyperlink-helper:insert` | Inserts an anchor tag using the selected text as the anchor text and the clipboard contents as the URL.
### Keybindings
Command | Linux | OS X | Windows
-------------------|--------|-------|----------
`hyperlink-helper` | Ctrl-Alt-L | Ctrl-Opt-L | Ctrl-Alt-L
Custom keybindings can be added by referencing the above commands. To learn more, visit the [Using Atom: Basic Customization](https://atom.io/docs/latest/using-atom-basic-customization#customizing-key-bindings) or [Behind Atom: Keymaps In-Depth](https://atom.io/docs/latest/behind-atom-keymaps-in-depth) sections in the flight manual.
## TODO
* Possibly add more formats to the built-in guessing if it turns out I've underestimated the popularity of, say, Textile.
* Insert a modified snippet if the selection is empty so that the anchor text gets its own tab stop.
## License
[MIT License](http://opensource.org/licenses/MIT) - see the [LICENSE](https://github.com/savetheclocktower/hyperlink-helper/blob/master/LICENSE.md) for more details.