CLI. Added style command.

Author: idlesign

CHANGELOG.md

@@ -6,6 +6,7 @@
 * ++ Add 'ma' alias for 'makeapp' command.
 * ++ Added virtual environment creation on project rollout.
 * ++ CLI. Add 'publish' command.
+* ++ CLI. Added 'style' command.
 * ++ CLI. Added 'tools' command.
 * ++ CLI. Added 'up' command.
 * ++ CLI. Descriptions passed to 'change' command all go into a commit messages.

README.md

@@ -19,6 +19,7 @@ https://github.com/idlesign/makeapp
 * Easily add entries to your changelog.
 * Publish your application to remotes (VCS, PyPI) with a single command.
 * Easily bootstrap your development environment.
+* Run code styling/linting.
 
 ## Application scaffolding
 
@@ -85,6 +86,14 @@ ma tools
 ma up
 ```
 
+## Code style
+
+Apply code style with `style` command:
+
+``` bash
+ma style
+```
+
 ## Documentation
 
 https://makeapp.readthedocs.io/

docs/040_development.md

@@ -30,3 +30,11 @@ to drop the old one altogether and create a new one. Use the following command:
 ma up -r
 # or ma up --reset
 ```
+
+## Style code
+
+To style/lint your code use the following command: 
+
+```bash
+ma style
+```

docs/index.md

@@ -14,6 +14,7 @@
 * Easily add entries to your changelog.
 * Publish your application to remotes (VCS, PyPI) with single command.
 * Easily bootstrap your development environment.
+* Run code styling/linting.
 
 
 ## Requirements

ruff.toml

@@ -1,5 +1,8 @@
 target-version = "py310"
 line-length = 120
+exclude = [
+    "**/*.toml",
+]
 
 [format]
 quote-style = "single"

src/makeapp/apptools.py

@@ -8,7 +8,7 @@
 from .helpers.files import FileHelper
 from .helpers.vcs import VcsHelper
 from .helpers.venvs import VenvHelper
-from .utils import chdir, configure_logging, Uv
+from .utils import chdir, configure_logging, Uv, Ruff
 
 LOG = logging.getLogger(__name__)
 
@@ -506,6 +506,10 @@ def publish(self):
             self.vcs.push()
             DistHelper.upload()
 
+    def style(self):
+        LOG.info('Styling ...')
+        Ruff.check()
+
     def venv_init(self, *, reset: bool = False, register_tool: bool = False):
         self.venv.initialize(reset=reset)
 

src/makeapp/cli.py

@@ -225,6 +225,15 @@ def tools(debug, upgrade):
     click.secho('Done', fg='green')
 
 
+@entry_point.command()
+@option_debug
+def style(debug):
+    """Apply code style."""
+    project = Project(log_level=logging.DEBUG if debug else logging.INFO)
+    project.style()
+    click.secho('Done', fg='green')
+
+
 def main():
     try:
         entry_point(obj={})

src/makeapp/utils.py

@@ -151,6 +151,18 @@ def run_command(command: str, *, err_msg: str = '', env: dict | None = None, cap
     return data
 
 
+class Ruff:
+    """Ruff wrapper."""
+
+    @classmethod
+    def _run(cls, cmd: str) -> list[str]:
+        return run_command(f'ruff {cmd}', capture=False)
+
+    @classmethod
+    def check(cls, fix: bool = True) -> list[str]:
+        return cls._run(f'check{" --fix" if fix else ""}')
+
+
 class Uv:
     """Uv wrapper."""