This sounds like a good idea. I don't know when I'll be able to get to it but I'll keep it in mind.

If you wish to start splitting things Pawel, please go for it.

+1

I'm working on this issue. I feel it's very hard to maintain/test now if they are not broken into smaller pieces.

Great @stevemao !

Thanks @pkozlowski-opensource , I have done https://github.com/stevemao/git-raw-commits and https://github.com/stevemao/conventional-commits-parser and I'm trying to do a writer. Those modules are pretty much based on this one but I added some other features. Please make comments/suggestions on these modules.

I have problems making the writer. I want the templating system of the writer as flexible as possible. Should I expose a lodash.template string? And because in https://github.com/stevemao/conventional-commits-parser I can get any part of a commit so this way it will be very flexible but a lodash.template string is pretty hard to construct especially one with if statements and nested loops, etc (I have problems making a default one but I think I can make it eventually). Or we can expose something like

{
  headerTemplate: '...',
  closingIssueTemplate: '...',
  bodyTemplate: '...',
  footerTemplate: '...'
}

This way it is very similar to the current implementation and just expose the template. But things like loops cannot be defined by users.

I think lodash.template is hard to use especially if there are too many if statements or nested loops. May be I should use something else?

@stevemao maybe it would be best to use a nunjucks template or similar to render the whole changelog... example:

{% block header %}
{{"###" if bump.patch else "##"}} {{title}} {{subtitle}} {{version}}
{% endblock %}

{% block body %}
{% for section in sections %}
#### {{section.name}}

{% for subject in section.subjects %}
{% block subject %}

{% set prefix = "\n  *" if subject.commits.length > 1 else "" %}

* **{{subject.name}}*: {% for commit in subject.commits -%} 

  {{prefix}} {{commit.subject}} ({% block commitLink -%}
    {% if repository -%} [{{commit.shortHash}}]({{repository}}) {% else %} {{commit.shortHash}} {% endif %}
  {%- endblock %}{% if commit.closes -%}
    {% for issue in commit.closes -%}
      {% set prefix = " " if loop.first else ", " %}
      {% block issueLink -%}
        {{prefix}}{% if repository -%}[#{{issue}}]({{repository}}/issues/{{issue}}){% else %}#{{issue}}{% endif %}
      {%- endblock %}
    {%- endfor %}
  {%- endif %})

  {# breaking change text #}
  {% if commit.body %}<br>{{commit.body}}{% endif %}

{%- endfor %} {# END COMMITS IN SUBJECT #}

{% endblock %} {# END SUBJECT BLOCK #}
{% endfor %}

Then people could overwrite the whole changelog template, or just bits and pieces by overriding the different blocks (eg block commitLink). Thoughts?

This looks beautiful, will dig into nunjucks 😄

Thanks @ajoslin!!

I've finished the last module https://github.com/stevemao/conventional-commits-template. It's based on handlebarjs. Will put together these modules. Please have a look when you can. Thanks.

Awesome, steve. Looks perfect.

Thank you @ajoslin , there are a few things I wanna do. eg: make the options more flexible and improve/modify the defaults etc... still a long way to go before they are perfect...

I mean the concept of everything that's going on looks perfect. Everything is modular, 100% customizable, and 100% pluggable.

How's it coming @stevemao? I just discovered that support for bitbucket(different commit link. "commits" vs "commit")-Jira(non-numerical issue keys. "DEV-123")-combination could be better and was pleased to see that you are dealing with breaking up the module which would make adding the support more easy. Is there anything I could maybe help with?

#51

Please checkout the rewrite on the master branch. Thanks.