objectscriptQuality Release Notes

3.4.2

(6 March, 2023)

Since version 3.0.0 we have renamed our product to fit better the target language analyzed: ObjectScript. We have also renamed all the related products like objectscriptQuality for Caché Studio, objectscriptQuality for Aterlier and objectscriptQuality for VSCode.

Since version 3.3.0 we have removed support for SonarQube previous to version 7.0.

What's new

Update InterSystems metadata package

Fixes

Improvements in Incompatible argument type in a method rule to avoid false positives:
- Recognize $lb and &listbuild return types as %List
- Recognize $j and &job return types as %String
- Recognize type of $this as the current class
Improvements in SQL Delimited Identifiers with double quotes rule to avoid false positives:
- Allow usage of method calls as parameters in query strings. (Ex. &sql(SELECT ServerType, MasterServerId Into :%USER("ServerId") FROM System WHERE ID = :%USER("ID")))

3.4.1

(20 February, 2023)

Since version 3.3.0 we have removed support for SonarQube previous to version 7.0.

What's new

Automation of docker image

3.4.0

(12 December, 2022)

Since version 3.3.0 we have removed support for SonarQube previous to version 7.0.

What's new

Compatibility up to SonarQube 9.7

3.3.2

(15 August, 2022)

Since version 3.3.0 we have removed support for SonarQube previous to version 7.0.

Fixes

Fix when used in kubernetes with helm

3.3.1

(8 August, 2022)

Since version 3.3.0 we have removed support for SonarQube previous to version 7.0.

What's new

Compatibility to deploy with Kubernetes
IRIS metadata update to recognize newer packages
Rule 'Variable declared but not used' renamed to Local variable declared but not used for clarity

Fixes

Improvements in Local variable declared but not used rule to avoid false positives:
- Avoid checking global variables in the method context
Improvements in ZPM compatibility
Improvements in Method lack return type rule to avoid false positives:
- On a method call using Job, there is no return expected

3.3.0

(16 February, 2022)

Since version 3.3.0 we have removed support for SonarQube previous to version 7.0.

What's new

Compatibility with SonarQube 9.0
Compatibility with Test Coverage Tool to generate a Cobertura metrics
Improvements on recognition of default database libraries deployed by Intersystems to obtain class properties
Added #UnDef preprocessor directive support
Support for $ZARCTAN command
Allow function routine without using braces
Improvements in inheritance management
Improvements in Incompatible argument type in a method rule to avoid false positives:
- New option to ignore 'Unable to determine type' error as ObjectScript will consider the parameter being passed as %String
- Allow using numbers for %Numeric expected type
- Allow using numbers for %Integer expected type
- Recognize the method %Id() as integer
- Recognize return types of method calls when used as arguments
- Optionally, assume MACROS have valid types when used as arguments
Improvements in 'Variable not found' rule to avoid false positives:
- Consider $INCREMENT ($I) function as a way for setting variables
- Consider $LIST function as a way for setting variables
- Consider a variable in the arguments of a FOR loop as a way for setting variables
```
for lndx=1:1:$ll(lelist) {
    set n = 1
}
```
Improvements in SQL Delimited Identifiers with double quotes rule to avoid false positives:
- Recognize double quoted variables when used in INTO and WHERE clauses of a &sql sentence
Improvements in No quit (or return) found rule to avoid false positives:
- Accept macros as return values
Improvements in Methods failing to return a result on all code paths rule to avoid false positives:
- Accept macros as return values
Parser revision

Fixes

Fixed argument indexation on Incompatible argument type in a method rule when using empty parameters
Fixed parsing XData closure
Allow usage of empty parameters on using Extends
Fixed parser error when using ##continue in macros

New rules

3.2.4

(6 August, 2021)

Since version 3.2.0 we have removed support for SonarQube previous to version 6.5.

What's new

New property to customize the list of file extensions to analyze. The list can be managed from SonarQube or through command line. For example:
```
-Dsonar.objectscript.file.suffixes=cls,inc
```

Fixes

When a license is invalid, an exception was thrown and no project could be analyzed

3.2.3

(29 July, 2021)

Since version 3.2.0 we have removed support for SonarQube previous to version 6.5.

What's new

Recognition of overriden system methods to avoid false positives in Method never invoked
Recognize a condition list in a DO...WHILE statement
Recognize comments in statement blocks
Recognize a macro usage in a #DIM statement
Allow usage of macros as argument
Allow special characters ~ and # in method modifiers
Support for ObjectScript function $ZISWIDE
Rule Incompatible argument type in a method now indicates the position of the incompatible argument
Improvements on Incompatible argument type in a method rule to avoid false positives:
- Better identification of system types
- Better identification of type when declared with #DIM

