Feature Request: Add indentation support for YAJL blocks

[matlid]

I would like YAJL start block to trigger an indent and YAJL end block to trigger an outdent, similar to how IF/ENDIF works.

This for:

• yajl_genOpen() / yajl_genClose()
• yajl_beginObj() / yajl_endObj()
• yajl_beginArray() / yajl_endArray()

[sebjulliand]

This seems very specific. Not sure it will fit in this extension.

[matlid]

Yes Seb it is, but for people using different type of open source solutions, like YAJL, there is a need to get the linter and the formatter to work with your solution. What about a solution were additional start and end blocks could be added/configured outside the built in linter/formatter? This inline with the snipet solution for RPG/RPGLE.

[sebjulliand]

Sure. But then these open source solution should provide an extension for that. This one is meant to be general purpose 😊
Unless the linter can be customized for this. But for now, it can't.

[matlid]

Seb,

This feature is critical because it directly impacts the Linter in Code for IBM i. Without it, the code becomes difficult to maintain and visually cluttered.

YAJL is an excellent open-source ILE alternative for efficiently handling JSON and HTTP buffering in modern RPGLE solutions.

While I am not yet a contributor to the Code for IBM i project, I’ve outlined a few architectural suggestions below:

1. Add the possibility to define Indent additional opcode blocks in the rpglint.json file:

"IndentAdditionalOpCodeBlocks" : [
{"startBlock" : "yajl_genOpen", "endBlock" : "yajl_genClose"},
{"startBlock" : "yajl_beginObj", "endBlock" : "yajl_endObj"},
{"startBlock" : "yajl_beginArray", "endBlock" : "yajl_endArray"}
]

2. Add the rule IndentAdditionalOpCodeBlocks to the paserType.ts:

export interface Rules {
.....
IndentAdditionalOpCodeBlocks?: {startBlock: string, endBlock: string}[];
.....
}

3. Map the startBlock and endBlock to list arrays in linter.ts:

... Not sure how to prepare the rules.IndentAdditionalOpCodeBlocks to xyz for the mapping below ...

const startAdditionalBlockList: string[] = xyz.map(item => item.startBlock);
const endAdditionalBlockList: string[] = xyz.map(item => item.endBlock);

4. Add the startAdditionalBlockList and endAdditionalBlockList to indent checks in linter.ts:

.....
if ([ endAdditionalBlockList,
ENDIF, ENDFOR, ENDDO, ELSE, ELSEIF, ON-ERROR, ON-EXCP, ENDMON, ENDSR, WHEN, WHEN-IS, WHEN-IN, OTHER, END-PROC, END-PI, END-PR, END-DS, END-ENUM, ENDSL
].includes(opcode)) {
.....
if ([ startAdditionalBlockList,
IF, ELSE, ELSEIF, FOR, FOR-EACH, DOW, DOU, MONITOR, ON-ERROR, ON-EXCP, ON-EXIT, BEGSR, SELECT, WHEN, WHEN-IS, WHEN-IN, OTHER, DCL-PROC, DCL-PI, DCL-PR, DCL-DS, DCL-ENUM
].includes(opcode)) {
.....

All the best!

Mats Lidström (Apper, Nice Solutions and Common Sweden) :-)

[richardm90]

I've had a similar experience with YAJL, I like to indent my JSON objects being built with YAJL too.

You can use the @rpglint-skip-indent directive (not documented) to skip the indent check for the next line, however this can look messy very quickly.

I've been thinking it would be nice to skip specific linter rules on a block of code. As an example ESLint allows directives such as /* eslint-disable */ and /* eslint-enable */, these can be wrapped around a block of code. As an enhancement this would achieve a similar result and could be used for other purposes.