[Feature] Implement diagnostic and quick fix for missing configuration #451

Wagner-Laranjeiras · 2025-10-17T14:57:09Z

[Feature] Implement diagnostic and quick fix for missing configuration and [Bugfix] Fix non existent lib breaking all INCLUDES.

Issue: XXX

Summary:
[Feature] This PR introduces a new Diagnostic (_TB002) and Quick Fix action (pli.applyQuickFixCreateConfig) for missing files. When the config files are not present, the diagnostic will be thrown at the file in the %INCLUDE. The Quick Fix will then offer creating the configuration, having the current file as the program entry point.
[Bugfix] Fix INCLUDES resolution breaking because of non existent directory added to libs.

Changes

apply-quick-fixes.ts file now has a generic function which calls more specific functions based on the current diagnostic.
New commands.ts file, which contains functions called at the connection-handler.
New constants.ts file, which contains namespaces for the Commands codes and PluginConfiguration.
New check for throwing diagnostic at the instruction-interpreter.ts file. Now, before trying to resolve an INCLUDE, we check if the full configuration is present (via the new helper "hasFullConfig()") and throw the new Diagnostic if it's not.
Modify readDir function to catch error when trying to read directory and return an empty array if it's the case.

Notes

Tests are still a work in progress.
Specific issue for this PR is not yet created.
I'll look into the commented code that needs to be cleaned up.

github-actions · 2025-10-17T14:58:30Z

PR Preview Action v1.6.0
🚀 View preview at https://zowe.github.io/zowe-pli-language-support/pr/pr-451/
Built to branch `previews` at 2025-10-30 12:53 UTC. Preview will be ready when the GitHub Pages deployment is complete.

msujew

I've noticed that our .pluplugin directory handling is a bit inaccurate in case the user opens multiple workspace folders. See #454 as a potential follow up on this.

packages/language/src/language-server/code-actions/apply-quick-fixes.ts

packages/language/src/workspace/file-system-provider.ts

packages/language/src/language-server/commands.ts

packages/language/src/language-server/code-actions/apply-quick-fixes.ts

packages/language/src/preprocessor/instruction-interpreter.ts

packages/language/src/workspace/plugin-configuration-provider.ts

packages/vscode-extension/src/extension/main.ts

… Libs bug for inexistent lib. Signed-off-by: Wagner Laranjeiras <[email protected]>

Signed-off-by: Wagner Laranjeiras <[email protected]>

msujew · 2025-10-29T11:20:59Z

packages/language/src/preprocessor/instruction-interpreter.ts

-      };
+    let diagnostic: Diagnostic;
+
+    if (!(await hasFullConfig())) {


Suggestion: I don't think we necessarily need to wait here for the file system. Assuming the current unit has a config available to it, it will be accessible via the processGroup/programConfig field. Accessing the file system might considerably slow down the interpreter in the error case.

msujew · 2025-10-29T11:24:03Z

packages/language/src/preprocessor/instruction-interpreter.ts

+      diagnostic = diagnosticFromCode(
+        InternalCodes.DiagnosticMissingConfiguration,
+        item.token,
+      );
+      diagnostic.data = { entryUri: context.entryUri.toString() };


Suggestion: This shouldn't be implemented as an internal code. Internal codes are internal, because they shouldn't be displayed to the user. Generating this diagnostic however will show the internal code to the user. Reuse the IBM3841I code instead and add additional data into the .data field to differentiate between the quick fixes that are applied to these diagnostics.

Ah ok. I understood that Internal codes were custom ones we had generate outside of the PLI-Codes.

msujew · 2025-10-29T11:24:21Z

packages/language/src/validation/internal-codes.ts

+  DiagnosticMissingConfiguration: {
+    code: "_TB002",
+    severity: Severity.E,
+    message: "Configuration is missing.",
+    fullCode: "_TB002E",
+  } as SimplePLICode,


Please remove, see reason above.

msujew · 2025-10-29T11:24:44Z

packages/language/src/workspace/plugin-configuration-provider.ts

          // add any contained directories to the libs list, as well as the toProcess list
          const libUri = UriUtils.joinPath(URI.parse(this.workspacePath), lib);
          const entries = await FileSystemProviderInstance.readDir(libUri);
+          console.log(entries);


Please remove before undrafting this PR.

msujew · 2025-10-29T14:25:06Z

packages/language/src/workspace/plugin-configuration-provider.ts

+                try {
+                  // directory to add for handling
+                  libsToProcess.push(`${lib}/${fileName}`);
+                  // also add to the full libs list
+                  computedLibs.add(`${lib}/${fileName}`);
+                } catch (err) {
+                  console.error(`Failed to add ${lib}/${fileName}: `, err);
+                }


Question: How can an array push/a set add operation fail?

I was testing if somehow that could be the problem and ended up letting this there because I wasn't sure it couldn't fail. Gonna remove it though.

msujew · 2025-10-29T14:27:12Z

packages/vscode-extension/src/language/main.ts

+    } catch (err) {
+      console.error(`Error reading directory: ${uri.fsPath}`, err);
+      return [];
+    }


