@checkdigit/eslint-athena-plugin 1.0.0-PR.2-dcdf
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +21 -0
- package/README.md +17 -0
- package/SECURITY.md +13 -0
- package/dist-mjs/athena/api-locator.mjs +66 -0
- package/dist-mjs/athena/api-matcher.mjs +206 -0
- package/dist-mjs/athena/athena.mjs +165 -0
- package/dist-mjs/athena/column.mjs +1 -0
- package/dist-mjs/athena/context.mjs +21 -0
- package/dist-mjs/athena/index.mjs +1 -0
- package/dist-mjs/athena/service-table.mjs +45 -0
- package/dist-mjs/athena/sql-file.mjs +123 -0
- package/dist-mjs/athena/types.mjs +1 -0
- package/dist-mjs/athena/validate.mjs +619 -0
- package/dist-mjs/athena/visitor.mjs +291 -0
- package/dist-mjs/get-documentation-url.mjs +9 -0
- package/dist-mjs/index.mjs +56 -0
- package/dist-mjs/openapi/deref-schema.mjs +20 -0
- package/dist-mjs/openapi/generate-schema.mjs +375 -0
- package/dist-mjs/openapi/service-schema-generator.mjs +176 -0
- package/dist-mjs/peggy/athena-peggy.mjs +20700 -0
- package/dist-mjs/service.mjs +9 -0
- package/dist-mjs/sql-parser.mjs +28 -0
- package/dist-types/athena/api-locator.d.ts +2 -0
- package/dist-types/athena/api-matcher.d.ts +14 -0
- package/dist-types/athena/athena.d.ts +5 -0
- package/dist-types/athena/column.d.ts +1 -0
- package/dist-types/athena/context.d.ts +21 -0
- package/dist-types/athena/index.d.ts +8 -0
- package/dist-types/athena/service-table.d.ts +8 -0
- package/dist-types/athena/sql-file.d.ts +5 -0
- package/dist-types/athena/types.d.ts +493 -0
- package/dist-types/athena/validate.d.ts +14 -0
- package/dist-types/athena/visitor.d.ts +75 -0
- package/dist-types/get-documentation-url.d.ts +1 -0
- package/dist-types/index.d.ts +5 -0
- package/dist-types/openapi/deref-schema.d.ts +1 -0
- package/dist-types/openapi/generate-schema.d.ts +33 -0
- package/dist-types/openapi/service-schema-generator.d.ts +5 -0
- package/dist-types/peggy/athena-peggy.d.ts +13 -0
- package/dist-types/service.d.ts +2 -0
- package/dist-types/sql-parser.d.ts +25 -0
- package/package.json +1 -0
- package/src/api/v1/swagger.yml +619 -0
- package/src/api/v2/swagger.yml +477 -0
- package/src/athena/api-locator.ts +78 -0
- package/src/athena/api-matcher.ts +323 -0
- package/src/athena/athena.ts +224 -0
- package/src/athena/column.ts +4 -0
- package/src/athena/context.ts +47 -0
- package/src/athena/index.ts +13 -0
- package/src/athena/service-table.ts +78 -0
- package/src/athena/sql-file.ts +161 -0
- package/src/athena/types.ts +568 -0
- package/src/athena/validate.ts +902 -0
- package/src/athena/visitor.ts +406 -0
- package/src/get-documentation-url.ts +7 -0
- package/src/index.ts +67 -0
- package/src/openapi/deref-schema.ts +20 -0
- package/src/openapi/generate-schema.ts +553 -0
- package/src/openapi/service-schema-generator.ts +241 -0
- package/src/peggy/athena-peggy.ts +22149 -0
- package/src/peggy/athena.peggy +2971 -0
- package/src/service.ts +11 -0
- package/src/services/eslintAthenaPlugin/v1/swagger.schema.deref.json +1931 -0
- package/src/services/eslintAthenaPlugin/v2/swagger.schema.deref.json +978 -0
- package/src/sql-parser.ts +53 -0
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
// src/athena/sql-file.ts
|
|
2
|
+
import debug from "debug";
|
|
3
|
+
import { ESLintUtils } from "@typescript-eslint/utils";
|
|
4
|
+
import { parse } from "../peggy/athena-peggy.mjs";
|
|
5
|
+
import { createRootContext } from "./context.mjs";
|
|
6
|
+
import {
|
|
7
|
+
ATHENA_ERROR,
|
|
8
|
+
AthenaError,
|
|
9
|
+
checkAthenaAst,
|
|
10
|
+
offsetToLoc,
|
|
11
|
+
SYNTAXT_ERROR
|
|
12
|
+
} from "./validate.mjs";
|
|
13
|
+
var ruleId = "sql-file";
|
|
14
|
+
var log = debug("eslint-athena-plugin:sql-file");
|
|
15
|
+
var createRule = ESLintUtils.RuleCreator((name) => name);
|
|
16
|
+
var rule = createRule({
|
|
17
|
+
name: ruleId,
|
|
18
|
+
meta: {
|
|
19
|
+
type: "problem",
|
|
20
|
+
docs: {
|
|
21
|
+
description: "Validate plain .sql files against OpenAPI schemas at lint time"
|
|
22
|
+
},
|
|
23
|
+
schema: [],
|
|
24
|
+
messages: {
|
|
25
|
+
[SYNTAXT_ERROR]: `SyntaxError {{ errorMessage }}`,
|
|
26
|
+
[ATHENA_ERROR]: `AthenaError {{ errorMessage }}`
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
defaultOptions: [],
|
|
30
|
+
create(context) {
|
|
31
|
+
return {
|
|
32
|
+
// Program fires once per file; the entire source text is the SQL to validate.
|
|
33
|
+
Program() {
|
|
34
|
+
const sql = context.sourceCode.getText();
|
|
35
|
+
if (!/^\s*(?:SELECT\b[\s\S]*\bFROM\b|WITH\b[\s\S]*\bSELECT\b[\s\S]*\b)/iu.test(
|
|
36
|
+
sql
|
|
37
|
+
)) {
|
|
38
|
+
log("skipping non-SELECT SQL", { filename: context.filename });
|
|
39
|
+
return;
|
|
40
|
+
}
|
|
41
|
+
let ast;
|
|
42
|
+
try {
|
|
43
|
+
({ ast } = parse(sql, { includeLocations: true }));
|
|
44
|
+
} catch (error) {
|
|
45
|
+
log("error parsing SQL", { error, filename: context.filename });
|
|
46
|
+
const pegLoc = error.location;
|
|
47
|
+
if (pegLoc !== void 0) {
|
|
48
|
+
context.report({
|
|
49
|
+
loc: {
|
|
50
|
+
start: offsetToLoc(sql, pegLoc.start.offset),
|
|
51
|
+
end: offsetToLoc(sql, pegLoc.end.offset)
|
|
52
|
+
},
|
|
53
|
+
messageId: SYNTAXT_ERROR,
|
|
54
|
+
data: { errorMessage: error.message }
|
|
55
|
+
});
|
|
56
|
+
} else {
|
|
57
|
+
context.report({
|
|
58
|
+
loc: {
|
|
59
|
+
start: { line: 1, column: 0 },
|
|
60
|
+
end: { line: 1, column: 0 }
|
|
61
|
+
},
|
|
62
|
+
messageId: SYNTAXT_ERROR,
|
|
63
|
+
data: { errorMessage: error.message }
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
return;
|
|
67
|
+
}
|
|
68
|
+
const athenaCtx = createRootContext();
|
|
69
|
+
try {
|
|
70
|
+
checkAthenaAst(Array.isArray(ast) ? ast[0] : ast, athenaCtx);
|
|
71
|
+
} catch (error) {
|
|
72
|
+
log("error checking SQL AST", {
|
|
73
|
+
error,
|
|
74
|
+
filename: context.filename
|
|
75
|
+
});
|
|
76
|
+
if (error instanceof AthenaError) {
|
|
77
|
+
const astLoc = error.ast?.loc;
|
|
78
|
+
if (astLoc !== void 0) {
|
|
79
|
+
context.report({
|
|
80
|
+
loc: {
|
|
81
|
+
start: offsetToLoc(sql, astLoc.start.offset),
|
|
82
|
+
end: offsetToLoc(sql, astLoc.end.offset)
|
|
83
|
+
},
|
|
84
|
+
messageId: ATHENA_ERROR,
|
|
85
|
+
data: { errorMessage: error.message }
|
|
86
|
+
});
|
|
87
|
+
} else {
|
|
88
|
+
context.report({
|
|
89
|
+
loc: {
|
|
90
|
+
start: { line: 1, column: 0 },
|
|
91
|
+
end: { line: 1, column: 0 }
|
|
92
|
+
},
|
|
93
|
+
messageId: ATHENA_ERROR,
|
|
94
|
+
data: { errorMessage: error.message }
|
|
95
|
+
});
|
|
96
|
+
}
|
|
97
|
+
} else {
|
|
98
|
+
console.error(
|
|
99
|
+
`Failed to apply ${ruleId} rule for "${context.filename}":`,
|
|
100
|
+
error
|
|
101
|
+
);
|
|
102
|
+
context.report({
|
|
103
|
+
loc: {
|
|
104
|
+
start: { line: 1, column: 0 },
|
|
105
|
+
end: { line: 1, column: 0 }
|
|
106
|
+
},
|
|
107
|
+
messageId: ATHENA_ERROR,
|
|
108
|
+
data: {
|
|
109
|
+
errorMessage: error instanceof Error ? String(error) : JSON.stringify(error, void 0, 2)
|
|
110
|
+
}
|
|
111
|
+
});
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
};
|
|
116
|
+
}
|
|
117
|
+
});
|
|
118
|
+
var sql_file_default = rule;
|
|
119
|
+
export {
|
|
120
|
+
sql_file_default as default,
|
|
121
|
+
ruleId
|
|
122
|
+
};
|
|
123
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vc3JjL2F0aGVuYS9zcWwtZmlsZS50cyJdLAogICJtYXBwaW5ncyI6ICI7QUFRQSxPQUFPLFdBQVc7QUFDbEIsU0FBUyxtQkFBbUI7QUFFNUIsU0FBUyxhQUFhO0FBRXRCLFNBQVMseUJBQXlCO0FBQ2xDO0FBQUEsRUFDRTtBQUFBLEVBQ0E7QUFBQSxFQUNBO0FBQUEsRUFDQTtBQUFBLEVBQ0E7QUFBQSxPQUNLO0FBRUEsSUFBTSxTQUFTO0FBRXRCLElBQU0sTUFBTSxNQUFNLCtCQUErQjtBQUNqRCxJQUFNLGFBQWEsWUFBWSxZQUFZLENBQUMsU0FBUyxJQUFJO0FBRXpELElBQU0sT0FDSixXQUFXO0FBQUEsRUFDVCxNQUFNO0FBQUEsRUFDTixNQUFNO0FBQUEsSUFDSixNQUFNO0FBQUEsSUFDTixNQUFNO0FBQUEsTUFDSixhQUNFO0FBQUEsSUFDSjtBQUFBLElBQ0EsUUFBUSxDQUFDO0FBQUEsSUFDVCxVQUFVO0FBQUEsTUFDUixDQUFDLGFBQWEsR0FBRztBQUFBLE1BQ2pCLENBQUMsWUFBWSxHQUFHO0FBQUEsSUFDbEI7QUFBQSxFQUNGO0FBQUEsRUFDQSxnQkFBZ0IsQ0FBQztBQUFBLEVBQ2pCLE9BQU8sU0FBUztBQUNkLFdBQU87QUFBQTtBQUFBLE1BRUwsVUFBVTtBQUNSLGNBQU0sTUFBTSxRQUFRLFdBQVcsUUFBUTtBQUV2QyxZQUNFLENBQUMscUVBQXFFO0FBQUEsVUFDcEU7QUFBQSxRQUNGLEdBQ0E7QUFDQSxjQUFJLDJCQUEyQixFQUFFLFVBQVUsUUFBUSxTQUFTLENBQUM7QUFDN0Q7QUFBQSxRQUNGO0FBRUEsWUFBSTtBQUNKLFlBQUk7QUFFRixXQUFDLEVBQUUsSUFBSSxJQUFJLE1BQU0sS0FBSyxFQUFFLGtCQUFrQixLQUFLLENBQUM7QUFBQSxRQUNsRCxTQUFTLE9BQU87QUFDZCxjQUFJLHFCQUFxQixFQUFFLE9BQU8sVUFBVSxRQUFRLFNBQVMsQ0FBQztBQUM5RCxnQkFBTSxTQUNKLE1BTUE7QUFDRixjQUFJLFdBQVcsUUFBVztBQUV4QixvQkFBUSxPQUFPO0FBQUEsY0FDYixLQUFLO0FBQUEsZ0JBQ0gsT0FBTyxZQUFZLEtBQUssT0FBTyxNQUFNLE1BQU07QUFBQSxnQkFDM0MsS0FBSyxZQUFZLEtBQUssT0FBTyxJQUFJLE1BQU07QUFBQSxjQUN6QztBQUFBLGNBQ0EsV0FBVztBQUFBLGNBQ1gsTUFBTSxFQUFFLGNBQWUsTUFBZ0IsUUFBUTtBQUFBLFlBQ2pELENBQUM7QUFBQSxVQUNILE9BQU87QUFDTCxvQkFBUSxPQUFPO0FBQUEsY0FDYixLQUFLO0FBQUEsZ0JBQ0gsT0FBTyxFQUFFLE1BQU0sR0FBRyxRQUFRLEVBQUU7QUFBQSxnQkFDNUIsS0FBSyxFQUFFLE1BQU0sR0FBRyxRQUFRLEVBQUU7QUFBQSxjQUM1QjtBQUFBLGNBQ0EsV0FBVztBQUFBLGNBQ1gsTUFBTSxFQUFFLGNBQWUsTUFBZ0IsUUFBUTtBQUFBLFlBQ2pELENBQUM7QUFBQSxVQUNIO0FBQ0E7QUFBQSxRQUNGO0FBRUEsY0FBTSxZQUFZLGtCQUFrQjtBQUNwQyxZQUFJO0FBRUYseUJBQWUsTUFBTSxRQUFRLEdBQUcsSUFBSSxJQUFJLENBQUMsSUFBSSxLQUFLLFNBQVM7QUFBQSxRQUM3RCxTQUFTLE9BQU87QUFDZCxjQUFJLDBCQUEwQjtBQUFBLFlBQzVCO0FBQUEsWUFDQSxVQUFVLFFBQVE7QUFBQSxVQUNwQixDQUFDO0FBQ0QsY0FBSSxpQkFBaUIsYUFBYTtBQUNoQyxrQkFBTSxTQUNKLE1BQU0sS0FRTDtBQUNILGdCQUFJLFdBQVcsUUFBVztBQUN4QixzQkFBUSxPQUFPO0FBQUEsZ0JBQ2IsS0FBSztBQUFBLGtCQUNILE9BQU8sWUFBWSxLQUFLLE9BQU8sTUFBTSxNQUFNO0FBQUEsa0JBQzNDLEtBQUssWUFBWSxLQUFLLE9BQU8sSUFBSSxNQUFNO0FBQUEsZ0JBQ3pDO0FBQUEsZ0JBQ0EsV0FBVztBQUFBLGdCQUNYLE1BQU0sRUFBRSxjQUFjLE1BQU0sUUFBUTtBQUFBLGNBQ3RDLENBQUM7QUFBQSxZQUNILE9BQU87QUFDTCxzQkFBUSxPQUFPO0FBQUEsZ0JBQ2IsS0FBSztBQUFBLGtCQUNILE9BQU8sRUFBRSxNQUFNLEdBQUcsUUFBUSxFQUFFO0FBQUEsa0JBQzVCLEtBQUssRUFBRSxNQUFNLEdBQUcsUUFBUSxFQUFFO0FBQUEsZ0JBQzVCO0FBQUEsZ0JBQ0EsV0FBVztBQUFBLGdCQUNYLE1BQU0sRUFBRSxjQUFjLE1BQU0sUUFBUTtBQUFBLGNBQ3RDLENBQUM7QUFBQSxZQUNIO0FBQUEsVUFDRixPQUFPO0FBRUwsb0JBQVE7QUFBQSxjQUNOLG1CQUFtQixNQUFNLGNBQWMsUUFBUSxRQUFRO0FBQUEsY0FDdkQ7QUFBQSxZQUNGO0FBQ0Esb0JBQVEsT0FBTztBQUFBLGNBQ2IsS0FBSztBQUFBLGdCQUNILE9BQU8sRUFBRSxNQUFNLEdBQUcsUUFBUSxFQUFFO0FBQUEsZ0JBQzVCLEtBQUssRUFBRSxNQUFNLEdBQUcsUUFBUSxFQUFFO0FBQUEsY0FDNUI7QUFBQSxjQUNBLFdBQVc7QUFBQSxjQUNYLE1BQU07QUFBQSxnQkFDSixjQUNFLGlCQUFpQixRQUNiLE9BQU8sS0FBSyxJQUNaLEtBQUssVUFBVSxPQUFPLFFBQVcsQ0FBQztBQUFBLGNBQzFDO0FBQUEsWUFDRixDQUFDO0FBQUEsVUFDSDtBQUFBLFFBQ0Y7QUFBQSxNQUNGO0FBQUEsSUFDRjtBQUFBLEVBQ0Y7QUFDRixDQUFDO0FBRUgsSUFBTyxtQkFBUTsiLAogICJuYW1lcyI6IFtdCn0K
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFtdLAogICJtYXBwaW5ncyI6ICIiLAogICJuYW1lcyI6IFtdCn0K
|