IBM zCodeFormatSettings

IBM Enterprise languages code formatter settings file for IBM zDevOps development tools such as Z Open Editor

Type object
File match zcodeformat.yaml zcodeformat.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/ibm-zcodeformatsettings/latest.json
Source https://raw.githubusercontent.com/IBM/zopeneditor-about/main/zcodeformat/zcodeformat-schema-0.0.1.json

Validate with Lintel

npx @lintel/lintel check
Type: object

JSON schema for zcodeformat.yaml or zcodeformat.json code formatter preferences files. Version 0.0.1 -- Licensed Materials - Property of IBM - (c) Copyright IBM Corporation 2022. All Rights Reserved.

Properties

additionalProperties
cobol object
10 nested properties
dataDivision object
Any of: variant, variant
4 nested properties
enableIndentation boolean

Enable indentation of record descriptions If false, startOfAreaA and indentLength are not allowed

Default: true
indentation object
2 nested properties
startOfAreaA integer

Start of Area A Cannot be used if enableIndentation is false

Default: 8
min=8max=11
indentLength integer

Indent Length Cannot be used if enableIndentation is false

Default: 3
min=0max=10
alignPictureClauses boolean

Align PICTURE Clauses

Default: true
alignValueClauses boolean

Align VALUE Clauses

Default: true
procedureDivision object
Any of: variant, variant
2 nested properties
enableIndentation boolean

Enable indentation of procedure divisions

Default: true
indentation object
Any of: variant, variant
6 nested properties
startOfAreaA integer

Start of Area A Cannot be used if enableIndentation is false

Default: 8
min=8max=11
startOfAreaB integer

Start of Area B Cannot be used if enableIndentation is false

Default: 12
min=12max=16
indentMultipleLineStatements integer

Multiple line statement indent length Cannot be used if enableIndentation is false use -1 to disable

Default: 3
min=0max=10
alignLists boolean

Align lists Cannot be used if enableIndentation is false

Default: true
indentForAllBlocks integer

Fixed indent length to use for all blocks Cannot be used if enableIndentation is false Cannot be used with other individual block indent values

Default: 3
min=0max=10
blocks object
reservedWordCase enum
Values: "none" "upper" "lower" "mixed"
userDefinedWordCase enum
Values: "none" "upper" "lower" "mixed"
commentCase enum
Values: "none" "upper" "lower" "mixed"
functionCase enum
Values: "none" "upper" "lower" "mixed"
dateFormatCase enum
Values: "none" "upper" "lower" "mixed"
compilerDirectiveCase enum
Values: "none" "upper" "lower" "mixed"
endOfAreaB integer

End of Area B

If -1, will use Margin R as the end of Area B

Default: -1
One of: variant, variant
lineWrappingStyle string

If indentation moves code beyond Area B

Default: "wrapToNextLine"
Values: "wrapToNextLine" "noIndent" "indentToAreaB" "indentPastAreaB"
copybook object
2 nested properties
codeCase enum
Values: "upper" "lower"
commentCase enum
Values: "upper" "lower"

Definitions

copybookCapitalizationOptions enum
cobolCapitalizationOptions enum
cobol object
dataDivision object
Any of: variant, variant
4 nested properties
enableIndentation boolean

Enable indentation of record descriptions If false, startOfAreaA and indentLength are not allowed

Default: true
indentation object
2 nested properties
startOfAreaA integer

Start of Area A Cannot be used if enableIndentation is false

Default: 8
min=8max=11
indentLength integer

Indent Length Cannot be used if enableIndentation is false

Default: 3
min=0max=10
alignPictureClauses boolean

Align PICTURE Clauses

Default: true
alignValueClauses boolean

Align VALUE Clauses

Default: true
procedureDivision object
Any of: variant, variant
2 nested properties
enableIndentation boolean

Enable indentation of procedure divisions

Default: true
indentation object
Any of: variant, variant
6 nested properties
startOfAreaA integer

Start of Area A Cannot be used if enableIndentation is false

Default: 8
min=8max=11
startOfAreaB integer

Start of Area B Cannot be used if enableIndentation is false

Default: 12
min=12max=16
indentMultipleLineStatements integer

Multiple line statement indent length Cannot be used if enableIndentation is false use -1 to disable

Default: 3
min=0max=10
alignLists boolean

Align lists Cannot be used if enableIndentation is false

Default: true
indentForAllBlocks integer

Fixed indent length to use for all blocks Cannot be used if enableIndentation is false Cannot be used with other individual block indent values

