JetBrains IDEs TCA Plugin

Supports installing the TCA Plugin in JetBrains IDEs, allowing you to view code issues within the IDE and trigger online/local code analysis.

Tips

JetBrains IDEs refers to a series of IDEs from JetBrains, including IntelliJ IDEA, PyCharm, WebStorm, PhpStorm, GoLand, etc.

Installation Guide

Install the Tencent Cloud Code Analysis plugin in the JetBrains IDEs Plugin Repository.

After successful installation, the Tencent Cloud Code Analysis icon will appear in the sidebar; click it to switch views.

重要说明

TCA 插件使用概述：当用户打开本地代码工程时，自动获取该工程的配置信息，与远端完成分析项目匹配，并拉取问题数据，与本地工程代码文件进行映射，进而展示代码问题，以及在本地提交代码后能够直接点击触发分析。
TCA 集成了众多工具，有轻型工具也有重型工具，考虑其分析耗时、版本跟踪等诸多因素，TCA 插件在设计上没有做成类似轻型工具插件的效果（即毫秒级分析单文件代码并显示代码问题，如 ESlint、Pylint 插件）。
插件安装完毕后，需要进行相关配置方可使用，请参照Usage Guide。

Usage Guide

需要先在 TCA 远端平台上创建好团队、项目，并完成代码库或源码包接入（即创建了对应分析项目），可参考Getting Started。如本地代码工程已存在对应的分析项目数据，则可跳过。
- 代码库接入：是指在平台点击接入代码库，登记代码库地址、凭证等信息，启动分析时会通过 git 命令拉取代码执行代码分析。
- 源码包接入：是指在平台点击接入源码包，上传源码包（将代码库压缩成源码包），启动分析时会解压源码包执行代码分析。
TCA 插件会读取 IDE 工作区的代码工程，自动获取该工程的配置信息，与远端完成分析项目匹配
如果代码工程未经过代码托管（如没有 .git/.svn 目录），则无法获取代码库地址、分支等信息，因此在插件页面点击配置分析项目时，只能选择输入源码包分析项目链接（需要该代码工程已在 TCA 远端平台完成源码包接入才会具有对应分析项目）。
根据以下指引完成插件登录以及相关配置。
After configuration is complete, you can view the code analysis results within the IDE.
TCA 插件在线、本地分析重要说明
- 未经过代码托管的工程，无法在插件上触发在线、本地分析！
- 在线分析：是指到远端平台对应的分析项目上执行分析，会在远端平台接入的分析节点上执行代码分析。
  - 代码变更后需要提交代码，并推送到代码仓库平台，再触发在线分析，否则远端无法拉取到最新的代码。
  - 在线分析可以依托平台节点资源，并发执行分析任务。
- 本地分析：是指通过本地客户端在本地启动代码分析。
  - 需要预先在本地安装代码分析客户端，并在插件内配置代码分析客户端安装目录（Local Cli Binary Path），并关闭增量分析（Incr Scan）。
  - 本地分析完毕后，问题数据会同步上传到远端平台。
  - 代码变更后需要提交代码，再触发本地分析，否则会存在以下问题：
    - 新增代码文件不会纳入分析范围！
    - 变更临时代码的问题对应版本号采用当前版本号，渲染代码问题时会导致问题渲染有误！