Migration considerations

Migration to v1.0.2

In IBM® ZCodeScan version 1.0.2, we are migrating the following rules to use parameters instead of statements field to improve the configuration consistency and clarity.

Affected Rules

The following rules have been updated with this change in this release:

• zcodescan.cobol.rules.ConditionNamePrefixRule
• zcodescan.cobol.rules.CopybookRule
• zcodescan.cobol.rules.FileNameConventionRule
• zcodescan.cobol.rules.InlinePerformLineLimitRule
• zcodescan.cobol.rules.NestedIfLimitRule
• zcodescan.cobol.rules.ParagraphCommentRule
• zcodescan.cobol.rules.ProcedureRule
• zcodescan.cobol.rules.RestrictedRoutineRule
• zcodescan.cobol.rules.SectionCommentRule
• zcodescan.cobol.rules.StaticCallNameRule

Migration impact

• The statements field is deprecated and will be removed in future releases.
• If you have previously defined custom rules that use the statements field, these rules will now trigger a validation error under the new rule schema.

For v1.0.1 and earlier:

- id: zcodescan.cobol.rules.NestedIfLimitRule
    severity: MEDIUM
    statements:
      - name: "NestingLimit"
        value: 6

For v1.0.2 and later:

- id: zcodescan.cobol.rules.NestedIfLimitRule
    severity: MEDIUM
    parameters:
      - name: "NestingLimit"
        value: 6

Action required

• You must replace the statements field with the parameters field to comply with the updated schema.

Benefits

• Consistency: To align with standard IBM ZCodeScan configuration patterns.
• Clarity: More intuitive parameter naming.
• Maintainability: Simplified rule configuration management.