objectscriptQuality for Visual Studio Code

objectscriptQuality for VSCode is an IDE extension that helps you detect and fix quality issues as you write code. Like a spell checker, this plugin squiggles flaws so they can be fixed before committing code. You can get it directly from the VS Code Marketplace and it will then detect new bugs and quality issues as you code (ObjectScript and JavaScript)

How it works

Simply open a INT, MAC, CLS or JS file, start coding, and you will start seeing issues reported by objectscriptQuality. Issues are highlighted in your code, and also listed in the ‘Problems’ panel.

You can access the detailed rule description directly from your editor, using the provided contextual menu.

Rules

Check the rules to see what objectscriptQuality can do for you:

• ObjectScript rules
• JavaScript rules

You will benefit from the following code analyzers: objectscriptQuality and SonarJS

Requirements

The only thing you need is a Java Runtime (JRE) 17+ installed on your computer.

objectscriptQuality should automatically find it but you can also explicitly set the path where the JRE is installed using the ‘objectscriptQuality.ls.javaHome’ variable in VS Code settings. For example:

{
    "objectscriptQuality.ls.javaHome": "C:\Program Files\Java\jdk-17"
}

Connected mode

You can connect objectscriptQuality to SonarQube >= 7.9 or SonarCloud to benefit from the same rules and settings that are used to inspect your project on the server. objectscriptQuality then hides in VSCode the issues that are marked as Won’t Fix or False Positive.

To configure the connection, have a look at objectscriptQuality in default user settings.

If you change something on the server such as the quality profile, you can trigger an update of the local cache using the “Update objectscriptQuality binding to SonarQube/SonarCloud” command on the command palette (search for “sonarlint”).

For security reasons, the token should not be stored in SCM with workspace settings.

Deactivate rules

Open the SonarLint Rules tab on the Browser panel and select the rule you want to modify and you will see the rule description on the right panel. On the very same line you selected, it will appear an icon to disable () or enable () the rule.

You can also do it directly from the Problems panel, when a file has been analyzed

Contributions and license

objectscriptQuality for VSCode is a software distributed under freeware basis. This software is composed of the objectscriptQuality plugin and a modified version of SonarLint.

SonarLint is a trademark of SonarSource S.A., and is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. See the GNU Lesser General Public License for more details.

CachéQuality for VSCode is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Feedback

The preferred way to discuss about objectscriptQuality for VSCode is by posting on the Project Issues tab. Feel free to ask questions, report issues, and give suggestions.