Fixes

Fix on ZPM support
Fix in JSON recognition
Parser fix for some statements with line breaks
Revision of LOCK command arguments recognition
Revision of $TEXT command arguments recognition
Fix on variable recognition when using numbers, underscore
Accept NoContext as class modifier
Manage indirection properly in MERGE command
Recognize property inheritance in Property not found rule
Fix inheritance recognition in some cases for Method not found rule
Fix inheritance recognition in some cases for Unsused method argument rule
Fixes on Incompatible argument type in a method rule to avoid false positives:
- Better recognition of system types
- Solve inheritance recognition in some cases
- Recognition of value 1 as boolean when boolean type is expected
- Usage of class properties
```
Throw ..ToCommand(##class(C8).#ErrRecordNotFound)
```

New rules

3.2.2

(11 May, 2021)

Since version 3.2.0 we have removed support for SonarQube previous to version 6.5.

What's new

Recognize Deprecated keyword on property definition
Recognize an extended SSVN reference |nspace| on ^$GLOBAL, ^$LOCK and ^$ROUTINE
Recognize #IfUnDef as alternate name for #IfNDef

Fixes

Fixes on ZPM support
Fixes for Sonarlint compatibility
Allow usage of dots in tagnames in a XData block
Improvements on No quit (or return) found rule to avoid false positives:
- Rule must not be evaluated on abstract methods
- Manage properly when all return paths are contained in a try-catch clause

3.2.1

(8 April, 2021)

Since version 3.2.0 we have removed support for SonarQube previous to version 6.5.

Fixes

Backward compatibility with sonar.host.url parameter in sonar scanner

3.2.0

(23 March, 2021)

Since version 3.2.0 we have removed support for SonarQube previous to version 6.5.

What's new

Added compatibility with SonarQube 8.3 and higher
Recognition of default database libraries deployed by Intersystems
Internal architecture improvements and updates
New API to create custom rules
Recognize ServerOnly on Relationship modifiers
Accept IRIS naming for non-direct use variables: r%Property and m%Property
Accept undocumented and deprecated $ZOBJNEXT for legacy code
Accept class type in INDEX property list definition
Ignore comments in SQL queries
Support for ObjectScript Package Manager Client - ZPM, analyzing only packages and files defined on the module.xml of the project
Support for ObjectScript functions:
- $ZLN
Improvements on Class not declared abstract rule to avoid false positives:
- Manage autogenerated functions on abstract classes

Fixes

$LU is a short for $LISTUPDATE
Fixes on parsing index definition
Fix type recognition on Incompatible argument type in a method rule
Fix on Class not declared abstract rule when class uses autogenerated methods
CompileAfter modifier assignment can be empty
Correct parsing of pattern match operator (?)
Solves type recognition on variable declaration when assignment is done using a function
Avoid checks when using an implementation language different than ObjectScript
Recognize parameters in labels
Recognize multiline expressions with comments
Recognize <?xml version="1.0"?> in XData
Recognize argument for job command: job @command
Recognize the position parameter expressions using * (asterisk) and *-n (an asterisk followed by a negative integer) on $LISTGET
Allow usage of quotation marks on INDEX name
On extent index, the "On property_expression_list" is optional
Keywords ELEMENTS and KEYS must be parsed case insensitive on arrays
Review of SqlFieldName modifier for Relationship
Review on rule Quit whitout arguments to avoid false positive when using labels in methods

New rules

Package %ZEN is deprecated

3.1.1

(3 August, 2020)

What's new

Recognize Deprecated keyword
Accept Sharded class keyword
Accept Requires method keyword

Accept import for a list of namespaces

Import (my.namespace1, my.namespace2, my.namespace3)

Accept usage of generic functions as arguments of DO command
```
do $I(t, -1)
```
Improvements on Method not found rule to avoid false positives:
- Recognize method when its class is imported
Improvements on Class not found rule to avoid false positives:
- Recognize class when its package is imported

Fixes

Accept ispl as valid value for Language method keyword
Nullpointer araised in rule Incompatible argument type in a method in some cases

New rules

3.1.0

(25 May, 2020)

What's new

