Add help messages

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>

Author: rahlk

codeanalyzer/__main__.py

@@ -9,19 +9,74 @@
 from codeanalyzer.schema import model_dump_json
 from codeanalyzer.options import AnalysisOptions
 
+
 def main(
- input: Annotated[Path, typer.Option("-i", "--input", help="Path to the project root directory.")],
- output: Optional[Path] = typer.Option(None, "-o", "--output"),
- format: OutputFormat = typer.Option(OutputFormat.JSON, "-f", "--format"),
- analysis_level: int = typer.Option(1, "-a", "--analysis-level"),
- using_codeql: bool = typer.Option(False, "--codeql/--no-codeql"),
- using_ray: bool = typer.Option(False, "--ray/--no-ray"),
- rebuild_analysis: bool = typer.Option(False, "--eager/--lazy"),
- skip_tests: bool = typer.Option(True, "--skip-tests/--include-tests"),
- file_name: Optional[Path] = typer.Option(None, "--file-name"),
- cache_dir: Optional[Path] = typer.Option(None, "-c", "--cache-dir"),
- clear_cache: bool = typer.Option(False, "--clear-cache/--keep-cache"),
- verbosity: int = typer.Option(0, "-v", count=True),
+ input: Annotated[
+ Path, typer.Option("-i", "--input", help="Path to the project root directory.")
+ ],
+ output: Annotated[
+ Optional[Path],
+ typer.Option("-o", "--output", help="Output directory for artifacts."),
+ ] = None,
+ format: Annotated[
+ OutputFormat,
+ typer.Option(
+ "-f",
+ "--format",
+ help="Output format: json or msgpack.",
+ case_sensitive=False,
+ ),
+ ] = OutputFormat.JSON,
+ analysis_level: Annotated[
+ int,
+ typer.Option("-a", "--analysis-level", help="1: symbol table, 2: call graph."),
+ ] = 1,
+ using_codeql: Annotated[
+ bool, typer.Option("--codeql/--no-codeql", help="Enable CodeQL-based analysis.")
+ ] = False,
+ using_ray: Annotated[
+ bool,
+ typer.Option("--ray/--no-ray", help="Enable Ray for distributed analysis."),
+ ] = False,
+ rebuild_analysis: Annotated[
+ bool,
+ typer.Option(
+ "--eager/--lazy",
+ help="Enable eager or lazy analysis. Defaults to lazy.",
+ ),
+ ] = False,
+ skip_tests: Annotated[
+ bool,
+ typer.Option(
+ "--skip-tests/--include-tests",
+ help="Skip test files in analysis.",
+ ),
+ ] = True,
+ file_name: Annotated[
+ Optional[Path],
+ typer.Option(
+ "--file-name",
+ help="Analyze only the specified file (relative to input directory).",
+ ),
+ ] = None,
+ cache_dir: Annotated[
+ Optional[Path],
+ typer.Option(
+ "-c",
+ "--cache-dir",
+ help="Directory to store analysis cache. Defaults to '.codeanalyzer' in the input directory.",
+ ),
+ ] = None,
+ clear_cache: Annotated[
+ bool,
+ typer.Option(
+ "--clear-cache/--keep-cache",
+ help="Clear cache after analysis. By default, cache is retained.",
+ ),
+ ] = False,
+ verbosity: Annotated[
+ int, typer.Option("-v", count=True, help="Increase verbosity: -v, -vv, -vvv")
+ ] = 0,
 ):
  options = AnalysisOptions(
  input=input,
@@ -46,13 +101,17 @@ def main(
  if options.file_name is not None:
  full_file_path = options.input / options.file_name
  if not full_file_path.exists():
- logger.error(f"Specified file '{options.file_name}' does not exist in '{options.input}'.")
+ logger.error(
+ f"Specified file '{options.file_name}' does not exist in '{options.input}'."
+ )
  raise typer.Exit(code=1)
  if not full_file_path.is_file():
  logger.error(f"Specified path '{options.file_name}' is not a file.")
  raise typer.Exit(code=1)
- if not str(options.file_name).endswith('.py'):
- logger.error(f"Specified file '{options.file_name}' is not a Python file (.py).")
+ if not str(options.file_name).endswith(".py"):
+ logger.error(
+ f"Specified file '{options.file_name}' is not a Python file (.py)."
+ )
  raise typer.Exit(code=1)
 
  with Codeanalyzer(options) as analyzer:
@@ -85,6 +144,7 @@ def _write_output(artifacts, output_dir: Path, format: OutputFormat):
  f"Compression ratio: {artifacts.get_compression_ratio():.1%} of JSON size"
  )
 
+
 app = typer.Typer(
  callback=main,
  name="codeanalyzer",