Skip to content

Commit f281d06

Browse files
add walkthrough
1 parent 94654dd commit f281d06

6 files changed

Lines changed: 452 additions & 0 deletions

File tree

package.json

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,51 @@
3333
],
3434
"main": "./dist/extension.js",
3535
"contributes": {
36+
"walkthroughs": [
37+
{
38+
"id": "codacy.setup",
39+
"title": "Get Started with Codacy",
40+
"description": "Set up Codacy to analyze your code, connect to the cloud, and enable AI guardrails.",
41+
"steps": [
42+
{
43+
"id": "codacy.walkthrough.cloudSync",
44+
"title": "Connect to Codacy",
45+
"description": "Create or sign-in to your account to customize analysis, PR overviews, see coverage in the IDE, and much more.\n\n[Connect to Codacy](command:codacy.codacyAuth)",
46+
"media": {
47+
"image": "resources/walkthrough/cloud-sync.svg",
48+
"altText": "Cloud sync illustration showing connection to Codacy"
49+
}
50+
},
51+
{
52+
"id": "codacy.walkthrough.aiGuardrails",
53+
"title": "Set Up AI Guardrails",
54+
"description": "Control your AI-generated code with Codacy Guardrails.\n\nInstall the MCP Server to get access to Codacy information from your AI agent.\n\n[Install Codacy MCP](command:codacy.configureMCP)",
55+
"media": {
56+
"image": "resources/walkthrough/ai-guardrails.svg",
57+
"altText": "Shield icon representing AI guardrails protection"
58+
}
59+
},
60+
{
61+
"id": "codacy.walkthrough.localAnalysis",
62+
"title": "Install Local Analysis",
63+
"description": "Get instant feedback as you type by analyzing your code locally.\n\n[Install Codacy CLI](command:codacy.installCLI)\n\nInstalls all required dependencies: Node, Python, Java",
64+
"media": {
65+
"image": "resources/walkthrough/local-analysis.svg",
66+
"altText": "Terminal showing Codacy CLI analyzing code"
67+
}
68+
},
69+
{
70+
"id": "codacy.walkthrough.customizeAnalysis",
71+
"title": "Customize Your Analysis",
72+
"description": "With your organization and repository added to Codacy, configure the patterns and standards you want to follow in the cloud and the IDE.\n\n[Configure patterns](command:codacy.configurePatterns)\n\nPlus you can adjust gates / goals for duplication, complexity and even coverage.",
73+
"media": {
74+
"image": "resources/walkthrough/customize-analysis.svg",
75+
"altText": "Settings icon representing customization"
76+
}
77+
}
78+
]
79+
}
80+
],
3681
"viewsContainers": {
3782
"activitybar": [
3883
{
@@ -332,6 +377,12 @@
332377
"title": "Install Codacy CLI",
333378
"category": "Codacy commands",
334379
"when": "!codacy:cliInstalled && codacy:canInstallCLI"
380+
},
381+
{
382+
"command": "codacy.configurePatterns",
383+
"title": "Configure Patterns",
384+
"category": "Codacy commands",
385+
"when": "Codacy:CodacyCloudStateContext == Loaded"
335386
}
336387
],
337388
"menus": {

resources/walkthrough/ai-guardrails.svg

Lines changed: 84 additions & 0 deletions
Loading

resources/walkthrough/cloud-sync.svg

Lines changed: 118 additions & 0 deletions
Loading

resources/walkthrough/customize-analysis.svg

Lines changed: 120 additions & 0 deletions
Loading

resources/walkthrough/local-analysis.svg

Lines changed: 73 additions & 0 deletions
Loading

src/extension.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,12 @@ const registerCommands = async (context: vscode.ExtensionContext, codacyCloud: C
117117
)
118118
Config.updateOnboardingSkipped(false)
119119
},
120+
'codacy.configurePatterns': () => {
121+
const { provider, organization, repository } = codacyCloud.params!
122+
vscode.env.openExternal(
123+
vscode.Uri.parse(`https://app.codacy.com/${provider}/${organization}/${repository}/patterns`)
124+
)
125+
},
120126
}
121127

122128
Object.keys(commands).forEach((cmd) => {

0 commit comments

Comments
 (0)