Java 9 compatibility
Java 10 compatibility
Java 11 compatibility
Set of default profile adjusted to the most important rules
Accept readonly attribute on &html statement
Improvements on Class not found rule to avoid false positives:
- Recognize usage of system classes if declared in a set command
```
set xxx = %SYS%
```
Improvements on Variable not found rule to avoid false positives:
- Consider $ListBuild function as a way for setting variables
- Consider $ListNext function as a way for setting variables
- Consider $Data ($D) function as as way for setting variables on its second argument
- Consider READ command as as way for setting variables on its second argument
- Consider $Order function as as way for setting variables on its second argument
- Consider $Piece function as as way for setting variables in a set command
Improvements on Method not found rule to avoid false positives:
- Consider autogenerated ExtentFunc (non-documented) when extending from %Persistent
- Class autogenerated methods are taken in consideration
- Recognize usage of system classes if declared in a set comamand
```
set xxx = %SYS%
```
Improvements on Incompatible argument type in a method rule to avoid false positives:
- Analize return type on functions when used as argument
- Recognition of some system libraries
Incompatible argument type in a method now has an option to ignore the rule when it is unable to determine an argument type

Fixes

Event attributes on &html were not accepting ";" as valid javascript
Method not found rule was not considering parent class in some cases
Incompatible argument type in a method was not considering a {type} equivalent to LIBRARY.{type}
Variable not found was analyzing JSON strings
Error on read type of property on self class
Property not found was not recognizing properties in self class in some cases
Review on rule Quit whitout arguments to avoid false positive in some cases
Class not found was resolving wrong namespace in some cases

DependsOn modifier assignment can be empty

Class Example [ DependsOn = , ProcedureBlock ]

System roles were not allowed as class Owner

