Skip to content

Commit 3e77b05

Browse files
committed
refactor(eslint): share provider identifier rule across packages
1 parent afdede5 commit 3e77b05

7 files changed

Lines changed: 230 additions & 141 deletions

File tree

‎packages/config-eslint/package.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55
"exports": {
66
"./base": "./base.js",
77
"./react": "./react.js",
8-
"./next-js": "./next.js"
8+
"./next-js": "./next.js",
9+
"./provider-identifiers": "./provider-identifiers.js"
10+
},
11+
"scripts": {
12+
"test": "node --test provider-identifiers.test.js"
913
},
1014
"devDependencies": {
1115
"@eslint/js": "9.39.4",
Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
const typescriptExpressionWrappers = new Set([
2+
"TSAsExpression",
3+
"TSNonNullExpression",
4+
"TSSatisfiesExpression",
5+
"TSTypeAssertion",
6+
])
7+
8+
function getStaticName(node) {
9+
if (node?.type === "Identifier") {
10+
return node.name
11+
}
12+
13+
if (node?.type === "MemberExpression") {
14+
if (!node.computed && node.property.type === "Identifier") {
15+
return node.property.name
16+
}
17+
18+
if (node.computed && node.property.type === "Literal" && typeof node.property.value === "string") {
19+
return node.property.value
20+
}
21+
}
22+
23+
if (node?.type === "Literal" && typeof node.value === "string") {
24+
return node.value
25+
}
26+
27+
return undefined
28+
}
29+
30+
function isProviderLike(node) {
31+
return getStaticName(node)?.toLowerCase().includes("provider") ?? false
32+
}
33+
34+
function isCanonicalProviderRegistry(node) {
35+
const name = getStaticName(node)
36+
return name === "providerIdentifiers" || name === "retiredProviderIdentifiers"
37+
}
38+
39+
export function createProviderIdentifierConfig({ providerIdentifiers, retiredProviderIdentifiers }) {
40+
const providerReplacementsByValue = new Map([
41+
...Object.entries(providerIdentifiers).map(([member, value]) => [value, `providerIdentifiers.${member}`]),
42+
...Object.entries(retiredProviderIdentifiers).map(([member, value]) => [
43+
value,
44+
`retiredProviderIdentifiers.${member}`,
45+
]),
46+
])
47+
48+
function getRawProvider(node) {
49+
while (typescriptExpressionWrappers.has(node?.type)) {
50+
node = node.expression
51+
}
52+
53+
if (node?.type === "Literal" && typeof node.value === "string") {
54+
const replacement = providerReplacementsByValue.get(node.value)
55+
return replacement ? { replacement, value: node.value } : undefined
56+
}
57+
58+
if (node?.type === "TemplateLiteral" && node.expressions.length === 0) {
59+
const value = node.quasis[0]?.value.cooked
60+
const replacement = value ? providerReplacementsByValue.get(value) : undefined
61+
return replacement ? { replacement, value } : undefined
62+
}
63+
64+
return undefined
65+
}
66+
67+
function getProviderMapDeclarator(objectExpression) {
68+
let expression = objectExpression
69+
while (typescriptExpressionWrappers.has(expression.parent?.type)) {
70+
expression = expression.parent
71+
}
72+
73+
const declarator = expression.parent
74+
return declarator?.type === "VariableDeclarator" && declarator.init === expression ? declarator : undefined
75+
}
76+
77+
const noRawProviderIdentifiers = {
78+
meta: {
79+
type: "problem",
80+
docs: { description: "Require canonical provider identifiers in provider-like contexts" },
81+
schema: [],
82+
messages: {
83+
useCanonical: 'Use {{replacement}} instead of the raw provider identifier "{{value}}".',
84+
},
85+
},
86+
create(context) {
87+
function reportIfRawProvider(node) {
88+
const provider = getRawProvider(node)
89+
if (provider) {
90+
context.report({ node, messageId: "useCanonical", data: provider })
91+
}
92+
}
93+
94+
function reportIfRawProviderMapKey(node) {
95+
if (node.computed || node.parent?.type !== "ObjectExpression") {
96+
return
97+
}
98+
99+
const declarator = getProviderMapDeclarator(node.parent)
100+
if (!declarator || !isProviderLike(declarator.id) || isCanonicalProviderRegistry(declarator.id)) {
101+
return
102+
}
103+
104+
const value = getStaticName(node.key)
105+
const replacement = value ? providerReplacementsByValue.get(value) : undefined
106+
if (replacement) {
107+
context.report({
108+
node: node.key,
109+
messageId: "useCanonical",
110+
data: { replacement, value },
111+
})
112+
}
113+
}
114+
115+
return {
116+
Property(node) {
117+
reportIfRawProviderMapKey(node)
118+
if (isProviderLike(node.key)) {
119+
reportIfRawProvider(node.value)
120+
}
121+
},
122+
PropertyDefinition(node) {
123+
if (isProviderLike(node.key)) {
124+
reportIfRawProvider(node.value)
125+
}
126+
},
127+
VariableDeclarator(node) {
128+
if (isProviderLike(node.id)) {
129+
reportIfRawProvider(node.init)
130+
}
131+
},
132+
AssignmentExpression(node) {
133+
if (isProviderLike(node.left)) {
134+
reportIfRawProvider(node.right)
135+
}
136+
},
137+
BinaryExpression(node) {
138+
if (!["===", "!==", "==", "!="].includes(node.operator)) {
139+
return
140+
}
141+
142+
if (isProviderLike(node.left)) {
143+
reportIfRawProvider(node.right)
144+
}
145+
if (isProviderLike(node.right)) {
146+
reportIfRawProvider(node.left)
147+
}
148+
},
149+
SwitchStatement(node) {
150+
if (isProviderLike(node.discriminant)) {
151+
for (const switchCase of node.cases) {
152+
reportIfRawProvider(switchCase.test)
153+
}
154+
}
155+
},
156+
}
157+
},
158+
}
159+
160+
return {
161+
files: ["**/*.ts", "**/*.tsx"],
162+
ignores: ["**/fixtures/**"],
163+
plugins: {
164+
zoo: {
165+
rules: {
166+
"no-raw-provider-identifiers": noRawProviderIdentifiers,
167+
},
168+
},
169+
},
170+
rules: {
171+
"zoo/no-raw-provider-identifiers": "error",
172+
},
173+
}
174+
}
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
import { RuleTester } from "eslint"
2+
3+
import { createProviderIdentifierConfig } from "./provider-identifiers.js"
4+
5+
const config = createProviderIdentifierConfig({
6+
providerIdentifiers: {
7+
openrouter: "openrouter",
8+
vercelAiGateway: "vercel-ai-gateway",
9+
},
10+
retiredProviderIdentifiers: {},
11+
})
12+
const rule = config.plugins.zoo.rules["no-raw-provider-identifiers"]
13+
14+
const ruleTester = new RuleTester({
15+
languageOptions: {
16+
ecmaVersion: 2022,
17+
sourceType: "module",
18+
},
19+
})
20+
21+
ruleTester.run("no-raw-provider-identifiers provider map keys", rule, {
22+
valid: [
23+
"const dynamicProviderExtras = { [providerIdentifiers.openrouter]: {} }",
24+
"const response = { openrouter: externalPayload }",
25+
'const providerIdentifiers = { openrouter: "openrouter", vercelAiGateway: "vercel-ai-gateway" }',
26+
],
27+
invalid: [
28+
{
29+
code: 'const dynamicProviderExtras = { openrouter: {}, "vercel-ai-gateway": {} }',
30+
errors: [
31+
{
32+
messageId: "useCanonical",
33+
data: { replacement: "providerIdentifiers.openrouter", value: "openrouter" },
34+
},
35+
{
36+
messageId: "useCanonical",
37+
data: { replacement: "providerIdentifiers.vercelAiGateway", value: "vercel-ai-gateway" },
38+
},
39+
],
40+
},
41+
],
42+
})

‎packages/types/eslint.config.mjs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
import { config } from "@roo-code/config-eslint/base"
2+
import { createProviderIdentifierConfig } from "@roo-code/config-eslint/provider-identifiers"
3+
import { providerIdentifiers, retiredProviderIdentifiers } from "./src/provider-identifiers.ts"
24
import globals from "globals"
35

46
/** @type {import("eslint").Linter.Config} */
57
export default [
68
...config,
9+
createProviderIdentifierConfig({ providerIdentifiers, retiredProviderIdentifiers }),
710
{
811
files: ["**/*.cjs"],
912
languageOptions: {

‎src/eslint-rules/no-raw-provider-identifiers.mjs‎

Lines changed: 0 additions & 122 deletions
This file was deleted.

0 commit comments

Comments
 (0)