@goodbones/oxlint 0.1.0-beta.6 → 0.1.0-beta.8
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/build/dts/campaigns-rule.d.ts +4 -0
- package/build/dts/campaigns-rule.d.ts.map +1 -0
- package/build/dts/config-loader.d.ts.map +1 -1
- package/build/dts/exports-rule.d.ts.map +1 -1
- package/build/dts/imports-rule.d.ts.map +1 -1
- package/build/dts/members-rule.d.ts.map +1 -1
- package/build/dts/oxlint-api.d.ts +4 -33
- package/build/dts/oxlint-api.d.ts.map +1 -1
- package/build/dts/plugin.d.ts +1 -0
- package/build/dts/plugin.d.ts.map +1 -1
- package/build/dts/surface-rule.d.ts.map +1 -1
- package/build/esm/campaigns-rule.js +70 -0
- package/build/esm/campaigns-rule.js.map +1 -0
- package/build/esm/config-loader.js +26 -3
- package/build/esm/config-loader.js.map +1 -1
- package/build/esm/exports-rule.js +15 -71
- package/build/esm/exports-rule.js.map +1 -1
- package/build/esm/imports-rule.js +14 -26
- package/build/esm/imports-rule.js.map +1 -1
- package/build/esm/members-rule.js +10 -112
- package/build/esm/members-rule.js.map +1 -1
- package/build/esm/oxlint-api.js +22 -20
- package/build/esm/oxlint-api.js.map +1 -1
- package/build/esm/plugin.js +2 -0
- package/build/esm/plugin.js.map +1 -1
- package/build/esm/surface-rule.js +11 -127
- package/build/esm/surface-rule.js.map +1 -1
- package/package.json +4 -3
- package/src/campaigns-rule.ts +98 -0
- package/src/config-loader.ts +27 -2
- package/src/exports-rule.ts +19 -106
- package/src/imports-rule.ts +16 -35
- package/src/members-rule.ts +11 -165
- package/src/oxlint-api.ts +31 -47
- package/src/plugin.ts +3 -0
- package/src/surface-rule.ts +15 -189
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"members-rule.js","sourceRoot":"","sources":["../../src/members-rule.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"members-rule.js","sourceRoot":"","sources":["../../src/members-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,kBAAkB,EAClB,aAAa,EAEb,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,EAAE,EACF,cAAc,EAId,cAAc,GACf,MAAM,iBAAiB,CAAC;AAEzB,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAoB,EAAc,EAAE,CAAC,CAAC;IACpE,IAAI,EAAE;QACJ,IAAI,EAAE,SAAkB;QACxB,IAAI,EAAE;YACJ,WAAW,EACT,6FAA6F;SAChG;QACD,MAAM,EAAE,EAAE;KACX;IAED,UAAU,CAAC,OAAoB;QAC7B,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,QAAQ,GAAsC,EAAE,CAAC;QAErD,2EAA2E;QAC3E,+CAA+C;QAC/C,OAAO;YACL,MAAM;gBACJ,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACzD,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;oBAAE,OAAO,KAAK,CAAC;gBACxC,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;gBAC1D,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;YAC7B,CAAC;YACD,OAAO,CAAC,IAAa;gBACnB,KAAK,MAAM,IAAI,IAAI,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;oBAC1D,KAAK,MAAM,SAAS,IAAI,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;wBAC3D,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC;4BAAE,SAAS;wBACrD,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;oBAC7E,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}
|
package/build/esm/oxlint-api.js
CHANGED
|
@@ -1,24 +1,26 @@
|
|
|
1
1
|
import * as path from "node:path";
|
|
2
|
+
import { readProgram, } from "@goodbones/typescript";
|
|
2
3
|
export const toRepoRelative = (repoRoot, filename) => path.relative(repoRoot, filename).replaceAll(path.sep, "/");
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
const
|
|
22
|
-
|
|
4
|
+
// A diagnostic is placed by the node's range, which every node of oxlint's
|
|
5
|
+
// tree carries; a node from another parse carries `start` and `end`.
|
|
6
|
+
export const at = (node) => ({
|
|
7
|
+
range: node.range ?? [node.start, node.end],
|
|
8
|
+
});
|
|
9
|
+
// The facts of one file, read once and shared by every rule that runs on it:
|
|
10
|
+
// oxlint deserialises a file's tree once and hands the same `Program` to each
|
|
11
|
+
// rule, so the tree is the key.
|
|
12
|
+
const read = new WeakMap();
|
|
13
|
+
export const factsOfProgram = (file, program) => {
|
|
14
|
+
const found = read.get(program);
|
|
15
|
+
if (found !== undefined)
|
|
16
|
+
return found;
|
|
17
|
+
// oxlint's node types are `@oxc-project/types`' with `parent` required on
|
|
18
|
+
// every node — the same tree, generated from the same source. Each node
|
|
19
|
+
// type assigns on its own; the compiler gives up relating the two
|
|
20
|
+
// ~190-member recursive unions as wholes, so the boundary is asserted once,
|
|
21
|
+
// here. The parity suite is what proves the trees are one.
|
|
22
|
+
const facts = readProgram(file, program);
|
|
23
|
+
read.set(program, facts);
|
|
24
|
+
return facts;
|
|
23
25
|
};
|
|
24
26
|
//# sourceMappingURL=oxlint-api.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"oxlint-api.js","sourceRoot":"","sources":["../../src/oxlint-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"oxlint-api.js","sourceRoot":"","sources":["../../src/oxlint-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,EAGL,WAAW,GAEZ,MAAM,uBAAuB,CAAC;AAiB/B,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAE,QAAgB,EAAU,EAAE,CAC3E,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAE9D,2EAA2E;AAC3E,qEAAqE;AACrE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAgB,EAAkB,EAAE,CAAC,CAAC;IACvD,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC;CAC5C,CAAC,CAAC;AAEH,6EAA6E;AAC7E,8EAA8E;AAC9E,gCAAgC;AAChC,MAAM,IAAI,GAAG,IAAI,OAAO,EAAsB,CAAC;AAE/C,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,OAAgB,EAAa,EAAE;IAC1E,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAChC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtC,0EAA0E;IAC1E,wEAAwE;IACxE,kEAAkE;IAClE,4EAA4E;IAC5E,2DAA2D;IAC3D,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,EAAE,OAAsB,CAAC,CAAC;IACxD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACzB,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}
|
package/build/esm/plugin.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { makeCampaignsRule } from "./campaigns-rule.js";
|
|
1
2
|
import { loadPolicyFromFile } from "./config-loader.js";
|
|
2
3
|
import { makeExportsRule } from "./exports-rule.js";
|
|
3
4
|
import { makeImportsRule } from "./imports-rule.js";
|
|
@@ -21,6 +22,7 @@ export const rules = {
|
|
|
21
22
|
members: makeMembersRule(policy),
|
|
22
23
|
structure: makeStructureRule(policy),
|
|
23
24
|
surface: makeSurfaceRule(policy),
|
|
25
|
+
campaigns: makeCampaignsRule(policy),
|
|
24
26
|
};
|
|
25
27
|
const plugin = {
|
|
26
28
|
meta: { name: "architecture" },
|
package/build/esm/plugin.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,gFAAgF;AAChF,gFAAgF;AAChF,+EAA+E;AAC/E,+EAA+E;AAC/E,YAAY;AACZ,MAAM,MAAM,GAAG,MAAM,kBAAkB,CACrC,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,OAAO,CAAC,GAAG,EAAE,EAC9C,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAChC,CAAC;AAEF,6EAA6E;AAC7E,mCAAmC;AACnC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;IACpC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,MAAM,IAAI,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,
|
|
1
|
+
{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,gFAAgF;AAChF,gFAAgF;AAChF,+EAA+E;AAC/E,+EAA+E;AAC/E,YAAY;AACZ,MAAM,MAAM,GAAG,MAAM,kBAAkB,CACrC,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,OAAO,CAAC,GAAG,EAAE,EAC9C,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAChC,CAAC;AAEF,6EAA6E;AAC7E,mCAAmC;AACnC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;IACpC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,MAAM,IAAI,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,GAOd;IACF,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC;IAChC,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC;IAChC,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC;IAChC,SAAS,EAAE,iBAAiB,CAAC,MAAM,CAAC;IACpC,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC;IAChC,SAAS,EAAE,iBAAiB,CAAC,MAAM,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,GAA+E;IACzF,IAAI,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE;IAC9B,KAAK;CACN,CAAC;AAEF,eAAe,MAAM,CAAC"}
|
|
@@ -1,122 +1,5 @@
|
|
|
1
1
|
import { evaluateSurface, formatMessage, surfaceRulesSelecting, } from "@goodbones/core";
|
|
2
|
-
import { toRepoRelative, } from "./oxlint-api.js";
|
|
3
|
-
const isStatementList = (value) => Array.isArray(value);
|
|
4
|
-
const nameOf = (node) => {
|
|
5
|
-
if (node === null || node === undefined)
|
|
6
|
-
return null;
|
|
7
|
-
if (typeof node.name === "string")
|
|
8
|
-
return node.name;
|
|
9
|
-
return typeof node.value === "string" ? node.value : null;
|
|
10
|
-
};
|
|
11
|
-
// The identifiers a binding pattern introduces.
|
|
12
|
-
const patternNames = (pattern) => {
|
|
13
|
-
if (pattern === null || pattern === undefined)
|
|
14
|
-
return [];
|
|
15
|
-
switch (pattern.type) {
|
|
16
|
-
case "Identifier":
|
|
17
|
-
return typeof pattern.name === "string" ? [pattern.name] : [];
|
|
18
|
-
case "ObjectPattern":
|
|
19
|
-
return (pattern.properties ?? []).flatMap((property) => patternNames(property.value ?? property.argument));
|
|
20
|
-
case "ArrayPattern":
|
|
21
|
-
return (pattern.elements ?? []).flatMap(patternNames);
|
|
22
|
-
case "AssignmentPattern":
|
|
23
|
-
return patternNames(pattern.left);
|
|
24
|
-
case "RestElement":
|
|
25
|
-
return patternNames(pattern.argument);
|
|
26
|
-
default:
|
|
27
|
-
return [];
|
|
28
|
-
}
|
|
29
|
-
};
|
|
30
|
-
// The names a declaration statement introduces, with what it declares them as.
|
|
31
|
-
const declaredNamesOf = (statement) => {
|
|
32
|
-
const named = (declares) => {
|
|
33
|
-
const name = nameOf(statement.id);
|
|
34
|
-
return name === null ? [] : [[name, declares]];
|
|
35
|
-
};
|
|
36
|
-
switch (statement.type) {
|
|
37
|
-
case "FunctionDeclaration":
|
|
38
|
-
return named("function");
|
|
39
|
-
case "ClassDeclaration":
|
|
40
|
-
return named("class");
|
|
41
|
-
case "VariableDeclaration":
|
|
42
|
-
return (statement.declarations ?? []).flatMap((declaration) => patternNames(declaration.id).map((name) => [name, "variable"]));
|
|
43
|
-
case "TSTypeAliasDeclaration":
|
|
44
|
-
return named("type");
|
|
45
|
-
case "TSInterfaceDeclaration":
|
|
46
|
-
return named("interface");
|
|
47
|
-
case "TSEnumDeclaration":
|
|
48
|
-
return named("enum");
|
|
49
|
-
case "TSModuleDeclaration":
|
|
50
|
-
return named("other");
|
|
51
|
-
default:
|
|
52
|
-
return [];
|
|
53
|
-
}
|
|
54
|
-
};
|
|
55
|
-
// A file's surface, read off the program body rather than by visiting export
|
|
56
|
-
// nodes: an `export` inside a namespace body is that namespace's, not the
|
|
57
|
-
// module's, and reading the top level directly is what says so without a
|
|
58
|
-
// parent pointer. Mirrors the CLI's `exportSitesOf`.
|
|
59
|
-
const surfaceOf = (file, body) => {
|
|
60
|
-
const locals = new Map();
|
|
61
|
-
for (const statement of body) {
|
|
62
|
-
const declaration = statement.type === "ExportNamedDeclaration" || statement.type === "ExportDefaultDeclaration"
|
|
63
|
-
? statement.declaration
|
|
64
|
-
: statement;
|
|
65
|
-
if (declaration === null || declaration === undefined)
|
|
66
|
-
continue;
|
|
67
|
-
for (const [name, declares] of declaredNamesOf(declaration))
|
|
68
|
-
locals.set(name, declares);
|
|
69
|
-
}
|
|
70
|
-
const found = [];
|
|
71
|
-
const site = (node, name, kind, declares, reexport) => {
|
|
72
|
-
found.push({ node, site: { file, name, kind, declares, reexport } });
|
|
73
|
-
};
|
|
74
|
-
for (const statement of body) {
|
|
75
|
-
switch (statement.type) {
|
|
76
|
-
case "ExportNamedDeclaration": {
|
|
77
|
-
const declaration = statement.declaration;
|
|
78
|
-
if (declaration !== null && declaration !== undefined) {
|
|
79
|
-
for (const [name, declares] of declaredNamesOf(declaration)) {
|
|
80
|
-
site(declaration, name, "named", declares, false);
|
|
81
|
-
}
|
|
82
|
-
break;
|
|
83
|
-
}
|
|
84
|
-
const reexport = typeof statement.source?.value === "string";
|
|
85
|
-
for (const specifier of statement.specifiers ?? []) {
|
|
86
|
-
const name = nameOf(specifier.exported);
|
|
87
|
-
if (name === null)
|
|
88
|
-
continue;
|
|
89
|
-
const local = nameOf(specifier.local) ?? name;
|
|
90
|
-
const declares = reexport ? "other" : (locals.get(local) ?? "other");
|
|
91
|
-
site(specifier, name, name === "default" ? "default" : "named", declares, reexport);
|
|
92
|
-
}
|
|
93
|
-
break;
|
|
94
|
-
}
|
|
95
|
-
case "ExportDefaultDeclaration": {
|
|
96
|
-
const declaration = statement.declaration;
|
|
97
|
-
const declares = declaration === null || declaration === undefined
|
|
98
|
-
? "expression"
|
|
99
|
-
: declaration.type === "FunctionDeclaration"
|
|
100
|
-
? "function"
|
|
101
|
-
: declaration.type === "ClassDeclaration"
|
|
102
|
-
? "class"
|
|
103
|
-
: declaration.type === "TSInterfaceDeclaration"
|
|
104
|
-
? "interface"
|
|
105
|
-
: declaration.type === "Identifier"
|
|
106
|
-
? (locals.get(nameOf(declaration) ?? "") ?? "expression")
|
|
107
|
-
: "expression";
|
|
108
|
-
site(statement, "default", "default", declares, false);
|
|
109
|
-
break;
|
|
110
|
-
}
|
|
111
|
-
case "ExportAllDeclaration":
|
|
112
|
-
site(statement, nameOf(statement.exported) ?? "*", "namespace", "other", true);
|
|
113
|
-
break;
|
|
114
|
-
default:
|
|
115
|
-
break;
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
return found;
|
|
119
|
-
};
|
|
2
|
+
import { at, factsOfProgram, toRepoRelative, } from "./oxlint-api.js";
|
|
120
3
|
export const makeSurfaceRule = (policy) => ({
|
|
121
4
|
meta: {
|
|
122
5
|
type: "problem",
|
|
@@ -137,22 +20,23 @@ export const makeSurfaceRule = (policy) => ({
|
|
|
137
20
|
return selected.length > 0;
|
|
138
21
|
},
|
|
139
22
|
Program(node) {
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
const found = surfaceOf(file, node.body);
|
|
143
|
-
const violations = evaluateSurface(selected, file, found.map((one) => one.site));
|
|
23
|
+
const sites = factsOfProgram(file, node).exportSites;
|
|
24
|
+
const violations = evaluateSurface(selected, file, sites);
|
|
144
25
|
// A per-site violation lands on the site's own node; a `count` one, on
|
|
145
26
|
// the program — it is about the file.
|
|
146
27
|
const used = new Set();
|
|
147
28
|
for (const violation of violations) {
|
|
148
29
|
if (policy.baseline.isBaselined(violation))
|
|
149
30
|
continue;
|
|
150
|
-
const
|
|
31
|
+
const site = violation.subject === null
|
|
151
32
|
? undefined
|
|
152
|
-
:
|
|
153
|
-
if (
|
|
154
|
-
used.add(
|
|
155
|
-
context.report({
|
|
33
|
+
: sites.find((one) => one.name === violation.subject && !used.has(one));
|
|
34
|
+
if (site !== undefined)
|
|
35
|
+
used.add(site);
|
|
36
|
+
context.report({
|
|
37
|
+
node: site === undefined ? node : at(site.node),
|
|
38
|
+
message: formatMessage(violation),
|
|
39
|
+
});
|
|
156
40
|
}
|
|
157
41
|
},
|
|
158
42
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"surface-rule.js","sourceRoot":"","sources":["../../src/surface-rule.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"surface-rule.js","sourceRoot":"","sources":["../../src/surface-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EACf,aAAa,EAEb,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EACL,EAAE,EACF,cAAc,EAId,cAAc,GACf,MAAM,iBAAiB,CAAC;AAEzB,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAoB,EAAc,EAAE,CAAC,CAAC;IACpE,IAAI,EAAE;QACJ,IAAI,EAAE,SAAkB;QACxB,IAAI,EAAE;YACJ,WAAW,EACT,iHAAiH;SACpH;QACD,MAAM,EAAE,EAAE;KACX;IAED,UAAU,CAAC,OAAoB;QAC7B,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,QAAQ,GAAuC,EAAE,CAAC;QAEtD,OAAO;YACL,MAAM;gBACJ,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACzD,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;oBAAE,OAAO,KAAK,CAAC;gBACxC,QAAQ,GAAG,qBAAqB,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;gBAC5D,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;YAC7B,CAAC;YAED,OAAO,CAAC,IAAa;gBACnB,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,WAAW,CAAC;gBACrD,MAAM,UAAU,GAAG,eAAe,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;gBAE1D,uEAAuE;gBACvE,sCAAsC;gBACtC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;gBACvC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;oBACnC,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC;wBAAE,SAAS;oBACrD,MAAM,IAAI,GACR,SAAS,CAAC,OAAO,KAAK,IAAI;wBACxB,CAAC,CAAC,SAAS;wBACX,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC5E,IAAI,IAAI,KAAK,SAAS;wBAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBACvC,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;wBAC/C,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC;qBAClC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@goodbones/oxlint",
|
|
3
|
-
"version": "0.1.0-beta.
|
|
3
|
+
"version": "0.1.0-beta.8",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"description": "The oxlint plugin for @goodbones/core: the imports, exports, members, structure and surface families as five oxlint rules, evaluated in the editor and in CI from the same manifest the CLI reads.",
|
|
@@ -44,8 +44,9 @@
|
|
|
44
44
|
],
|
|
45
45
|
"dependencies": {
|
|
46
46
|
"effect": "4.0.0-beta.94",
|
|
47
|
-
"@goodbones/
|
|
48
|
-
"@goodbones/typescript": "0.1.0-beta.
|
|
47
|
+
"@goodbones/ast-grep": "0.1.0",
|
|
48
|
+
"@goodbones/typescript": "0.1.0-beta.8",
|
|
49
|
+
"@goodbones/core": "0.1.0-beta.8"
|
|
49
50
|
},
|
|
50
51
|
"peerDependencies": {
|
|
51
52
|
"oxlint": ">=1.77.0"
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import {
|
|
2
|
+
type CampaignHit,
|
|
3
|
+
campaignsSelecting,
|
|
4
|
+
type CompiledCampaign,
|
|
5
|
+
evaluateCampaigns,
|
|
6
|
+
formatMessage,
|
|
7
|
+
leafTermsOf,
|
|
8
|
+
type LoadedPolicy,
|
|
9
|
+
reconcile,
|
|
10
|
+
} from "@goodbones/core";
|
|
11
|
+
import { sourceFactsOf } from "@goodbones/typescript";
|
|
12
|
+
|
|
13
|
+
import {
|
|
14
|
+
factsOfProgram,
|
|
15
|
+
type OxlintRule,
|
|
16
|
+
type Program,
|
|
17
|
+
type RuleContext,
|
|
18
|
+
toRepoRelative,
|
|
19
|
+
} from "./oxlint-api.js";
|
|
20
|
+
|
|
21
|
+
// The campaigns family, one file at a time: every hit of a campaign selecting
|
|
22
|
+
// the file that its ledger does not carry, reported at the match's position
|
|
23
|
+
// with the campaign's `how` as the message. The facts come from oxlint's tree
|
|
24
|
+
// through the pack's reader, as the other rules read them; the `syntax` term
|
|
25
|
+
// is answered by the same matcher the CLI uses, over `sourceCode.text` —
|
|
26
|
+
// "one engine" is this family's parity contract, rather than a corpus.
|
|
27
|
+
|
|
28
|
+
// Whether a hit is carried by the ledger, judged against the file's hits
|
|
29
|
+
// alone: entries are per file, so a file's reconciliation is the whole
|
|
30
|
+
// campaign's restricted to it.
|
|
31
|
+
const unledgered = (
|
|
32
|
+
policy: LoadedPolicy,
|
|
33
|
+
selected: ReadonlyArray<CompiledCampaign>,
|
|
34
|
+
hits: ReadonlyArray<CampaignHit>,
|
|
35
|
+
): ReadonlyArray<CampaignHit> => {
|
|
36
|
+
const carried = new Set<CampaignHit["violation"]>();
|
|
37
|
+
for (const rule of selected) {
|
|
38
|
+
const ledger = policy.ledgers.get(rule.id);
|
|
39
|
+
if (ledger === undefined) continue;
|
|
40
|
+
const own = hits.filter((hit) => hit.campaign === rule.id).map((hit) => hit.violation);
|
|
41
|
+
for (const one of reconcile(ledger, own, rule.unit).ledgered) carried.add(one);
|
|
42
|
+
}
|
|
43
|
+
return hits.filter((hit) => !carried.has(hit.violation));
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
export const makeCampaignsRule = (policy: LoadedPolicy): OxlintRule => ({
|
|
47
|
+
meta: {
|
|
48
|
+
type: "problem" as const,
|
|
49
|
+
docs: {
|
|
50
|
+
description:
|
|
51
|
+
"the campaigns: every place a pattern the repository is migrating away from still occurs, that its ledger does not carry",
|
|
52
|
+
},
|
|
53
|
+
schema: [],
|
|
54
|
+
},
|
|
55
|
+
|
|
56
|
+
createOnce(context: RuleContext) {
|
|
57
|
+
let file = "";
|
|
58
|
+
let selected: ReadonlyArray<CompiledCampaign> = [];
|
|
59
|
+
|
|
60
|
+
return {
|
|
61
|
+
before() {
|
|
62
|
+
file = toRepoRelative(policy.repoRoot, context.filename);
|
|
63
|
+
if (file.startsWith("..")) return false;
|
|
64
|
+
selected = campaignsSelecting(policy.campaignRules, file);
|
|
65
|
+
return selected.length > 0;
|
|
66
|
+
},
|
|
67
|
+
|
|
68
|
+
Program(node: Program) {
|
|
69
|
+
const text = context.sourceCode.text;
|
|
70
|
+
const needsSyntax = selected.some((rule) =>
|
|
71
|
+
leafTermsOf(rule.detect).some(
|
|
72
|
+
(leaf) => leaf === "syntax" || leaf === "report" || leaf === "fn",
|
|
73
|
+
),
|
|
74
|
+
);
|
|
75
|
+
const hits = evaluateCampaigns(selected, {
|
|
76
|
+
file,
|
|
77
|
+
text,
|
|
78
|
+
facts: sourceFactsOf(factsOfProgram(file, node)),
|
|
79
|
+
resolver: policy.resolver,
|
|
80
|
+
fileSystem: policy.fileSystem,
|
|
81
|
+
syntax: needsSyntax ? policy.syntax.parse(file, text) : null,
|
|
82
|
+
functions: policy.functions,
|
|
83
|
+
reports: policy.reports,
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
for (const hit of unledgered(policy, selected, hits)) {
|
|
87
|
+
// A match lands where it was found; a file-unit hit, on line 1, as
|
|
88
|
+
// the structure rule places a finding about the file itself.
|
|
89
|
+
const at = hit.range ?? { start: { line: 0, column: 0 } };
|
|
90
|
+
context.report({
|
|
91
|
+
message: formatMessage(hit.violation),
|
|
92
|
+
loc: { line: at.start.line + 1, column: at.start.column },
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
},
|
|
96
|
+
};
|
|
97
|
+
},
|
|
98
|
+
});
|
package/src/config-loader.ts
CHANGED
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
import * as path from "node:path";
|
|
2
2
|
|
|
3
|
+
import { astGrepMatcher } from "@goodbones/ast-grep";
|
|
3
4
|
import {
|
|
4
5
|
findManifestFile,
|
|
6
|
+
loadCampaignFunctions,
|
|
5
7
|
type LoadedPolicy,
|
|
6
8
|
loadPolicy,
|
|
7
9
|
makeFileSystemLive,
|
|
10
|
+
makeReportSourceLive,
|
|
8
11
|
readManifestFile,
|
|
9
12
|
} from "@goodbones/core";
|
|
10
13
|
import { typescriptLanguage } from "@goodbones/typescript";
|
|
@@ -12,6 +15,18 @@ import * as Result from "effect/Result";
|
|
|
12
15
|
|
|
13
16
|
export type { LoadedPolicy } from "@goodbones/core";
|
|
14
17
|
|
|
18
|
+
// The clock the campaigns are judged by; `ARCHITECTURE_NOW` pins it, as it
|
|
19
|
+
// does for the CLI.
|
|
20
|
+
const hostNow = (): number => {
|
|
21
|
+
const pinned = process.env.ARCHITECTURE_NOW;
|
|
22
|
+
if (pinned === undefined || pinned === "") return Date.now();
|
|
23
|
+
const parsed = /^\d+$/.test(pinned) ? Number(pinned) : Date.parse(pinned);
|
|
24
|
+
if (Number.isNaN(parsed)) {
|
|
25
|
+
throw new Error(`ARCHITECTURE_NOW is ${JSON.stringify(pinned)}, which is not a date.`);
|
|
26
|
+
}
|
|
27
|
+
return parsed;
|
|
28
|
+
};
|
|
29
|
+
|
|
15
30
|
// The plugin's composition root: read the manifest file, construct the
|
|
16
31
|
// language packs and the live file system, and hand them to the loader. A load
|
|
17
32
|
// failure throws out of here and out of oxlint's import of the plugin — a
|
|
@@ -28,13 +43,23 @@ export const loadPolicyFromFile = async (
|
|
|
28
43
|
? findManifestFile(repoRoot)
|
|
29
44
|
: path.resolve(repoRoot, configFilename);
|
|
30
45
|
const read = await readManifestFile(configPath);
|
|
46
|
+
// The `fn` terms are imported here, before the policy loads, as the CLI
|
|
47
|
+
// does; the pack is composed with ast-grep for the campaigns family's
|
|
48
|
+
// `syntax` term, and the plugin parses with it for that family only.
|
|
49
|
+
const { functions, manifest } = await loadCampaignFunctions(configPath, read.manifest);
|
|
31
50
|
const loaded = loadPolicy({
|
|
32
51
|
repoRoot,
|
|
33
52
|
configPath,
|
|
34
|
-
manifest
|
|
53
|
+
manifest,
|
|
35
54
|
locate: read.locate,
|
|
36
|
-
languages: [typescriptLanguage()],
|
|
55
|
+
languages: [typescriptLanguage({ syntax: astGrepMatcher() })],
|
|
37
56
|
fileSystem: makeFileSystemLive(repoRoot),
|
|
57
|
+
functions,
|
|
58
|
+
// A `report` command runs once per process — once per editor session
|
|
59
|
+
// for oxlint's language server, which then sees that report until it
|
|
60
|
+
// restarts. A report the build writes to a file is the predictable form.
|
|
61
|
+
reports: makeReportSourceLive(repoRoot),
|
|
62
|
+
now: hostNow(),
|
|
38
63
|
});
|
|
39
64
|
if (Result.isFailure(loaded)) throw loaded.failure;
|
|
40
65
|
return loaded.success;
|
package/src/exports-rule.ts
CHANGED
|
@@ -1,97 +1,29 @@
|
|
|
1
1
|
import {
|
|
2
|
-
type Binding,
|
|
3
2
|
evaluateSelectedBindings,
|
|
4
3
|
exportRulesSelecting,
|
|
5
4
|
formatMessage,
|
|
6
5
|
type LoadedPolicy,
|
|
7
6
|
type SelectedExportRule,
|
|
8
7
|
} from "@goodbones/core";
|
|
8
|
+
import type { ReadBinding, ReadEdge } from "@goodbones/typescript";
|
|
9
9
|
import * as Result from "effect/Result";
|
|
10
10
|
|
|
11
11
|
import {
|
|
12
|
-
|
|
12
|
+
at,
|
|
13
|
+
factsOfProgram,
|
|
13
14
|
type Fixer,
|
|
14
|
-
type ImportEqualsNode,
|
|
15
|
-
importEqualsSpecifierOf,
|
|
16
|
-
type ImportExpressionNode,
|
|
17
|
-
importExpressionSpecifierOf,
|
|
18
15
|
type OxlintRule,
|
|
19
|
-
type
|
|
20
|
-
requireSpecifierOf,
|
|
16
|
+
type Program,
|
|
21
17
|
type RuleContext,
|
|
22
18
|
toRepoRelative,
|
|
23
19
|
} from "./oxlint-api.js";
|
|
24
20
|
|
|
25
|
-
type NamedNode = ReportableNode & { readonly name?: unknown; readonly value?: unknown };
|
|
26
|
-
|
|
27
|
-
type SpecifierNode = ReportableNode & {
|
|
28
|
-
readonly type: string;
|
|
29
|
-
readonly imported?: NamedNode | null;
|
|
30
|
-
readonly local?: NamedNode | null;
|
|
31
|
-
};
|
|
32
|
-
|
|
33
|
-
type DeclarationNode = ReportableNode & {
|
|
34
|
-
readonly source?: { readonly value?: unknown } | null;
|
|
35
|
-
readonly specifiers?: ReadonlyArray<SpecifierNode> | null;
|
|
36
|
-
};
|
|
37
|
-
|
|
38
|
-
const nameOf = (node: NamedNode | null | undefined): string | null => {
|
|
39
|
-
if (node === null || node === undefined) return null;
|
|
40
|
-
if (typeof node.name === "string") return node.name;
|
|
41
|
-
// `import { "a-b" as ab }` — a string-literal export name.
|
|
42
|
-
return typeof node.value === "string" ? node.value : null;
|
|
43
|
-
};
|
|
44
|
-
|
|
45
|
-
type Bound = Binding & { readonly node: ReportableNode; readonly local: string };
|
|
46
|
-
|
|
47
|
-
// The whole module, as one binding. `export * from "m"`, `export * as ns from
|
|
48
|
-
// "m"`, `import x = require("m")`, `import("m")` and `require("m")` all carry
|
|
49
|
-
// every export of `m` at once, exactly as `import * as ns` does — and are the
|
|
50
|
-
// same way around a rule about a name. A side-effect import carries nothing.
|
|
51
|
-
const wholeModule = (node: ReportableNode, local = ""): Bound => ({
|
|
52
|
-
symbol: "*",
|
|
53
|
-
kind: "namespace",
|
|
54
|
-
node,
|
|
55
|
-
local,
|
|
56
|
-
});
|
|
57
|
-
|
|
58
|
-
type ExportAllNode = DeclarationNode & { readonly exported?: NamedNode | null };
|
|
59
|
-
|
|
60
|
-
const boundOf = (specifier: SpecifierNode): Bound | null => {
|
|
61
|
-
const local = nameOf(specifier.local) ?? "";
|
|
62
|
-
switch (specifier.type) {
|
|
63
|
-
case "ImportSpecifier": {
|
|
64
|
-
const symbol = nameOf(specifier.imported);
|
|
65
|
-
return symbol === null ? null : { symbol, kind: "named", node: specifier, local };
|
|
66
|
-
}
|
|
67
|
-
case "ImportDefaultSpecifier":
|
|
68
|
-
return { symbol: "default", kind: "default", node: specifier, local };
|
|
69
|
-
case "ImportNamespaceSpecifier":
|
|
70
|
-
return { symbol: "*", kind: "namespace", node: specifier, local };
|
|
71
|
-
// `export { a } from "…"` — `local` is the name in the source module.
|
|
72
|
-
case "ExportSpecifier": {
|
|
73
|
-
const symbol = nameOf(specifier.local);
|
|
74
|
-
return symbol === null ? null : { symbol, kind: "named", node: specifier, local: symbol };
|
|
75
|
-
}
|
|
76
|
-
default:
|
|
77
|
-
return null;
|
|
78
|
-
}
|
|
79
|
-
};
|
|
80
|
-
|
|
81
|
-
const specifierOf = (node: DeclarationNode): string | null => {
|
|
82
|
-
const value = node.source?.value;
|
|
83
|
-
return typeof value === "string" ? value : null;
|
|
84
|
-
};
|
|
85
|
-
|
|
86
|
-
const boundSpecifiers = (node: DeclarationNode): ReadonlyArray<Bound> =>
|
|
87
|
-
(node.specifiers ?? []).map(boundOf).filter((one): one is Bound => one !== null);
|
|
88
|
-
|
|
89
21
|
// `import { A, B as C } from "pkg"` becomes `import * as A from "pkg/A"` and
|
|
90
22
|
// `import * as C from "pkg/B"`. Only whole-declaration rewrites are offered: a
|
|
91
23
|
// declaration mixing restricted named imports with a default or namespace one
|
|
92
24
|
// would need comma surgery inside the braces, and a fix that is subtly wrong is
|
|
93
25
|
// worse than a diagnostic the author resolves by hand.
|
|
94
|
-
const subpathNamespaceImport = (specifier: string, bound: ReadonlyArray<
|
|
26
|
+
const subpathNamespaceImport = (specifier: string, bound: ReadonlyArray<ReadBinding>): string =>
|
|
95
27
|
bound
|
|
96
28
|
.map((binding) => `import * as ${binding.local} from "${specifier}/${binding.symbol}";`)
|
|
97
29
|
.join("\n");
|
|
@@ -111,20 +43,16 @@ export const makeExportsRule = (policy: LoadedPolicy): OxlintRule => ({
|
|
|
111
43
|
let importer = "";
|
|
112
44
|
let selected: ReadonlyArray<SelectedExportRule> = [];
|
|
113
45
|
|
|
114
|
-
// `
|
|
115
|
-
//
|
|
116
|
-
//
|
|
117
|
-
const check = (
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
bound: ReadonlyArray<Bound>,
|
|
121
|
-
fixable: boolean,
|
|
122
|
-
): void => {
|
|
123
|
-
if (specifierValue === null || bound.length === 0) return;
|
|
46
|
+
// Only an `import` declaration can be rewritten into subpath namespace
|
|
47
|
+
// imports. `export *` and the whole-module forms are reported and left
|
|
48
|
+
// for the author.
|
|
49
|
+
const check = (edge: ReadEdge): void => {
|
|
50
|
+
const { bindings: bound, node, specifier } = edge;
|
|
51
|
+
if (bound.length === 0) return;
|
|
124
52
|
|
|
125
53
|
const outcome = evaluateSelectedBindings(selected, policy.resolver, {
|
|
126
54
|
importer,
|
|
127
|
-
specifier
|
|
55
|
+
specifier,
|
|
128
56
|
bindings: bound,
|
|
129
57
|
});
|
|
130
58
|
|
|
@@ -136,30 +64,30 @@ export const makeExportsRule = (policy: LoadedPolicy): OxlintRule => ({
|
|
|
136
64
|
|
|
137
65
|
for (const { bindings, rule, violation } of outcome.success) {
|
|
138
66
|
if (policy.baseline.isBaselined(violation)) continue;
|
|
139
|
-
const offending = bound.filter((one
|
|
67
|
+
const offending = bound.filter((one) =>
|
|
140
68
|
bindings.some((binding) => binding.symbol === one.symbol && binding.kind === one.kind),
|
|
141
69
|
);
|
|
142
70
|
// The rewrite is `import * as X from "pkg/<name>"`, which only means
|
|
143
71
|
// something for a named binding — a namespace one has no name to put
|
|
144
72
|
// in the subpath.
|
|
145
73
|
const rewritable =
|
|
146
|
-
|
|
74
|
+
edge.form === "import" &&
|
|
147
75
|
rule.fix === "subpath-namespace-import" &&
|
|
148
76
|
offending.length === bound.length &&
|
|
149
77
|
offending.every((one) => one.kind === "named");
|
|
150
78
|
|
|
151
79
|
if (rewritable) {
|
|
152
80
|
context.report({
|
|
153
|
-
node,
|
|
81
|
+
node: at(node),
|
|
154
82
|
message: formatMessage(violation),
|
|
155
83
|
fix: (fixer: Fixer) =>
|
|
156
|
-
fixer.replaceText(node, subpathNamespaceImport(
|
|
84
|
+
fixer.replaceText(at(node), subpathNamespaceImport(specifier, offending)),
|
|
157
85
|
});
|
|
158
86
|
continue;
|
|
159
87
|
}
|
|
160
88
|
|
|
161
89
|
context.report({
|
|
162
|
-
node: offending[0]?.node ?? node,
|
|
90
|
+
node: at(offending[0]?.node ?? node),
|
|
163
91
|
message: formatMessage(violation),
|
|
164
92
|
});
|
|
165
93
|
}
|
|
@@ -172,23 +100,8 @@ export const makeExportsRule = (policy: LoadedPolicy): OxlintRule => ({
|
|
|
172
100
|
selected = exportRulesSelecting(policy.exportRules, importer);
|
|
173
101
|
return selected.length > 0;
|
|
174
102
|
},
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
},
|
|
178
|
-
ExportNamedDeclaration(node: DeclarationNode) {
|
|
179
|
-
check(node, specifierOf(node), boundSpecifiers(node), false);
|
|
180
|
-
},
|
|
181
|
-
ExportAllDeclaration(node: ExportAllNode) {
|
|
182
|
-
check(node, specifierOf(node), [wholeModule(node, nameOf(node.exported) ?? "")], false);
|
|
183
|
-
},
|
|
184
|
-
ImportExpression(node: ImportExpressionNode) {
|
|
185
|
-
check(node, importExpressionSpecifierOf(node), [wholeModule(node)], false);
|
|
186
|
-
},
|
|
187
|
-
CallExpression(node: CallNode) {
|
|
188
|
-
check(node, requireSpecifierOf(node), [wholeModule(node)], false);
|
|
189
|
-
},
|
|
190
|
-
TSImportEqualsDeclaration(node: ImportEqualsNode) {
|
|
191
|
-
check(node, importEqualsSpecifierOf(node), [wholeModule(node)], false);
|
|
103
|
+
Program(node: Program) {
|
|
104
|
+
for (const edge of factsOfProgram(importer, node).edges) check(edge);
|
|
192
105
|
},
|
|
193
106
|
};
|
|
194
107
|
},
|