Embold VSCode extension

About Embold:

Embold is an AI-based software analytics platform that helps teams analyse and improve software quality. It analyses source code across 4 dimensions: code issues, design issues, metrics and duplication, and surfaces issues which impact stability, robustness, security, and maintainability. The Embold Score helps teams understand risk areas and prioritise the most important fixes.

Embold for Visual Studio Code:

Embold VSCode extension uncovers potential code issues, vulnerabilities, metrics and hard-to-detect anti-patterns that make your code difficult to maintain and can lead to error-prone solutions. The extension currently supports C/C++, JAVA, JAVASCRIPT, TYPESCRIPT, C_SHARP.

How it works:

1. Right click on any CPP, JAVA, JAVASCRIPT, TYPESCRIPT, C_SHARP file or folder containing any of these files.
2. Click on 'Analyze Using Embold'. Please Note - First scan will take some time. This is because we are downloading packages on first scan. Next scans will be quick.

Analysis of output :

• After scan completion analysis results will show up on problems view.

• Show Description option is available on quick fix. For metric violation – quick fix will redirect to documentation page.

• For Design Issue – It will show new tab for insights with animated progress bar.

• For Code Issue – It will redirect to documentation page (https://rules.embold.io/).

Requirements:

1. Supported Vscode version: 1.62.0+
2. Cppcheck version : 2.4.1
3. Eslint version: v7.32.0
4. Tslint version: 5.9.1
5. Jshint (Optional - Only if you are enabling in Embold server) version : 2.9.5
6. Java version: 1.8 or higher
7. Supported Languages: C/CPP, Java, JavaScript, Typescript
8. Supported OS: Linux, Windows and Mac OS

Note :

For Mac OS following languages are not supported -

1. JavaScript
2. TypeScript
3. C#
4. C/CPP

Install Cppcheck -

windows -

1. Go to 'https://sourceforge.net/projects/cppcheck/files/cppcheck/2.4/cppcheck-2.4.1-x64-Setup.msi/download'.
2. Open downloaded .msi file.
3. Install Cppcheck.
4. Check version on cmd - cppcheck --version.

linux -

1. git clone --branch 2.9.x https://github.com/danmar/cppcheck.git /cppcheck
2. mkdir /cppcheck/build
3. cd /cppcheck/build
4. cmake ..
5. cmake --build . -- -j16
6. make install
7. cd /
8. rm -rf /cppcheck
9. cppcheck --version

Install Eslint -

Execute command from cmd/terminal – sudo npm install -g eslint@v7.32.0 #or sudo yarn add eslint@v7.32.0

Install Tslint -

Execute command from cmd/terminal – sudo npm install -g tslint@5.9.1 #or sudo yarn add tslint@5.9.1

Install Jshint -

Note : Jshint (Optional - Only if you are enabling in Embold server)

Execute command from cmd/terminal – sudo npm install -g jshint@2.9.5 #or sudo yarn add jshint@2.9.5

Embold Extension Settings -

1. Embold URL -
		Embold server URL.

2. Embold Token -
		Embold Access Token for user authentication Refer the [link](https://docs.embold.io/embold-access-token-eat) for more information.

3. Repository UID -
		This feature is currently only available for existing Embold On-Premise users.Refer the [link](https://github.com/acellere/embold-vscode-plugin/blob/HEAD/"https:/docs.embold.io/projects-repositories#get-repository-uid\) for more information.(Add in workspace setting.)

4. Repo sync -
	Enable this checkbox to sync repository configuration with server repository.(Enable in workspace setting.)

Proxy setting -

Add the following environment variables if you are using any custom proxy setting.

1.EMB_PROXY_HOST
  E.g. 192.168.1.127

2.EMB_PROXY_PORT
    3128

3.EMB_PROXY_USERNAME (Optional) 
4.EMB_PROXY_PASSWORD (Optional)

Restart vscode IDE once proxy settings are set.

Supported Rules: https://rules.embold.io/

Feedback

Feel free to use Embold Community to give feedback, request features or to report a bug.

LICENSE

https://docs.embold.io/end-user-license-agreement-eula-for-ide-plugins/