Command changelog

README.rst

@@ -0,0 +1,191 @@
+=============
+Commitizen
+=============
+
+    Python 3 command-line utility to standardize commit messages and bump version
+
+
+.. image:: https://github.com/Woile/commitizen/workflows/Python%20package/badge.svg
+    :alt: Github Actions
+    :target: https://github.com/Woile/commitizen/actions
+
+.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square
+    :alt: Conventional Commits
+    :target: https://conventionalcommits.org
+
+.. image:: https://img.shields.io/pypi/v/commitizen.svg?style=flat-square
+    :alt: PyPI Package latest release
+    :target: https://pypi.org/project/commitizen/
+
+..  image:: https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square
+    :alt: Supported versions
+    :target: https://pypi.org/project/commitizen/
+
+.. image:: https://img.shields.io/codecov/c/github/Woile/commitizen.svg?style=flat-square
+    :alt: Codecov
+    :target: https://codecov.io/gh/Woile/commitizen
+
+.. image:: docs/images/demo.gif
+    :alt: Example running commitizen
+
+--------------
+
+**Documentation**: https://Woile.github.io/commitizen/
+
+--------------
+
+.. contents::
+    :depth: 2
+
+
+About
+==========
+
+Commitizen is a tool designed for teams.
+
+Its main purpose is to define a standard way of committing rules
+and communicating it (using the cli provided by commitizen).
+
+The reasoning behind it is that it is easier to read, and enforces writing
+descriptive commits.
+
+Besides that, having a convention on your commits makes it possible to
+parse them and use them for something else, like generating automatically
+the version or a changelog.
+
+
+Installation
+=============
+
+::
+
+    pip install -U commitizen
+
+::
+
+    poetry add commitizen --dev
+
+
+**Global installation**
+
+::
+
+    sudo pip3 install -U commitizen
+
+Features
+========
+
+- Command-line utility to create commits with your rules. Defaults: `conventional commits`_
+- Display information about your commit rules (commands: schema, example, info)
+- Bump version automatically using semantic verisoning based on the commits. `Read More <./docs/bump.md>`_
+- Generate a changelog using "Keep a changelog" (Planned feature)
+
+
+Commit rules
+============
+
+This client tool prompts the user with information about the commit.
+
+Based on `conventional commits`_
+
+This is an example of how the git messages history would look like:
+
+::
+
+    fix: minor typos in code
+    feat: new command update
+    docs: improved commitizens tab in readme
+    feat(cz): jira smart commits
+    refactor(cli): renamed all to ls command
+    feat: info command for angular
+    docs(README): added badges
+    docs(README): added about, installation, creating, etc
+    feat(config): new loads from ~/.cz and working project .cz .cz.cfg and setup.cfg
+
+And then, by using ``cz bump`` , you can change the version of your project.
+
+``feat`` to ``MINOR``
+``fix`` to ``PATCH``
+
+
+Commitizens
+===========
+
+These are the available committing styles by default:
+
+* cz_conventional_commits: `conventional commits`_
+* cz_jira: `jira smart commits <https://confluence.atlassian.com/fisheye/using-smart-commits-298976812.html>`_
+
+
+The installed ones can be checked with:
+
+::
+
+    cz ls
+
+
+
+Commiting
+=========
+
+Run in your terminal
+
+::
+
+    cz commit
+
+or the shortcut
+
+::
+
+    cz c
+
+
+Usage
+=====
+
+::
+
+    $ cz --help
+    usage: cz [-h] [--debug] [-n NAME] [--version]
+            {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
+            ...
+
+    Commitizen is a cli tool to generate conventional commits.
+    For more information about the topic go to https://conventionalcommits.org/
+
+    optional arguments:
+    -h, --help            show this help message and exit
+    --debug               use debug mode
+    -n NAME, --name NAME  use the given commitizen (default:
+                            cz_conventional_commits)
+    --version             get the version of the installed commitizen
+
+    commands:
+    {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
+        init                init commitizen configuration
+        commit (c)          create new commit
+        ls                  show available commitizens
+        example             show commit example
+        info                show information about the cz
+        schema              show commit schema
+        bump                bump semantic version based on the git log
+        changelog (ch)      generate changelog (note that it will overwrite
+                            existing file)
+        check               validates that a commit message matches the commitizen
+                            schema
+        version             get the version of the installed commitizen or the
+                            current project (default: installed commitizen)
+
+Contributing
+============
+
+Feel free to create a PR.
+
+1. Clone the repo.
+2. Add your modifications
+3. Create a virtualenv
+4. Run :code:`./scripts/test`
+
+
+.. _conventional commits: https://conventionalcommits.org/

commitizen/changelog.py

@@ -0,0 +1,133 @@
+"""
+# DESIGN
+
+## Parse CHANGELOG.md
+
+1. Get LATEST VERSION from CONFIG
+1. Parse the file version to version
+2. Build a dict (tree) of that particular version
+3. Transform tree into markdown again
+
+## Parse git log
+
+1. get commits between versions
+2. filter commits with the current cz rules
+3. parse commit information
+4. generate tree
+
+Options:
+- Generate full or partial changelog
+"""
+from typing import Generator, List, Dict, Iterable
+import re
+
+MD_VERSION_RE = r"^##\s(?P<version>[a-zA-Z0-9.+]+)\s?\(?(?P<date>[0-9-]+)?\)?"
+MD_CATEGORY_RE = r"^###\s(?P<category>[a-zA-Z0-9.+\s]+)"
+MD_MESSAGE_RE = r"^-\s(\*{2}(?P<scope>[a-zA-Z0-9]+)\*{2}:\s)?(?P<message>.+)"
+md_version_c = re.compile(MD_VERSION_RE)
+md_category_c = re.compile(MD_CATEGORY_RE)
+md_message_c = re.compile(MD_MESSAGE_RE)
+
+
+CATEGORIES = [
+    ("fix", "fix"),
+    ("breaking", "BREAKING CHANGES"),
+    ("feat", "feat"),
+    ("refactor", "refactor"),
+    ("perf", "perf"),
+    ("test", "test"),
+    ("build", "build"),
+    ("ci", "ci"),
+    ("chore", "chore"),
+]
+
+
+def find_version_blocks(filepath: str) -> Generator:
+    """
+    version block: contains all the information about a version.
+
+    E.g:
+    ```
+    ## 1.2.1 (2019-07-20)
+
+    ## Bug fixes
+
+    - username validation not working
+
+    ## Features
+
+    - new login system
+
+    ```
+    """
+    with open(filepath, "r") as f:
+        block: list = []
+        for line in f:
+            line = line.strip("\n")
+            if not line:
+                continue
+
+            if line.startswith("## "):
+                if len(block) > 0:
+                    yield block
+                block = [line]
+            else:
+                block.append(line)
+        yield block
+
+
+def parse_md_version(md_version: str) -> Dict:
+    m = md_version_c.match(md_version)
+    if not m:
+        return {}
+    return m.groupdict()
+
+
+def parse_md_category(md_category: str) -> Dict:
+    m = md_category_c.match(md_category)
+    if not m:
+        return {}
+    return m.groupdict()
+
+
+def parse_md_message(md_message: str) -> Dict:
+    m = md_message_c.match(md_message)
+    if not m:
+        return {}
+    return m.groupdict()
+
+
+def transform_category(category: str) -> str:
+    _category_lower = category.lower()
+    for match_value, output in CATEGORIES:
+        if re.search(match_value, _category_lower):
+            return output
+    else:
+        raise ValueError(f"Could not match a category with {category}")
+
+
+def generate_block_tree(block: List[str]) -> Dict:
+    tree: Dict = {"commits": []}
+    category = None
+    for line in block:
+        if line.startswith("## "):
+            category = None
+            tree = {**tree, **parse_md_version(line)}
+        elif line.startswith("### "):
+            result = parse_md_category(line)
+            if not result:
+                continue
+            category = transform_category(result.get("category", ""))
+
+        elif line.startswith("- "):
+            commit = parse_md_message(line)
+            commit["category"] = category
+            tree["commits"].append(commit)
+        else:
+            print("it's something else: ", line)
+    return tree
+
+
+def generate_full_tree(blocks: Iterable) -> Iterable[Dict]:
+    for block in blocks:
+        yield generate_block_tree(block)