UNPKG

ds-sfcoe-ailabs

Version:

AI-powered code review tool with static analysis integration for comprehensive code quality assessment.

87 lines (46 loc) • 2.67 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# summary Performs an AI-assisted review of code changes between two commits or branches. # description This command automates the process of generating code review comments for diffs in a Git repository by: - Creating a temporary directory containing the differences between the specified commits/branches. - Running a static code analysis over the diff, which produces SARIF data that includes diagnostic messages and hints regarding potential issues in the code. - Invoking an AI provider (e.g., AzureOpenAI) to generate review comments and code suggestions based on the collected hints and the actual code snippet. - Optionally, posting the AI-generated review comments as pull request comments on supported Git hosting providers (such as GitHub or BitBucket) when pull request information and credentials are provided. # examples - ds-sfcoe-ailabs pr-review --repo-dir ./ --ai-provider=AzureOpenAI --ai-model=gpt-4o-mini-eastus2 --ai-token=$OPENAI_TOKEN --git-provider=GitHub --git-token=$GITHUB_TOKEN--git-owner=DTS-Productivity-Engineering --git-repo=smartreview --pull-request-id=2 --from=HEAD --to=main # flags.repo-dir.summary Specifies the path to the local Git repository (default is current working directory). # flags.from.summary The base commit or branch from which changes are compared (default is "HEAD~1"). # flags.to.summary The target commit or branch to which changes are compared (default is "HEAD"). # flags.pull-request-id.summary Identifier for the pull request to which review comments should be posted (optional). # flags.sf-config-file.summary Path to the configuration file used by the SF Code Analyzer (optional). # flags.pmd-config-file.summary Path to the configuration file used by PMD (optional). # flags.ai-provider.summary The AI service provider to use (Required). Supported values: - OpenAI - AzureOpenAI - Anthropic # flags.ai-token.summary Authentication token for the AI provider (Required). # flags.ai-model.summary The model to use for generating code review suggestions (optional). # flags.ai-api-version.summary The API version of the model to be used for generating code review suggestions (optional). # flags.ai-api-endpoint.summary The API endpoint of the model to be used for generating code review suggestions (optional). # flags.git-provider.summary The Git hosting service to use for posting comments (optional). Supported values: - GitHub # flags.git-token.summary Authentication token for the Git provider (optional). # flags.git-owner.summary Repository owner's name for the Git provider (optional). # flags.git-repo.summary Repository name for the Git provider (optional).