Skip to content

Commit

Permalink
Merge pull request #77 from davelopez/ignore_some_schema_suggestions
Browse files Browse the repository at this point in the history
Ignore auto-complete suggestions for some schema elements in Format2
  • Loading branch information
davelopez authored Jun 22, 2024
2 parents 41e9ed6 + ccc886c commit e2b0394
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
10 changes: 10 additions & 0 deletions server/gx-workflow-ls-format2/src/services/completionService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ import { FieldSchemaNode, RecordSchemaNode, SchemaNode, SchemaNodeResolver } fro
import { EnumSchemaNode } from "../schema/definitions";

export class GxFormat2CompletionService {
/**
* Schema references that should be ignored when suggesting completions.
* These are typically user-defined names and we cannot suggest completions for them.
*/
private readonly ignoredSchemaRefs = new Set(["InputParameter", "OutputParameter", "WorkflowStep"]);

constructor(protected readonly schemaNodeResolver: SchemaNodeResolver) {}

public doComplete(documentContext: GxFormat2WorkflowDocument, position: Position): Promise<CompletionList> {
Expand Down Expand Up @@ -111,6 +117,10 @@ export class GxFormat2CompletionService {
return result;
}

if (this.ignoredSchemaRefs.has(schemaNode.typeRef)) {
return result;
}

const schemaRecord = this.schemaNodeResolver.getSchemaNodeByTypeRef(schemaNode.typeRef);
if (schemaRecord) {
return this.getProposedItems(schemaRecord, textBuffer, exclude, offset);
Expand Down
39 changes: 39 additions & 0 deletions server/gx-workflow-ls-format2/tests/integration/completion.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,45 @@ in$
expect(completions?.items[0].label).toBe("inputs");
});

it("should not suggest any properties when defining new workflow inputs", async () => {
const template = `
class: GalaxyWorkflow
inputs:
$
`;
const { contents, position } = parseTemplate(template);

const completions = await getCompletions(contents, position);

expect(completions?.items.length).toBe(0);
});

it("should not suggest any properties when defining new workflow outputs", async () => {
const template = `
class: GalaxyWorkflow
outputs:
$
`;
const { contents, position } = parseTemplate(template);

const completions = await getCompletions(contents, position);

expect(completions?.items.length).toBe(0);
});

it("should not suggest any properties when defining new workflow steps", async () => {
const template = `
class: GalaxyWorkflow
steps:
$
`;
const { contents, position } = parseTemplate(template);

const completions = await getCompletions(contents, position);

expect(completions?.items.length).toBe(0);
});

it("should not suggest property completions inlined with the definition", async () => {
const template = `
class: GalaxyWorkflow
Expand Down

0 comments on commit e2b0394

Please sign in to comment.