objectscriptQuality Release Notes

• Accept variable in hash reference class to execute a method in the context of another class

  s globalName=##class(Sample.MyMethod)(myVar).getSomething()

• Accept ##this in hash reference class to execute a method in the context of another class

  s globalName=##class(Sample.MyMethod)##this.getSomething()

• Allow special character ~ in property modifier SqlListDelimiter

  Property aListOf As %String [ SqlListDelimiter = ~, SqlListType = DELIMITED ];

• Accept local variable with property in a #dim declaration

  #dim car.color as Palette.DefaultColor;

• Accept parenthesis wrapping for $ZOBJPROPERTY function

  ($ZOBJPROPERTY(obj,propertyStream)).GetAt(index)

• Accept $ZOBJCLASSMETHOD function as argument for Job command
• Accept [Generated] property in the header routine

  ROUTINE myRoutine [Generated]

• Accept hash reference as argument for KILL command

  k ##this.something

• Accept more class modifiers:
  • TriggerClass
  • QueryClass
  • ProjectionClass
  • IndexClass
  • EmbeddedClass
  • ConstraintClass
• Accept more methods modifiers:
  • SqlRoutine
• Accept more query modifiers:
  • Deprecated
• Accept the following values for the Type modifier in an Index:
  • collatedkey
  • columnar

• Allow special character / in method modifier clientName
• Basic support for ZBREAK command
• Metadata updated for IRIS 2022.2
• Metadata updated for IRIS 2022.3
• Metadata updated for IRIS 2023.1
• Updated support for ObjectScript Package Manager Client - ZPM

• Automation of docker image

• 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 

• 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

• 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

• Recognize #SQLCompile Path preprocessor directive
• Recognize expressions in curly brackets

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

Full compatibility with SonarQube 7.3

• 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

Updated for compatibility with SonarQube 6.7

• Parsing improvements for &js, &html

• 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

• 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

• Add $QUERY as a valid indirection target

• 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