Merge pull request #12 from igordertigor/break/change-project-reading-interface

Maybe-Break/change project reading interface

Author: igordertigor

README.md

@@ -25,3 +25,22 @@ If you are inside a git repository, you can use semv to print the semantic versi
   v1.0.5 (no-eol)
 
 Note that this will have not change anything about your repository. It is up to you to use the printed version. An example for using the printed version is given in semv's own [release workflow](https://github.com/igordertigor/semv/blob/master/.github/workflows/attempt-release.yml).
+
+## Configuration
+
+You can configure semv via the `pyproject.toml` config file. Here are the defaults:
+```toml
+[tool.semv]
+invalid_commit_action = "warning"  # Could also be "error" or "skip"
+
+[tool.types]
+feat = "minor"
+fix = "patch"
+perf = "patch"
+chore = "valid"
+test = "valid"
+docs = "valid"
+ci = "valid"
+refactor = "valid"
+style = "valid"
+```

src/semv/commands.py

@@ -20,6 +20,11 @@ def version_string() -> Version:
         config = Config.parse(pyproject.read_text())
     else:
         config = Config()
+
+    if len(sys.argv) > 1 and sys.argv[1] == '--list-types':
+        print(config.format_types())
+        sys.exit(0)
+
     vcs = Git()
     cp = AngularCommitParser(config.invalid_commit_action)
     vi = DefaultIncrementer(

src/semv/config.py

@@ -1,12 +1,12 @@
-from typing import Dict, Any, Optional, Set
-import os
+from typing import Dict, Any, Set, List
 import tomli
 from dataclasses import dataclass, field
 from .types import InvalidCommitAction
 
 
 @dataclass
 class Config:
+    commit_types_major: Set[str] = field(default_factory=set)
     commit_types_minor: Set[str] = field(default_factory=lambda: {'feat'})
     commit_types_patch: Set[str] = field(
         default_factory=lambda: {'fix', 'perf'}
@@ -26,12 +26,51 @@ class Config:
     @classmethod
     def parse(cls, text: str):
         cfg = parse_toml_section(text)
-        for key in cfg:
-            if key.startswith('commit_types'):
-                cfg[key] = set(cfg[key])
-            elif key == 'invalid_commit_action':
-                cfg[key] = InvalidCommitAction(cfg[key])
-        return cls(**cfg)
+        if 'invalid_commit_action' in cfg:
+            cfg['invalid_commit_action'] = InvalidCommitAction(
+                cfg['invalid_commit_action']
+            )
+        if 'types' in cfg:
+            types_cfg = cls._reorganize_types(cfg.pop('types'))
+        else:
+            types_cfg = {}
+
+        return cls(**{**types_cfg, **cfg})
+
+    @staticmethod
+    def _reorganize_types(d: Dict[str, str]) -> Dict[str, Set[str]]:
+        out: Dict[str, List[str]] = {
+            'commit_types_major': [],
+            'commit_types_minor': [],
+            'commit_types_patch': [],
+            'commit_types_skip': [],
+        }
+        for type, level in d.items():
+            if level == 'valid':
+                level = 'skip'
+            out[f'commit_types_{level}'].append(type)
+        return {key: set(types) for key, types in out.items()}
+
+    def format_types(self) -> str:
+        out = []
+
+        def fmt(level: str, types: Set[str]) -> List[str]:
+            t = ', '.join(sorted(list(types)))
+            return [
+                f'Implies {level} increment:',
+                f'  {t}',
+            ]
+
+        if self.commit_types_major:
+            out.extend(fmt('major', self.commit_types_major))
+        if self.commit_types_minor:
+            out.extend(fmt('minor', self.commit_types_minor))
+        if self.commit_types_patch:
+            out.extend(fmt('patch', self.commit_types_patch))
+        if self.commit_types_skip:
+            out.extend(fmt('skip', self.commit_types_skip))
+            out[-2] = 'Other valid types:'
+        return '\n'.join(out)
 
 
 def parse_toml_section(s: str) -> Dict[str, Any]:

tests/cram/test_config2.t

@@ -0,0 +1,24 @@
+  $ semv --list-types
+  Implies minor increment:
+    feat
+  Implies patch increment:
+    fix, perf
+  Other valid types:
+    chore, ci, docs, refactor, style, test
+
+  $ echo "[tool.semv.types]" > pyproject.toml
+  $ echo 'break = "major"' >> pyproject.toml
+  $ echo 'feat = "minor"' >> pyproject.toml
+  $ echo 'perf = "minor"' >> pyproject.toml
+  $ echo 'fix = "patch"' >> pyproject.toml
+  $ echo 'chore = "valid"' >> pyproject.toml
+  $ echo 'docs = "valid"' >> pyproject.toml
+  $ semv --list-types
+  Implies major increment:
+    break
+  Implies minor increment:
+    feat, perf
+  Implies patch increment:
+    fix
+  Other valid types:
+    chore, docs