sshaw / copy-as-format Goto Github PK

View Code? Open in Web Editor NEW

134.0 6.0 7.0 125 KB

Emacs function to copy buffer locations as GitHub/Slack/JIRA etc... formatted code

Emacs Lisp 100.00%

emacs slack hipchat disqus jira gitlab markdown bitbucket html pod

copy-as-format's Introduction

copy-as-format

Emacs function to copy buffer locations as GitHub/Slack/JIRA etc... formatted code

Supported Formats/Services

AsciiDoc
Bitbucket
Disqus
GitHub
GitLab
⚰ HipChat
HTML
JIRA
Markdown
MediaWiki
Org-mode
POD
reStructuredText
Slack
Telegram
WhatsApp

Usage

M-x copy-as-format or C-u M-x copy-as-format

Copy the current line or active region and add it to the kill ring as GitHub/Slack/JIRA... formatted code. Format defaults to copy-as-format-default. The buffer will not be modified.

With a prefix argument prompt for the format.

M-x copy-as-format-SERVICE

Where SERVICE is one of the supported services.

It's a good idea to bind these functions to a key sequence:

(global-set-key (kbd "C-c w s") 'copy-as-format-slack)
(global-set-key (kbd "C-c w g") 'copy-as-format-github)

For AsciiDoc customization see copy-as-format-asciidoc-include-file-name and copy-as-format-asciidoc-language-alist.

Adding Formats

Create a format function with a signature of TEXT MULTILINE:

TEXT - the text to be formatted
MULTILINE - t if TEXT spans multiple lines, otherwise nil

For example:

(defun some-great-format (text multiline)
  (if multiline
      (multiline-format text)
    (single-line-format text)))

Then, add an entry to copy-as-format-format-alist. The key is the format's name and the value is the format function:

(add-to-list 'copy-as-format-format-alist '("great-format" some-great-format))

copy-as-format's People

Contributors

Stargazers

Watchers

Forkers

syohex emacsmirror vishalbelsare mavit web-dev-ritchie tomaskrulis lollinus

copy-as-format's Issues

Better way than mapping file extensions to Jira language tags would be...

#3 (comment):

suspect a better way than mapping file extensions to Jira language tags would be to map Emacs modes to language tags. That way you get to take advantage of all the work put into auto-mode-alist over the years.

@mavit

Add a Reddit option

Reddit confuses people a lot, because its current default front-end supports code formatting options which are not supported by the old front-end (and reddit has shown no interest in fixing this long-standing problem). Consequently people using the default front-end have no idea that the code they paste is liable to look incredibly broken for many of their readers, unless someone points it out to them.

The single formatting technique which is compatible between the old and the new is to indent everything by 4 spaces. If copy-as-format had a reddit option which did that, that would help to reduce the number of broken posts seen at https://old.reddit.com/r/emacs

Output Lists and Quotes

Output as Format does this now. This should too.

better api for programmatic use

right now the only api is the copy-as-format function which inspects the prefix argument and relies on the region being active.

it would be nice to have a public function that would take two positions (begin and end) and a format argument (string, t to prompt for format, nil for default format) that would copy the text in between those two positions using the specified format.

something like this:

(defun copy-as-format-positions (beg end &optional format)
  ...)

this would allow for better use in custom commands, and also for better integration with evil-mode, which has its own concepts to define various regions (e.g. with text objects).

even better, there should be an option to not copy but only return the formatted text, which would mean it can be used in other functions.

what do you think about this? i could come up with a pr if you agree this makes sense to have.

New formats: IM

Could you please add Telegram and Whatsapp formats?

Support For JIRA's panel Format

https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=advanced

Need to think about defaults.

If there's no title, is there a point to support?