Skip to content
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.

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

Generate RSS feed for diary #934

Merged
merged 3 commits into from
Jul 22, 2020
Merged

Generate RSS feed for diary #934

merged 3 commits into from
Jul 22, 2020

Conversation

reinerh
Copy link
Contributor

@reinerh reinerh commented Jul 5, 2020

This change allows one to generate an RSS feed for the exported VimWiki (#172).
It introduces the command :VimwikiRss which generates a rss.xml file (filename can be changed via rss_name setting)
that contains the latest diary entries (by default 10; configurable via rss_max_items).

  • ALL pull requests should be made against the dev branch!
  • Take a look at CONTRIBUTING.MD
  • Reference any related issues.
  • Provide a description of the proposed changes.
  • PRs must pass Vint tests and add new Vader tests as applicable.
  • Make sure to update the documentation in doc/vimwiki.txt if applicable,
    including the Changelog and Contributors sections.

@tinmarino
Copy link
Member

Hi Reinerh,

Thank for the contribution.
This seems to be a very good job but I can't review easily. I think the integration would help some people. For example you on another machine.
Seeing all the effort you made I would ask you to add some conversion non regression tests: with the vader framework or copy pasted here and I manage the Vader format. You must explicit In and Out and user interaction, conf.
Also this is not Vint compliant (that is why it breaks the tests):

Starting Docker container and running Vint.
autoload/vimwiki/html.vim:1499:1: Use the abort attribute for functions in autoload (see Google VimScript Style Guide (Functions))
autoload/vimwiki/html.vim:1602:1: Use the abort attribute for functions in autoload (see Google VimScript Style Guide (Functions))
autoload/vimwiki/html.vim:1836:14: Use robust operators `==#` or `==?` instead of `==` (see Google VimScript Style Guide (Matching))

So to resume:

  1. Add some non regression test (or instructions on how to do some of them, working on your machine)
  2. Lint your code o be Vint compliant

Thank for your comprehension,

@tinmarino tinmarino added HTML conversion test-needed Add a non-regression test labels Jul 22, 2020
@reinerh
Copy link
Contributor Author

reinerh commented Jul 22, 2020

Thanks @tinmarino for having a look.
I just added Vader tests and fixed the linter warnings.

I think it's easier to review the commits individually, as the first commit was just doing some refactoring (moving around some code with different indentation, which blows up the diff).

@tinmarino
Copy link
Member

Thanks @tinmarino for having a look.
I just added Vader tests and fixed the linter warnings.

I think it's easier to review the commits individually, as the first commit was just doing some refactoring (moving around some code with different indentation, which blows up the diff).

Awesome ! 1/ Nice tests, 2/ pretty commit factoring, 3/ Really fast reacting.

I rebase all 3 to dev (without squashing).

@tinmarino tinmarino merged commit ca84701 into vimwiki:dev Jul 22, 2020
@tinmarino
Copy link
Member

Lol, this feature only costed me once click :-)
Thanks @reinerh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
HTML conversion test-needed Add a non-regression test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants