ox-slack icon indicating copy to clipboard operation
ox-slack copied to clipboard

Clean up for MELPA

Open dotemacs opened this issue 6 years ago • 2 comments

Hi @titaniumbones

saw this package, cloned it and tried it out. I like it :) so thanks for your work.

But then I saw the comment in the README:

I’d love to put this in Melpa, but I haven’t figured out how to do that.

As one of the first steps when you submit something to MELPA, the checklist will be to run package-lint against your package to see if there are any issues. If there are to address the first.

So this is what I've done here, which are:

  • adding of the correct dependancy declaration, here emacs 24, as a requirement for lexical-bindings

  • I've renamed all function names with org-slack to ox-slack, as this is one of the requirement of the package format for MELPA

  • I've cleaned up some formatting, like when there were trailing parentheses or leading spaces before comments

I think that the rest should be addressed by you based on your tastes.

See what you think of this PR and you'd like to add it to your project in order to help get it on MELPA.

Thanks again

For completeness sake, this is the list of issues that exists in the current master:

1:53: warning: You should depend on (emacs "24") if you need lexical-binding.
64:1: error: "org-slack-timestamp" doesn't start with package's prefix "ox-slack".
72:1: error: "org-slack-headline" doesn't start with package's prefix "ox-slack".
97:1: error: "org-slack-link" doesn't start with package's prefix "ox-slack".
115:11: error: You should depend on (emacs "24") if you need `pcase'.
176:1: error: "org-slack-verbatim" doesn't start with package's prefix "ox-slack".
182:1: error: "org-slack-code" doesn't start with package's prefix "ox-slack".
191:1: error: "org-slack-italic" doesn't start with package's prefix "ox-slack".
198:1: error: "org-slack-bold" doesn't start with package's prefix "ox-slack".
207:1: error: "org-slack-strike-through" doesn't start with package's prefix "ox-slack".
214:1: error: "org-slack-inline-src-block" doesn't start with package's prefix "ox-slack".
224:1: error: "org-slack-src-block" doesn't start with package's prefix "ox-slack".
236:1: error: "org-slack-quote-block" doesn't start with package's prefix "ox-slack".
243:1: error: "org-slack-inner-template" doesn't start with package's prefix "ox-slack".
261:1: error: "org-slack-plain-text" doesn't start with package's prefix "ox-slack".
288:1: error: "org-slack-export-as-slack" doesn't start with package's prefix "ox-slack".
323:1: error: "org-slack-export-to-slack" doesn't start with package's prefix "ox-slack".
357:1: error: "org-slack-export-to-clipboard-as-slack" doesn't start with package's prefix "ox-slack".

dotemacs avatar Sep 05 '19 14:09 dotemacs

So it turns out that your package has already made it to MELPA: https://melpa.org/#/ox-slack.

I just relied on the message in the README and went with it.

In any case, thanks for the package I'll use for sure, just installed it via MELPA. See what you think of the PR above, if it's worth adding to the repo.

Thanks again :)

dotemacs avatar Sep 06 '19 09:09 dotemacs

Hi @dotemacs, I'm sorry I never responded to this -- it came at a particularly hectic time and I entirely lost track of it later in the fall.

I'm not going to accept this as-is because there is a conflict between MELPA linting expectations and org-mode exporter conventions. Most org exporters name files ox-something but name functions org-something -- this is a genuine problem related to emacs's lack of namespacing, but I don't have any strong opinions about what's best to do here, so will leave things for now. Meanwhile though I will at least add the emacsdependency and tyr to do the code cleanup when I can. Thanks for your help!

titaniumbones avatar Jan 08 '20 15:01 titaniumbones