cifter-cli 0.1.0__tar.gz → 0.2.1__tar.gz

{cifter_cli-0.1.0 → cifter_cli-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cifter-cli
-Version: 0.1.0
+Version: 0.2.1
 Summary: C/C++ の関数実装を抽出する軽量 CLI
 Keywords: c,c++,cpp,cli,tree-sitter,source-extraction,static-analysis
 Author: t-kenji
@@ -10,7 +10,6 @@ License-File: LICENSE
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
@@ -18,6 +17,7 @@ Classifier: Programming Language :: C
 Classifier: Programming Language :: C++
 Classifier: Topic :: Software Development
 Requires-Dist: pcpp>=1.30
+Requires-Dist: rich>=14.3.3
 Requires-Dist: tree-sitter>=0.25.2
 Requires-Dist: tree-sitter-c>=0.24.1
 Requires-Dist: tree-sitter-cpp>=0.23.4
@@ -40,6 +40,7 @@ Description-Content-Type: text/markdown
 - 公開サブコマンドは `function` / `flow` / `path` の 3 つです
 - 出力は元ソースと対応付け可能な行番号付き text です
 - `-D NAME[=VALUE]` により条件分岐前処理を評価できます
+- 出力先が TTY の場合は既定でシンタックスハイライトします
 
 ## Why cifter
 
@@ -59,14 +60,16 @@ python -m pip install cifter-cli
 最小確認:
 
 ```sh
+cift --version
 cift --help
+python -m cifter --version
 python -m cifter --help
 ```
 
 GitHub Release の `wheel` / `sdist` から install することもできます。
 
 ```sh
-python -m pip install ./cifter_cli-0.1.0-py3-none-any.whl
+python -m pip install ./cifter_cli-0.2.1-py3-none-any.whl
 ```
 
 開発用:
@@ -78,40 +81,99 @@ uv run cift --help
 
 ## Quick Start
 
-サンプルソース:
+サンプルソース `foo.c`:
 
 ```c
-int FooFunction(int x)
+int DecideState(int x)
 {
+    int state = 0;
+    LogStart();
+
     if (x > 0) {
-        return 1;
+        Prepare();
+        state = 1;
+    } else {
+        PrepareFallback();
+        state = 2;
     }
 
-    return 0;
+    Finalize();
+    return state;
 }
 ```
 
-関数全体を抽出:
+まず全体を確認したいときは、関数をそのまま抜きます。
+
+```sh
+cift function --name DecideState --source foo.c
+```
+
+```text
+1: int DecideState(int x)
+2: {
+3:     int state = 0;
+4:     LogStart();
+5:
+6:     if (x > 0) {
+7:         Prepare();
+8:         state = 1;
+9:     } else {
+10:         PrepareFallback();
+11:         state = 2;
+12:     }
+13:
+14:     Finalize();
+15:     return state;
+16: }
+```
+
+分岐の骨格と、見たい値更新だけを薄く追いたいときは `flow` を使います。
 
 ```sh
-cift function --name FooFunction --source foo.c
+cift flow --function DecideState --source foo.c --track state
+```
+
+```text
+1: int DecideState(int x)
+2: {
+3:     int state = 0;
+6:     if (x > 0) {
+8:         state = 1;
+9:     } else {
+11:         state = 2;
+12:     }
+15:     return state;
+16: }
 ```
 
-出力:
+失敗側や `else` 側の 1 本だけを追って、その後に何が起きるかまで見たいときは `path` を使います。
+
+```sh
+cift path --function DecideState --source foo.c --route 'else'
+```
 
 ```text
-1: int FooFunction(int x)
+1: int DecideState(int x)
 2: {
-3:     if (x > 0) {
-4:         return 1;
-5:     }
-6:
-7:     return 0;
-8: }
+6:     if (x > 0) {
+9:     } else {
+10:         PrepareFallback();
+11:         state = 2;
+12:     }
+14:     Finalize();
+15:     return state;
+16: }
 ```
 
 ## Commands
 
+バージョン表示:
+
+```sh
+cift --version
+python -m cifter --version
+```
+
 `function`:
 指定した関数の実装全体をそのまま抽出します。レビュー対象の最小切り出しに向きます。
 
@@ -178,6 +240,8 @@ cift function --name FooFunction --source examples/demo.c -D DEF_FOO -D ENABLE_B
 
 ```sh
 cift function --name FooFunction --source examples/demo.c
+cift function --name FooFunction --source examples/demo.c --color
+cift function --name FooFunction --source examples/demo.c --no-color
 cift flow --function FooFunction --source examples/demo.c --track 'ctx->state'
 cift path --function FooFunction --source examples/demo.c --route 'case CMD_LOOP > if ret == OK'
 ```

{cifter_cli-0.1.0 → cifter_cli-0.2.1}/README.md

@@ -9,6 +9,7 @@
 - 公開サブコマンドは `function` / `flow` / `path` の 3 つです
 - 出力は元ソースと対応付け可能な行番号付き text です
 - `-D NAME[=VALUE]` により条件分岐前処理を評価できます
+- 出力先が TTY の場合は既定でシンタックスハイライトします
 
 ## Why cifter
 
@@ -28,14 +29,16 @@ python -m pip install cifter-cli
 最小確認:
 
 ```sh
+cift --version
 cift --help
+python -m cifter --version
 python -m cifter --help
 ```
 
 GitHub Release の `wheel` / `sdist` から install することもできます。
 
 ```sh
-python -m pip install ./cifter_cli-0.1.0-py3-none-any.whl
+python -m pip install ./cifter_cli-0.2.1-py3-none-any.whl
 ```
 
 開発用:
@@ -47,40 +50,99 @@ uv run cift --help
 
 ## Quick Start
 
-サンプルソース:
+サンプルソース `foo.c`:
 
 ```c
-int FooFunction(int x)
+int DecideState(int x)
 {
+    int state = 0;
+    LogStart();
+
     if (x > 0) {
-        return 1;
+        Prepare();
+        state = 1;
+    } else {
+        PrepareFallback();
+        state = 2;
     }
 
-    return 0;
+    Finalize();
+    return state;
 }
 ```
 
-関数全体を抽出:
+まず全体を確認したいときは、関数をそのまま抜きます。
+
+```sh
+cift function --name DecideState --source foo.c
+```
+
+```text
+1: int DecideState(int x)
+2: {
+3:     int state = 0;
+4:     LogStart();
+5:
+6:     if (x > 0) {
+7:         Prepare();
+8:         state = 1;
+9:     } else {
+10:         PrepareFallback();
+11:         state = 2;
+12:     }
+13:
+14:     Finalize();
+15:     return state;
+16: }
+```
+
+分岐の骨格と、見たい値更新だけを薄く追いたいときは `flow` を使います。
 
 ```sh
-cift function --name FooFunction --source foo.c
+cift flow --function DecideState --source foo.c --track state
+```
+
+```text
+1: int DecideState(int x)
+2: {
+3:     int state = 0;
+6:     if (x > 0) {
+8:         state = 1;
+9:     } else {
+11:         state = 2;
+12:     }
+15:     return state;
+16: }
 ```
 
-出力:
+失敗側や `else` 側の 1 本だけを追って、その後に何が起きるかまで見たいときは `path` を使います。
+
+```sh
+cift path --function DecideState --source foo.c --route 'else'
+```
 
 ```text
-1: int FooFunction(int x)
+1: int DecideState(int x)
 2: {
-3:     if (x > 0) {
-4:         return 1;
-5:     }
-6:
-7:     return 0;
-8: }
+6:     if (x > 0) {
+9:     } else {
+10:         PrepareFallback();
+11:         state = 2;
+12:     }
+14:     Finalize();
+15:     return state;
+16: }
 ```
 
 ## Commands
 
+バージョン表示:
+
+```sh
+cift --version
+python -m cifter --version
+```
+
 `function`:
 指定した関数の実装全体をそのまま抽出します。レビュー対象の最小切り出しに向きます。
 
@@ -147,6 +209,8 @@ cift function --name FooFunction --source examples/demo.c -D DEF_FOO -D ENABLE_B
 
 ```sh
 cift function --name FooFunction --source examples/demo.c
+cift function --name FooFunction --source examples/demo.c --color
+cift function --name FooFunction --source examples/demo.c --no-color
 cift flow --function FooFunction --source examples/demo.c --track 'ctx->state'
 cift path --function FooFunction --source examples/demo.c --route 'case CMD_LOOP > if ret == OK'
 ```

{cifter_cli-0.1.0 → cifter_cli-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cifter-cli"
-version = "0.1.0"
+version = "0.2.1"
 description = "C/C++ の関数実装を抽出する軽量 CLI"
 readme = "README.md"
 license = "MIT"
@@ -22,7 +22,6 @@ classifiers = [
     "Development Status :: 3 - Alpha",
     "Environment :: Console",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
@@ -32,6 +31,7 @@ classifiers = [
 ]
 dependencies = [
     "pcpp>=1.30",
+    "rich>=14.3.3",
     "tree-sitter>=0.25.2",
     "tree-sitter-c>=0.24.1",
     "tree-sitter-cpp>=0.23.4",

cifter_cli-0.2.1/src/cifter/__init__.py

@@ -0,0 +1,6 @@
+from cifter.cli import main
+from cifter.version import get_version
+
+__version__ = get_version()
+
+__all__ = ["__version__", "main"]

{cifter_cli-0.1.0 → cifter_cli-0.2.1}/src/cifter/cli.py

@@ -10,9 +10,10 @@ from cifter.errors import CiftError
 from cifter.extract_flow import extract_flow
 from cifter.extract_function import extract_function
 from cifter.extract_path import extract_path
-from cifter.model import TrackPath
+from cifter.model import ExtractionResult, TrackPath
 from cifter.parser import parse_source
-from cifter.render import render_result
+from cifter.render import print_result
+from cifter.version import format_version_output
 
 app = typer.Typer(no_args_is_help=True, help="C/C++ の関数実装を抽出する CLI")
 
@@ -21,6 +22,28 @@ def main() -> None:
     app()
 
 
+def _version_callback(value: bool) -> None:
+    if not value:
+        return
+    typer.echo(format_version_output())
+    raise typer.Exit()
+
+
+@app.callback()
+def common_options(
+    version: Annotated[
+        bool,
+        typer.Option(
+            "--version",
+            callback=_version_callback,
+            is_eager=True,
+            help="バージョンを表示して終了する",
+        ),
+    ] = False,
+) -> None:
+    _ = version
+
+
 SourceOption = Annotated[
     Path,
     typer.Option(
@@ -34,17 +57,30 @@ SourceOption = Annotated[
     ),
 ]
 
+ColorOption = Annotated[
+    bool | None,
+    typer.Option(
+        "--color/--no-color",
+        help="抽出結果のシンタックスハイライトを制御する",
+    ),
+]
+
 
 @app.command("function")
 def function_command(
     name: Annotated[str, typer.Option("--name", help="抽出する関数名")],
     source: SourceOption,
+    color: ColorOption = None,
     defines: Annotated[
         list[str] | None,
         typer.Option("--define", "-D", help="条件分岐評価に使うマクロ定義"),
     ] = None,
 ) -> None:
-    _run(lambda: render_result(extract_function(parse_source(source, defines or []), name)))
+    def task() -> tuple[ExtractionResult, str]:
+        parsed = parse_source(source, defines or [])
+        return extract_function(parsed, name), parsed.language_name
+
+    _run(task, color=color)
 
 
 @app.command("flow")
@@ -52,17 +88,18 @@ def flow_command(
     function_name: Annotated[str, typer.Option("--function", help="対象関数名")],
     source: SourceOption,
     track: Annotated[list[str], typer.Option("--track", help="保持するアクセスパス")] | None = None,
+    color: ColorOption = None,
     defines: Annotated[
         list[str] | None,
         typer.Option("--define", "-D", help="条件分岐評価に使うマクロ定義"),
     ] = None,
 ) -> None:
-    def task() -> str:
+    def task() -> tuple[ExtractionResult, str]:
         parsed = parse_source(source, defines or [])
         tracks = tuple(TrackPath.parse(value) for value in (track or []))
-        return render_result(extract_flow(parsed, function_name, tracks))
+        return extract_flow(parsed, function_name, tracks), parsed.language_name
 
-    _run(task)
+    _run(task, color=color)
 
 
 @app.command("path")
@@ -70,21 +107,23 @@ def path_command(
     function_name: Annotated[str, typer.Option("--function", help="対象関数名")],
     source: SourceOption,
     route: Annotated[str, typer.Option("--route", help="抽出する経路 DSL")],
+    color: ColorOption = None,
     defines: Annotated[
         list[str] | None,
         typer.Option("--define", "-D", help="条件分岐評価に使うマクロ定義"),
     ] = None,
 ) -> None:
-    def task() -> str:
+    def task() -> tuple[ExtractionResult, str]:
         parsed = parse_source(source, defines or [])
-        return render_result(extract_path(parsed, function_name, route))
+        return extract_path(parsed, function_name, route), parsed.language_name
 
-    _run(task)
+    _run(task, color=color)
 
 
-def _run(task: Callable[[], str]) -> None:
+def _run(task: Callable[[], tuple[ExtractionResult, str]], *, color: bool | None) -> None:
     try:
-        typer.echo(task())
+        result, language_name = task()
+        print_result(result, language_name, color=color)
     except CiftError as error:
         typer.echo(error.message, err=True)
         raise typer.Exit(code=1) from error

cifter_cli-0.2.1/src/cifter/render.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import sys
+from io import StringIO
+from typing import TextIO
+
+from rich.console import Console
+from rich.syntax import Syntax
+from rich.text import Text
+
+from cifter.model import ExtractionResult
+
+
+def render_result(result: ExtractionResult) -> str:
+    width = len(str(result.lines[-1].line_no))
+    return "\n".join(f"{line.line_no:>{width}}: {line.text}" for line in result.lines)
+
+
+def print_result(
+    result: ExtractionResult,
+    language_name: str,
+    *,
+    color: bool | None,
+    file: TextIO | None = None,
+) -> None:
+    output = file or sys.stdout
+    if not _should_use_color(color, output):
+        output.write(f"{render_result(result)}\n")
+        return
+
+    console = Console(
+        file=StringIO(),
+        record=True,
+        force_terminal=True,
+        color_system="truecolor",
+    )
+    syntax = Syntax("", language_name)
+    width = len(str(result.lines[-1].line_no))
+    for line in result.lines:
+        rendered_line = Text.assemble(
+            (f"{line.line_no:>{width}}: ", "dim"),
+            syntax.highlight(line.text)[:-1],
+        )
+        console.print(rendered_line)
+    output.write(console.export_text(styles=True))
+
+
+def _should_use_color(color: bool | None, file: TextIO) -> bool:
+    if color is not None:
+        return color
+    isatty = getattr(file, "isatty", None)
+    if not callable(isatty):
+        return False
+    return bool(isatty())

cifter_cli-0.2.1/src/cifter/version.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+import tomllib
+from importlib.metadata import PackageNotFoundError, version
+from pathlib import Path
+
+PACKAGE_NAME = "cifter-cli"
+COMMAND_NAME = "cift"
+
+
+def get_version() -> str:
+    try:
+        return version(PACKAGE_NAME)
+    except PackageNotFoundError:
+        return _read_version_from_pyproject()
+
+
+def format_version_output() -> str:
+    return f"{COMMAND_NAME} {get_version()}"
+
+
+def _read_version_from_pyproject() -> str:
+    pyproject_path = Path(__file__).resolve().parents[2] / "pyproject.toml"
+    data = tomllib.loads(pyproject_path.read_text(encoding="utf-8"))
+    project = data.get("project")
+    if not isinstance(project, dict):
+        raise RuntimeError("pyproject.toml に project セクションがありません")
+    version_value = project.get("version")
+    if not isinstance(version_value, str):
+        raise RuntimeError("pyproject.toml の project.version が文字列ではありません")
+    return version_value

cifter_cli-0.1.0/src/cifter/__init__.py

@@ -1,3 +0,0 @@
-from cifter.cli import main
-
-__all__ = ["main"]

cifter_cli-0.1.0/src/cifter/render.py

@@ -1,8 +0,0 @@
-from __future__ import annotations
-
-from cifter.model import ExtractionResult
-
-
-def render_result(result: ExtractionResult) -> str:
-    width = len(str(result.lines[-1].line_no))
-    return "\n".join(f"{line.line_no:>{width}}: {line.text}" for line in result.lines)