Skip to content

Support case check on subfields #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
worksofliam merged 3 commits into from
Jul 14, 2025
Merged

Support case check on subfields #404

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a75735d
Initial work to support case check on subfields
worksofliam Jul 14, 2025
e50816c
Refactor how errors are collected
worksofliam Jul 14, 2025
08e20d0
Fix incorrect variable case detection for subfields
worksofliam Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 74 additions & 85 deletions language/linter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,9 +171,6 @@ export default class Linter {
const currentProcedure = globalScope.procedures.find(proc => proc.position.path === data.uri && lineNumber >= proc.range.start && lineNumber <= proc.range.end);
const currentScope = globalScope.merge(inProcedure && currentProcedure ? currentProcedure.scope : undefined);

// Only fetch the names if we have a rule that requires it. It might be slow.
const definedNames = (rules.IncorrectVariableCase || rules.SQLHostVarCheck ? currentScope.getNames() : []);

let value;
let isEmbeddedSQL = false;

Expand Down Expand Up @@ -699,7 +696,7 @@ export default class Linter {

if (rules.SQLHostVarCheck) {
statement.forEach((part, index) => {
if (part.type === `word` && definedNames.some(name => name.toUpperCase() === part.value.toUpperCase())) {
if (part.type === `word` && currentScope.findDefinition(lineNumber, part.value)) {
const prior = statement[index - 1];
if (prior && ![`dot`, `seperator`].includes(prior.type)) {
errors.push({
Expand Down Expand Up @@ -821,24 +818,6 @@ export default class Linter {

const isDeclare = [`declare`, `end`].includes(statement[0].type);

if (rules.IncorrectVariableCase) {
// Check the casing of the reference matches the definition
if ((isEmbeddedSQL === false || (isEmbeddedSQL && statement[i - 1] && statement[i - 1].type === `seperator`))) {
const possibleKeyword = (isDeclare || inPrototype || inStruct.length > 0) && i >= 0 && statement[i + 1] && statement[i + 1].type === `openbracket`;

if (!possibleKeyword && !isDirective) {
const definedName = definedNames.find(defName => defName.toUpperCase() === upperName);
if (definedName && definedName !== part.value) {
errors.push({
offset: part.range,
type: `IncorrectVariableCase`,
newValue: definedName
});
}
}
}
}

if ((isDeclare && i >= 2) || !isDeclare) {
if (rules.RequiresParameter && !inPrototype && !isDeclare) {
// Check the procedure reference has a block following it
Expand Down Expand Up @@ -1026,102 +1005,112 @@ export default class Linter {
});
}

if (rules.NoUnreferenced) {
if (rules.NoUnreferenced || rules.IncorrectVariableCase) {
const noRefCheck = (def: Declaration) => {
if (def.name !== undefined && def.name.toUpperCase() !== NO_NAME && def.position.path === data.uri) {
if (def.references.length <= 1) {
const possibleStatement = doc.getStatementByLine(def.position.range.line);
if (possibleStatement) {
errors.push({
type: `NoUnreferenced`,
offset: { start: possibleStatement.range.start, end: possibleStatement.range.end }
});
}
}
}
}
const casingCheck = (def: Declaration) => {
if (def.name !== undefined && def.name.toUpperCase() !== NO_NAME) {
def.references.forEach(ref => {
if (ref.uri === data.uri) { // We're only checking the active file
if (!errors.some(e => e.offset.start === ref.offset.start)) { //This is required because LIKEDS shares subfields
const contentPosition = data.content.substring(ref.offset.start, ref.offset.end);
if (contentPosition !== def.name) {
errors.push({
type: `IncorrectVariableCase`,
offset: { start: ref.offset.start, end: ref.offset.end },
newValue: def.name
});
}
}
}
});
}
}

[
globalScope,
...globalScope.procedures.filter(proc => proc.scope !== undefined).map(proc => proc.scope)
].forEach(dec => {
[...dec.constants, ...dec.variables]
.filter(def => def.position.path === data.uri)
.forEach(def => {
if (def.references.length <= 1) {
// Add an error to def
const possibleStatement = doc.getStatementByLine(def.position.range.line);
if (possibleStatement) {
errors.push({
type: `NoUnreferenced`,
offset: { start: possibleStatement.range.start, end: possibleStatement.range.end }
});
}
if (rules.NoUnreferenced) {
noRefCheck(def);
}

if (rules.IncorrectVariableCase) {
casingCheck(def);
}
});

dec.subroutines
.filter(def => def.position.path === data.uri && def.name && ![`*INZSR`, `*PSSR`].includes(def.name.toUpperCase()))
.filter(def => def.name && ![`*INZSR`, `*PSSR`].includes(def.name.toUpperCase()))
.forEach(def => {
if (def.references.length <= 1) {
// Add an error to def
const possibleStatement = doc.getStatementByLine(def.position.range.line);
if (possibleStatement) {
errors.push({
type: `NoUnreferenced`,
offset: { start: possibleStatement.range.start, end: possibleStatement.range.end }
});
}
if (rules.NoUnreferenced) {
noRefCheck(def);
}

if (rules.IncorrectVariableCase) {
casingCheck(def);
}
});

dec.procedures
.filter(struct => struct.position.path === data.uri)
.forEach(proc => {
if (!proc.keyword[`EXPORT`]) {
if (proc.references.length <= 1) {
// Add an error to proc
const possibleStatement = doc.getStatementByLine(proc.position.range.line);
if (possibleStatement) {
errors.push({
type: `NoUnreferenced`,
offset: { start: possibleStatement.range.start, end: possibleStatement.range.end }
});
}
if (rules.NoUnreferenced) {
noRefCheck(proc);
}

if (rules.IncorrectVariableCase) {
casingCheck(proc);
}

if (!proc.keyword[`EXTPGM`] && !proc.keyword[`EXTPROC`]) {
proc.subItems.forEach(parm => {
if (parm.references.length <= 1) {
const possibleStatement = doc.getStatementByLine(parm.position.range.line);
if (possibleStatement) {
errors.push({
type: `NoUnreferenced`,
offset: { start: possibleStatement.range.start, end: possibleStatement.range.end }
});
}
if (rules.NoUnreferenced) {
noRefCheck(parm);
}

if (rules.IncorrectVariableCase) {
casingCheck(parm);
}
});
}
}
});

dec.structs
.filter(struct => struct.position.path === data.uri)
.forEach(struct => {
const subFieldIsUsed = struct.subItems.some(subf => subf.references.length > 1);

if (struct.references.length <= 1) {
struct.subItems.forEach(subf => {
// We only check the subfields if the parent is never references.
if (rules.NoUnreferenced && struct.references.length <= 1) {
noRefCheck(subf);
}

struct.subItems.forEach(subf => {
if (subf.name !== NO_NAME && subf.references.length <= 1) {
// Add an error to subf
const possibleStatement = doc.getStatementByLine(subf.position.range.line);
if (possibleStatement) {
errors.push({
type: `NoUnreferenced`,
offset: { start: possibleStatement.range.start, end: possibleStatement.range.end }
});
}
}
});

if (subFieldIsUsed === false) {
const possibleStatement = doc.getStatementByLine(struct.position.range.line);
if (possibleStatement) {
errors.push({
type: `NoUnreferenced`,
offset: { start: possibleStatement.range.start, end: possibleStatement.range.end }
});
}
if (rules.IncorrectVariableCase) {
casingCheck(subf);
}
});

const subFieldIsUsed = struct.subItems.some(subf => subf.references.length > 1);
if (rules.NoUnreferenced && subFieldIsUsed === false) {
noRefCheck(struct);
}

if (rules.IncorrectVariableCase) {
casingCheck(struct);
}
});
});
Expand Down
12 changes: 6 additions & 6 deletions tests/suite/directives.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ test('skip3', async () => {
`return`,
].join(`\n`);

const cache = await parser.getDocs(uri, lines, { withIncludes: true, ignoreCache: true });
const cache = await parser.getDocs(uri, lines, { withIncludes: true, ignoreCache: true, collectReferences: true });
const { errors } = Linter.getErrors({ uri, content: lines }, {
IncorrectVariableCase: true
}, cache);
Expand Down Expand Up @@ -286,7 +286,7 @@ test('eof5_issue181', async () => {
`End-Proc;`,
].join(`\n`);

const cache = await parser.getDocs(uri, lines, { withIncludes: true, ignoreCache: true });
const cache = await parser.getDocs(uri, lines, { withIncludes: true, ignoreCache: true, collectReferences: true });
const { errors } = Linter.getErrors({ uri, content: lines }, {
IncorrectVariableCase: true
}, cache);
Expand Down Expand Up @@ -479,26 +479,26 @@ test('variable_case1', async () => {
`Return;`
].join(`\n`);

const cache = await parser.getDocs(uri, lines, { withIncludes: true, ignoreCache: true });
const cache = await parser.getDocs(uri, lines, { withIncludes: true, ignoreCache: true, collectReferences: true });
const { errors } = Linter.getErrors({ uri, content: lines }, {
IncorrectVariableCase: true
}, cache);

expect(errors.length).toBe(3);

expect(errors[0]).toMatchObject({
expect(errors).toContainEqual({
offset: { start: 86, end: 100 },
type: `IncorrectVariableCase`,
newValue: `CustomerName_t`
});

expect(errors[1]).toMatchObject({
expect(errors).toContainEqual({
offset: { start: 174, end: 188 },
type: `IncorrectVariableCase`,
newValue: `CustomerName_t`
});

expect(errors[2]).toMatchObject({
expect(errors).toContainEqual({
offset: { start: 218, end: 232 },
type: `IncorrectVariableCase`,
newValue: `CustomerName_t`
Expand Down
Loading