Skip to content

Commit 3214a37

Browse files
committed
Clarify definitions to be extensible predicate definitions
1 parent 5a3a1a5 commit 3214a37

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

extensions/ql-vscode/src/data-extensions-editor/generate-flow-model.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { join } from "path";
44
import { QueryRunner } from "../queryRunner";
55
import { CodeQLCliServer } from "../cli";
66
import { extLogger, TeeLogger } from "../common";
7-
import { definitions } from "./yaml";
7+
import { extensiblePredicateDefinitions } from "./yaml";
88
import { ProgressCallback } from "../progress";
99
import { getOnDiskWorkspaceFolders } from "../helpers";
1010
import { ModeledMethod, ModeledMethodType } from "./modeled-method";
@@ -25,7 +25,7 @@ class FlowModelGenerator {
2525
queryName: string,
2626
queryStep: number,
2727
): Promise<Array<[string, ModeledMethod]> | undefined> {
28-
const definition = definitions[type];
28+
const definition = extensiblePredicateDefinitions[type];
2929

3030
const query = join(
3131
this.qlDir,

extensions/ql-vscode/src/data-extensions-editor/yaml.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ type ExternalApiUsageByType = {
66
modeledMethod: ModeledMethod;
77
};
88

9-
type DataExtensionDefinition = {
10-
extensible: string;
9+
type ExtensiblePredicateDefinition = {
10+
extensiblePredicate: string;
1111
generateMethodDefinition: (method: ExternalApiUsageByType) => any[];
1212
readModeledMethod: (row: any[]) => [string, ModeledMethod] | undefined;
1313
};
@@ -16,12 +16,12 @@ function readRowToMethod(row: any[]): string {
1616
return `${row[0]}.${row[1]}#${row[3]}${row[4]}`;
1717
}
1818

19-
export const definitions: Record<
19+
export const extensiblePredicateDefinitions: Record<
2020
Exclude<ModeledMethodType, "none">,
21-
DataExtensionDefinition
21+
ExtensiblePredicateDefinition
2222
> = {
2323
source: {
24-
extensible: "sourceModel",
24+
extensiblePredicate: "sourceModel",
2525
// extensible predicate sourceModel(
2626
// string package, string type, boolean subtypes, string name, string signature, string ext,
2727
// string output, string kind, string provenance
@@ -48,7 +48,7 @@ export const definitions: Record<
4848
],
4949
},
5050
sink: {
51-
extensible: "sinkModel",
51+
extensiblePredicate: "sinkModel",
5252
// extensible predicate sinkModel(
5353
// string package, string type, boolean subtypes, string name, string signature, string ext,
5454
// string input, string kind, string provenance
@@ -75,7 +75,7 @@ export const definitions: Record<
7575
],
7676
},
7777
summary: {
78-
extensible: "summaryModel",
78+
extensiblePredicate: "summaryModel",
7979
// extensible predicate summaryModel(
8080
// string package, string type, boolean subtypes, string name, string signature, string ext,
8181
// string input, string output, string kind, string provenance
@@ -103,7 +103,7 @@ export const definitions: Record<
103103
],
104104
},
105105
neutral: {
106-
extensible: "neutralModel",
106+
extensiblePredicate: "neutralModel",
107107
// extensible predicate neutralModel(
108108
// string package, string type, string name, string signature, string provenance
109109
// );
@@ -128,7 +128,7 @@ export const definitions: Record<
128128

129129
function createDataProperty(
130130
methods: ExternalApiUsageByType[],
131-
definition: DataExtensionDefinition,
131+
definition: ExtensiblePredicateDefinition,
132132
) {
133133
if (methods.length === 0) {
134134
return " []";
@@ -169,10 +169,10 @@ export function createDataExtensionYaml(
169169
}
170170
}
171171

172-
const extensions = Object.entries(definitions).map(
172+
const extensions = Object.entries(extensiblePredicateDefinitions).map(
173173
([type, definition]) => ` - addsTo:
174174
pack: codeql/java-all
175-
extensible: ${definition.extensible}
175+
extensible: ${definition.extensiblePredicate}
176176
data:${createDataProperty(
177177
methodsByType[type as Exclude<ModeledMethodType, "none">],
178178
definition,
@@ -214,8 +214,8 @@ export function loadDataExtensionYaml(
214214
continue;
215215
}
216216

217-
const definition = Object.values(definitions).find(
218-
(definition) => definition.extensible === extensible,
217+
const definition = Object.values(extensiblePredicateDefinitions).find(
218+
(definition) => definition.extensiblePredicate === extensible,
219219
);
220220
if (!definition) {
221221
continue;

0 commit comments

Comments
 (0)