Merge pull request #320 from dephell/inspect-versioning

Add inspect versioning command

dephell/commands/discover.py

@@ -35,9 +35,10 @@
     'inspect auth',
     'inspect config',
     'inspect gadget',
+    'inspect project',
     'inspect self',
     'inspect venv',
-    'inspect project',
+    'inspect versioning',
 
     'jail install',
     'jail list',

dephell/commands/inspect_versioning.py

@@ -0,0 +1,54 @@
+# built-in
+from argparse import ArgumentParser
+from pathlib import Path
+
+# external
+from dephell_versioning import get_rules
+
+# app
+from ..actions import make_json
+from ..config import builders
+from ..converters import CONVERTERS
+from .base import BaseCommand
+
+
+class InspectVersioningCommand(BaseCommand):
+    """Inspect the versioning rules of the project.
+    """
+    @classmethod
+    def get_parser(cls) -> ArgumentParser:
+        parser = cls._get_default_parser()
+        builders.build_config(parser)
+        builders.build_from(parser)
+        builders.build_output(parser)
+        builders.build_api(parser)
+        builders.build_other(parser)
+        return parser
+
+    def __call__(self) -> bool:
+
+        version = None
+        if 'from' in self.config:
+            loader = CONVERTERS[self.config['from']['format']]
+            loader = loader.copy(project_path=Path(self.config['project']))
+            root = loader.load(path=self.config['from']['path'])
+            version = root.version
+
+        scheme = self.config['versioning']
+        rules = get_rules(scheme=scheme)
+        data = dict(
+            version=version,
+            scheme=scheme,
+            rules=dict(
+                supported=sorted(rules),
+                unsupported=sorted(get_rules() - rules),
+            ),
+        )
+
+        print(make_json(
+            data=data,
+            key=self.config.get('filter'),
+            colors=not self.config['nocolors'],
+            table=self.config['table'],
+        ))
+        return True

docs/cmd-inspect-versioning.md

@@ -0,0 +1,37 @@
+# dephell inspect versioning
+
+Shows info about project versioning scheme and current version.
+
+```bash
+$ dephell inspect versioning
+{
+  "rules": {
+    "supported": [
+      "init",
+      "local",
+      "major",
+      "minor",
+      "patch",
+      "pre",
+      "premajor",
+      "preminor",
+      "prepatch",
+      "release"
+    ],
+    "unsupported": [
+      "dev",
+      "post"
+    ]
+  },
+  "scheme": "semver",
+  "version": "0.7.9"
+}
+```
+
+Read about schemes and rules in [dephell project bump](cmd-project-bump) docs.
+
+## See also
+
+1. [dephell project bump](cmd-project-bump) to bump project version.
+1. [dephell inspect project](cmd-inspect-project) to get information about the project metainfo.
+1. [dephell inspect config](cmd-inspect-config) to get information about the project configuration.

docs/cmd-project-bump.md

@@ -192,3 +192,7 @@ Custom version:
 $ dephell project bump 0.3.2
 INFO generated new version (old=0.1.0.post1.dev1, new=0.3.2)
 ```
+
+## See also
+
+1. [dephell inspect versioning](cmd-inspect-versioning) to get information about the project versioning scheme and available rules.

docs/index-inspect.md

@@ -1,6 +1,6 @@
 # **inspect**: info about environment
 
-Commands to get information about environment: [dephell config](cmd-inspect-config), [dephell ecosystem versions](cmd-inspect-self), [project metainfo](cmd-inspect-project), [virtual environment](cmd-inspect-venv), [stored credentials](cmd-inspect-auth).
+Commands to get information about environment: [dephell config](cmd-inspect-config), [dephell ecosystem versions](cmd-inspect-self), [project metainfo](cmd-inspect-project), [versioning scheme](cmd-inspect-versioning), [virtual environment](cmd-inspect-venv), [stored credentials](cmd-inspect-auth).
 
 ```eval_rst
 .. toctree::
@@ -11,4 +11,5 @@ Commands to get information about environment: [dephell config](cmd-inspect-conf
     cmd-inspect-project
     cmd-inspect-self
     cmd-inspect-venv
+    cmd-inspect-versioning
 ```