Class MyApp.Person Extends %Persistent [ Owner = {%Developer} ]  { //class members }

Allow usage of ellipsis for undetermined number of arguments in a label
```
ZPM(pArgs...) Do ##class(%ZPM.PackageManager).Shell(pArgs...) Quit
```
Quote marks are optionals for %%INSERT and %%UPDATE on SqlComputeOnChange
Accept Deprecated as class modifier

Accept Language class modifier with value "objectscript"

Method name(formal_spec) As returnclass [ Language = objectscript ] 
{    //implementation }

Parameters starting with % on parameter list of Property definition where not allowed
```
Property Payload As Patient(%JSONFIELDNAME = "package");
```
Accept the (ELEMENTS) or (KEYS) optional expression on INDEX

Minor review on parsing parameter list on Property definition

Property Manifest As %Stream.GlobalCharacterSearchable(%SIMILARITYINDEX = "ManifestSearchIndex");

Manage optional spacing properly for macros

New rules

3.0.0

(27 December, 2019)

What's new

Recognize #SQLCompile Path preprocessor directive
Recognize expressions in curly brackets

2.1.0

(15 July, 2019)

What's new

Ensemble Ready!
Accept JSON in XDATA body
Accept HTML expression between #
Accept deep class navigation on Index declaration

Recognition of a list of values in SqlComputeOnChange option on Property definition

Property name As classname [ SqlComputed, SqlComputeCode=sqlcomputecode, SqlComputeOnChange = propertynames ];

More debug information added in case you get a parser error on a file

Fixes

Method not found rule now distinguishes between a property and a method in a class call like ..call(x), where 'call' can be a method or an array property
Empty method rule ignores foreign method to avoid false positives
Improvement on Method never invoked rule to detect inheritance in more cases
Incompatible argument type in a method was generating a null pointer parsing when type was not defined
SoapAction method modifier was not accepting a String

New rules

2.0.3

(20 February, 2019)

What's new

Exclusion list of rules that requires project context while analyzing just a file in SonarLint

2.0.2

(1 February, 2019)

Fixes

Fixed inheritance recognition on Method not found evaluation

2.0.1

(28 January, 2019)

What's new

Full compatibility with SonarQube 7.3

2.0.0

(27 September, 2018)

Since this version, minimal SonarQube version required is 6.0

What's new

Ready for InterSystems IRIS platform
Compatibility with Sonarlint 2
Code Coverage support

Fixes

Methods failing to return a result on all code paths must not be evaluated on abstract class
No quit (or return) found must not be evaluted on absctract class
Solved bug on string recognition on Incompatible argument type in a method rule

1.3.7

(17 August, 2018)

What's new

Recognize more keywords on @Relationship annotation: Calculated, SqlComputeCode, SqlComputed, Transient
Recognize specifications on class Query: CONTAINID, ROWSPEC, COMPILEMODE and SELECTMODE
Recognize the delimiters #classcontext and #endclasscontext
Accept instructions without quotation marks on &html statement
Recognize inheritance for rules evaluation
Recognize resulSet.Data("...") as %String type
Recognize a relationship accessor in a class
Recognize empty string as false when evaluting a boolean type
Support for ObjectScript function $MVOCONV
New "Best Practice" option for rule Variable not found to allow strict or flexible evaluation (previous versions were strict evaluation). Next are additional validations when Best Practice mode is enabled:
- ByRef variables must be initialized
- Exception variable in catch clause must be initialized
- SQLCODE is considered declared and intialized after a &sql statement
- Assignment to :variable in a &sql statement must be initialized

Fixes

Recognize property SqlViewName
Allow optional postconditional on TSTART
RFC metric was accounting references to any Method/ClassMethod more than once
Method not found rule reviewed for a better exclusion of %ShortPackageNames
Class not declared abstract rule has been reviewed accordingly to abstract definition discussed with different COS developer teams: A class should be abstract if all methods are empty or declared as abstract, then class should be abstract
Properly distinguish a variable that starts with sql in a logic sentence from &sql function
Recognize multiline comments after commands and method calls were without a space separator
Don't trigger Class not found rule for system classes. Now will recognize system classes if declared zn %SYS%
Don't trigger Method not found rule for system classes. Now will recognize system classes if declared zn %SYS%
Dont' trigger Missing argument(s) in method call rule when using ByRef and/or Output parameters
Review of accepted system variables on Variable not found rule to avoid false positives
Recognize comments inside a &html

1.3.6

(27 March, 2018)

What's new

Recognize the keyword "SqlComputeOnChange" on triggered computed properties
"Usage of legacy flow control statements" split in two new rules: "Usage of legacy if/else flow control statements" and "Usage of legacy for flow control statements"

Fixes

Resolved null pointer parsing in Class not found rule
Method not found rule now excludes checks for %Classes, %Methods and %ShortPackageNames
Incompatible argument type in a method rule was requiring initialization for variables passed by reference
Incompatible argument type in a method rule now considers %String as the default type for the parameters with no type
Method with unexpected arguments rule was not treating arguments with default value as arguments
Property not found rule now skips validation for properties of instancies of %Classes
Improvements on Variable not found rule to avoid false positives:
- Now does not require to define a variable when calling $I(variable), as it is initiated automatically
- Now does not require to define a variable when passed by reference
- Now an argument used in a macro is considered to be initialized by the macro if not done before
- Now does not require to initialize a variable used as argument in a macro
- Was not recognizing #dim directive properly
- Now recognizes variable declaration and initialization in a FOR

New rules

1.3.5

(4 February, 2018)

What's new

Updated for compatibility with SonarQube 6.7

1.3.4

(29 November, 2017)

Fixes

Control division by zero on RFC Average metric
Avoid type check of indirection in SET command for rule Property not found
Avoid type check of indirection in SET command for rule Incompatible argument type in a method

1.3.3

(30 October, 2017)

What's new

Parsing improvements for &js, &html

Fixes

Allow empty items in the include statement of a class
```
Include (%syLDAP, %syLDAPFunc, , %sySite)
```
Allow variant with only indirection without assign for SET command
```
s @("vrowcount="_vmc)
```
Correction on the Halstead Volume calculation, when it's zero
Allow null type on optional arguments
Incompatible argument type in a method fix when no type is declared

1.3.2

(16 October, 2017)

Fixes

Query As class with parameters

1.3.1

(11 October, 2017)

What's new

Added optional "as" in a #dim variables
Added optional property in SystemVars
Added comment (type ;comment) in #dim
Added parameter_list for a property
Accept comments for XML in XData
Support for legacy $ZSYNC command
Support for legacy $ZPREVIOUS command
Support for preprocessor directives:
- #Undef
- #elseif

Fixes

$ZP is a short for $ZPrevious
$ZPosition does not have a short
XData namespaces for tag
Corrected way to parse comments just after block
Allow null value for arguments
Pseudofields in Data modifier for Index
Empty statements line after dot
Custom Index with As class
Correction of spaces recognition between arguments

1.3.0

(26 September, 2017)

Fixes

Adoption of Complexity/Class and Complexity/Functions for newer versions of SonarQube
SqlFieldName modifier for Relationship
Sql in Query can contain braces {}
Indirection can be with almost everything which can return a string
Routines may even not have header
$[zobj][class]method().prop
{Property*N} or {Property*n} ignore case
$MVV on left side of SET command
PatternMatching also can be used with indirections
NEW command can be used with indirection
ZKill fixed parsing different types of arguments
Fixed parsing XData

New rules

1.2.0

(17 August, 2017)

This version ends support for SonarQube 5.1 or previous one. You need to upgrade to a newer SonarQube version if you have not done it already.

What's new

Compatibility with SonarQube 5.2 or higher
Added support for MAC/INT/INC in UDL (appeared in 2016.2) or RO format
Added ##SafeExpression directive support
Added #include preprocessor directive
#def1arg preprocessor directive
Support for ##sql directive
$zobj(var/mode/ref) functions added
Support for private/public procedures
CodeMode accepts generator for Trigger

Fixes

Macro in #Define can start with %
Fixes errors in parsing XData body
Ignore case for ##continue directive
Only '%' it is also valid identifier for methods or for variables.
SqlName modifier for classes and methods can be in quotes
Allow comments in flow control before code block
Fixed grammar for BREAK command
WHILE command can have multiple comma delimited conditions
@indirection with global variable
BREAK command with an argument (extend or flag)
CLOSE command with multiple arguments
Allow comment just after DO command dots line in the same line with label
Legacy if command without any arguments
$ZT is a short for $ZTRAP command
In a block with curly braces, first statement can be without space
Fixed error with macro comments
#Dim with "class" in double-quotes
Trigger code syntax access to property
Triple slash comment for documentation
Fixes in Pattern Matching

1.1.3

(8 August, 2017)

What's new

Relationship oneProp As classA [ Cardinality = one, Inverse = manyProp, InitialExpression = initialexpression ];

Support for ObjectScript functions:
- $MVV
- $ZARCCOS
- $ZSIN
- $ZCOS
- $ZPOSITION
- $ZSE ($ZSEARCH)
- $NA ($NAME)
Support for preprocessor directives:
- #SQLCompile
- #IfNDef
- ##Expression
Allow ##Expression as an argument for QUIT command

Support for extent index and bitmap extent index

Index ClassNameI [ Extent ]
Index ClassNameI [ Extent, Type = bitmap ];

Recognize InitialExpression on Relationship modifiers

Relationship oneProp As classA [ InitialExpression = initialexpression ];

Fixes

Allow a postcondition in Job command
Allow a postcondition in Throw command
Minimal macrodefinition arguments count set to zero
Accept a counter reference property as argument for KILL command
```
k ..Context.Data
```
Accept a local variable as argument for ZKILL command

Accept Language=cache in a Trigger definition

Trigger Tr1 [ Event = INSERT, Language=cache ]

Accept row/object in a Foreach Trigger definition

Trigger Tr2 [ Event = INSERT, Foreach = row/object ]

Allow spaces around expression in &html
Indirection with direct self property
```
@i%Global@(\"subscript\")
```
Add field at hash reference class
```
##class({%%CLASSNAME}).%ClassName(1)
```
Allow self pointer grammar in $ZOBJ* functions
```
$ZOBJPROPERTY(obj,name).%Id()
```

1.1.2

(4 July, 2017)

Fixes

$LOCK command is not managed properly
Class Index does not support Collation
Pattern Matching Expressions with Alternating Patterns not recognized

1.1.1

(31 May, 2017)

What's new

Accept as valid a statement as the argument to a macro
Sonarlint compatibility
Support for ObjectScript functions:
- $LISTUPDATE
- $ZDASCII / $ZDA
- $ZDCHAR / $ZDC
- $ZLASCII / $ZLA
- $ZLCHAR / $ZLC
- $ZQASCII / $ZQA
- $ZQCHAR / $ZQC
- $ZWASCII / $ZWA
- $ZWCHAR / $ZWC

Fixes

Recognize #dim as valid between a try and catch statement
Review allowed DO command arguments
The first argument to $PROPERTY is optional

1.1.0

(29 August, 2016)

Commercial release of cachéQuality, based on license model.

What's new

Add $QUERY as a valid indirection target

Fixes

Rule Unused method argument fails when the argument is used inside tags belonging to another language
Fix regular expression for HTML statics

1.0.3

(16 May, 2016)

Fixes

Review of rules help and messages:

New rules

Local variable not previously declared

1.0.2

(12 May, 2016)

What's new

Refactor for a better naming
cachéQuality API for creation of rules has been slightly refactored
cachéQuality API published for create custom rules
Allow usage of parameters in rules
Improvement of the following rules:
- Implicit inspection of $TEST
Refactor of rules for better maintenance:
- Method argument with no type
- Unused method argument

Fixes

Improve checks on rules:
Review of rules help:
Don't trigger rules on abstract methods:
- ByRef/Output method argument not assigned
Don't trigger rules on "CodeMode = objectgenerator":
- Methods failing to return a result on all code paths

New rules

1.0.1

(2 May, 2016)

What's new

Small refactor of namespaces for better understanding

Fixes

Spelling mistake

1.0.0

(20 April, 2016)

What's new

This is the first version of the cachéQuality plugin, so everything is new!