Suggestion: IMO the call site should handle any file system failure. Only the caller knows what to do with a failure:

Do nothing (which would be essentially the same as returning []).

Log the error and continue (perhaps displaying it to the user)

Bubble up the error

Signed-off-by: Wagner Laranjeiras <[email protected]>

…ix-for-missing-config Signed-off-by: Wagner-Laranjeiras <[email protected]>

Signed-off-by: Wagner Laranjeiras <[email protected]>

msujew · 2025-10-30T13:58:55Z

packages/language/src/language-server/lsp-codes.ts

+import { Severity } from "../language-server/types";
+import { SimplePLICode } from "../validation/pli-codes";
+
+export const lspCodes = {


Minor: Exported constants are usually either CamelCase or SNAKE_CASE.

Suggested change

export const lspCodes = {

export const LspCodes = {

msujew · 2025-10-30T13:59:53Z

packages/language/src/language-server/lsp-codes.ts

+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+
+import { Severity } from "../language-server/types";
+import { SimplePLICode } from "../validation/pli-codes";


Suggestion: Please put this file in the validation part of the package.

msujew reviewed Oct 22, 2025

View reviewed changes

Wagner-Laranjeiras force-pushed the feature/wagner/diagnostic-and-quick-fix-for-missing-config branch from 0b0ee24 to 6cd2b92 Compare October 27, 2025 12:37

Implement new diagnostic and Quick fix for missing configuration. Fix…

f71af15

… Libs bug for inexistent lib. Signed-off-by: Wagner Laranjeiras <[email protected]>

Wagner-Laranjeiras force-pushed the feature/wagner/diagnostic-and-quick-fix-for-missing-config branch from ceffbcf to f71af15 Compare October 28, 2025 13:58

work in progrss

8daadc8

Signed-off-by: Wagner Laranjeiras <[email protected]>

msujew reviewed Oct 29, 2025

View reviewed changes

Wagner-Laranjeiras added 7 commits October 30, 2025 12:25

work on review

7ba3dc0

Signed-off-by: Wagner Laranjeiras <[email protected]>

Merge branch 'development' into feature/wagner/diagnostic-and-quick-f…

0b492bf

…ix-for-missing-config Signed-off-by: Wagner-Laranjeiras <[email protected]>

solve conflicts

12e28a6

Signed-off-by: Wagner Laranjeiras <[email protected]>

minor tweaks

29efbe9

Signed-off-by: Wagner Laranjeiras <[email protected]>

remove fullCode

246e452

Signed-off-by: Wagner Laranjeiras <[email protected]>

fix code placement

f26fdf0

Signed-off-by: Wagner Laranjeiras <[email protected]>

work in progress

f9c9073

Signed-off-by: Wagner Laranjeiras <[email protected]>

msujew reviewed Oct 30, 2025

View reviewed changes

[Feature] Implement diagnostic and quick fix for missing configuration #451

Are you sure you want to change the base?

[Feature] Implement diagnostic and quick fix for missing configuration #451

Uh oh!

Conversation

Wagner-Laranjeiras commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

[Feature] Implement diagnostic and quick fix for missing configuration and [Bugfix] Fix non existent lib breaking all INCLUDES.

Uh oh!

github-actions bot commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch previews at 2025-10-30 12:53 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

msujew left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Wagner-Laranjeiras commented Oct 17, 2025 •

edited

Loading

github-actions bot commented Oct 17, 2025 •

edited

Loading

Built to branch `previews` at 2025-10-30 12:53 UTC.
Preview will be ready when the GitHub Pages deployment is complete.