Default: 3
min=0max=10
blocks object
reservedWordCase enum
Values: "none" "upper" "lower" "mixed"
userDefinedWordCase enum
Values: "none" "upper" "lower" "mixed"
commentCase enum
Values: "none" "upper" "lower" "mixed"
functionCase enum
Values: "none" "upper" "lower" "mixed"
dateFormatCase enum
Values: "none" "upper" "lower" "mixed"
compilerDirectiveCase enum
Values: "none" "upper" "lower" "mixed"
endOfAreaB integer

End of Area B

If -1, will use Margin R as the end of Area B

Default: -1
One of: variant, variant
lineWrappingStyle string

If indentation moves code beyond Area B

Default: "wrapToNextLine"
Values: "wrapToNextLine" "noIndent" "indentToAreaB" "indentPastAreaB"
copybook object
codeCase enum
Values: "upper" "lower"
commentCase enum
Values: "upper" "lower"
dataDivIndent object
startOfAreaA integer

Start of Area A Cannot be used if enableIndentation is false

Default: 8
min=8max=11
indentLength integer

Indent Length Cannot be used if enableIndentation is false

Default: 3
min=0max=10
procDivIndent object
startOfAreaA integer

Start of Area A Cannot be used if enableIndentation is false

Default: 8
min=8max=11
startOfAreaB integer

Start of Area B Cannot be used if enableIndentation is false

Default: 12
min=12max=16
indentMultipleLineStatements integer

Multiple line statement indent length Cannot be used if enableIndentation is false use -1 to disable

Default: 3
min=0max=10
alignLists boolean

Align lists Cannot be used if enableIndentation is false

Default: true
indentForAllBlocks integer

Fixed indent length to use for all blocks Cannot be used if enableIndentation is false Cannot be used with other individual block indent values

Default: 3
min=0max=10
blocks object
17 nested properties
indentAtEndBlock integer

Indent length of AT END block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentAtEndOfPageBlock integer

Indent length of AT END OF PAGE block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentExecBlock integer

Indent length of EXEC block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 5
min=0max=10
indentEndExecPhrase boolean

Indent END-EXEC phrase Cannot be used if enableIndentation is false END-EXEC phrase will be indented with Exec Block

Default: true
indentIfBlock integer

Indent length of IF block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentInvalidKeyBlock integer

Indent length of INVALID KEY block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 8
min=0max=10
indentNotAtEndBlock integer

Indent length of NOT AT END block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentNotAtEndOfPageBlock integer

Indent length of NOT AT END OF PAGE block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentNotInvalidKeyBlock integer

Indent length of INVALID KEY Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentNotOnExceptionBlock integer

Indent length of NOT ON EXCEPTION block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentNotOnOverflowBlock integer

Indent length of NOT ON OVERFLOW block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentNotOnSizeErrorBlock integer

Indent length of NOT ON SIZE ERROR block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentOnExceptionBlock integer

Indent length of ON EXCEPTION block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentOnOverflowBlock integer

Indent length of ON OVERFLOW block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentOnSizeErrorBlock integer

Indent length of ON SIZE ERROR block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentPerformBlock integer

Indent length of PERFORM block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 8
min=0max=10
indentWhenBlock integer

Indent length of WHEN block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 5
min=0max=10
blockIndent object
indentAtEndBlock integer

Indent length of AT END block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentAtEndOfPageBlock integer

Indent length of AT END OF PAGE block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentExecBlock integer

Indent length of EXEC block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 5
min=0max=10
indentEndExecPhrase boolean

Indent END-EXEC phrase Cannot be used if enableIndentation is false END-EXEC phrase will be indented with Exec Block

Default: true
indentIfBlock integer

Indent length of IF block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentInvalidKeyBlock integer

Indent length of INVALID KEY block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 8
min=0max=10
indentNotAtEndBlock integer

Indent length of NOT AT END block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentNotAtEndOfPageBlock integer

Indent length of NOT AT END OF PAGE block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentNotInvalidKeyBlock integer

Indent length of INVALID KEY Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentNotOnExceptionBlock integer

Indent length of NOT ON EXCEPTION block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentNotOnOverflowBlock integer

Indent length of NOT ON OVERFLOW block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentNotOnSizeErrorBlock integer

Indent length of NOT ON SIZE ERROR block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 4
min=0max=10
indentOnExceptionBlock integer

Indent length of ON EXCEPTION block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentOnOverflowBlock integer

Indent length of ON OVERFLOW block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentOnSizeErrorBlock integer

Indent length of ON SIZE ERROR block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 3
min=0max=10
indentPerformBlock integer

Indent length of PERFORM block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 8
min=0max=10
indentWhenBlock integer

Indent length of WHEN block Cannot be used if enableIndentation is false Cannot be used if indentForAllBlocks is used

Default: 5
min=0max=10