@immense/vue-pom-generator 1.0.84 → 1.0.85
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/RELEASE_NOTES.md +53 -48
- package/class-generation/index.ts +234 -26
- package/dist/class-generation/index.d.ts +13 -0
- package/dist/class-generation/index.d.ts.map +1 -1
- package/dist/eslint/index.cjs +16 -3
- package/dist/eslint/index.cjs.map +1 -1
- package/dist/eslint/index.mjs +16 -3
- package/dist/eslint/index.mjs.map +1 -1
- package/dist/eslint/no-raw-playwright-apis.d.ts.map +1 -1
- package/dist/index.cjs +143 -23
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +143 -23
- package/dist/index.mjs.map +1 -1
- package/dist/router-introspection.d.ts +5 -0
- package/dist/router-introspection.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/eslint/index.mjs
CHANGED
|
@@ -79,7 +79,7 @@ const noPageFixtureInSpecsRule = {
|
|
|
79
79
|
};
|
|
80
80
|
}
|
|
81
81
|
};
|
|
82
|
-
const bannedPlaywrightApis = /* @__PURE__ */ new Set(["locator", "getByRole", "getByText", "getByLabel"]);
|
|
82
|
+
const bannedPlaywrightApis = /* @__PURE__ */ new Set(["locator", "getByRole", "getByText", "getByLabel", "getByTestId"]);
|
|
83
83
|
const bannedPageApis = /* @__PURE__ */ new Set([
|
|
84
84
|
"$eval",
|
|
85
85
|
"$$eval",
|
|
@@ -93,6 +93,16 @@ const SPEC_FILE_SUFFIXES = [".spec.ts", ".spec.tsx", ".spec.js", ".spec.jsx"];
|
|
|
93
93
|
function isSpecFile(filename) {
|
|
94
94
|
return SPEC_FILE_SUFFIXES.some((suffix) => filename.endsWith(suffix));
|
|
95
95
|
}
|
|
96
|
+
function resolveMemberPropertyName(callee) {
|
|
97
|
+
const { property, computed } = callee;
|
|
98
|
+
if (!computed && property.type === "Identifier") {
|
|
99
|
+
return property.name;
|
|
100
|
+
}
|
|
101
|
+
if (computed && property.type === "Literal" && typeof property.value === "string") {
|
|
102
|
+
return property.value;
|
|
103
|
+
}
|
|
104
|
+
return void 0;
|
|
105
|
+
}
|
|
96
106
|
const noRawPlaywrightApisRule = {
|
|
97
107
|
meta: {
|
|
98
108
|
type: "problem",
|
|
@@ -123,11 +133,14 @@ const noRawPlaywrightApisRule = {
|
|
|
123
133
|
});
|
|
124
134
|
return;
|
|
125
135
|
}
|
|
126
|
-
if (node.callee.type !== "MemberExpression"
|
|
136
|
+
if (node.callee.type !== "MemberExpression") {
|
|
137
|
+
return;
|
|
138
|
+
}
|
|
139
|
+
const apiName = resolveMemberPropertyName(node.callee);
|
|
140
|
+
if (apiName === void 0) {
|
|
127
141
|
return;
|
|
128
142
|
}
|
|
129
143
|
const objectText = sourceCode.getText(node.callee.object);
|
|
130
|
-
const apiName = node.callee.property.name;
|
|
131
144
|
if ((objectText === "page" || objectText === "playwrightPage") && bannedPageApis.has(apiName)) {
|
|
132
145
|
context.report({
|
|
133
146
|
node: node.callee.property,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sources":["../../eslint/no-page-fixture-in-specs.ts","../../eslint/no-raw-playwright-apis.ts","../../eslint/remove-existing-test-id-attributes.ts","../../eslint/index.ts"],"sourcesContent":["import path from \"node:path\";\nimport type { Rule } from \"eslint\";\nimport type { ArrowFunctionExpression, CallExpression, FunctionExpression } from \"estree\";\n\nconst DIRECT_TEST_CALLS = new Set([\"test\", \"it\"]);\nconst TEST_WRAPPER_CALLS = new Set([\"only\", \"skip\", \"fixme\", \"fail\"]);\nconst TEST_HOOK_CALLS = new Set([\"beforeEach\", \"beforeAll\", \"afterEach\", \"afterAll\"]);\nconst SPEC_FILE_SUFFIXES = new Set([\n\t\".spec.ts\",\n\t\".spec.tsx\",\n\t\".spec.js\",\n\t\".spec.jsx\",\n\t\".spec.cts\",\n\t\".spec.ctsx\",\n\t\".spec.cjs\",\n\t\".spec.cjsx\",\n\t\".spec.mts\",\n\t\".spec.mtsx\",\n\t\".spec.mjs\",\n\t\".spec.mjsx\",\n]);\n\nfunction isSpecFile(filename: string): boolean {\n\tconst basename = path.basename(filename);\n\treturn Array.from(SPEC_FILE_SUFFIXES).some(suffix => basename.endsWith(suffix));\n}\n\nfunction isFunctionExpression(\n\tnode: CallExpression[\"arguments\"][number] | null | undefined,\n): node is ArrowFunctionExpression | FunctionExpression {\n\treturn node != null\n\t\t&& typeof node === \"object\"\n\t\t&& \"type\" in node\n\t\t&& (node.type === \"ArrowFunctionExpression\" || node.type === \"FunctionExpression\");\n}\n\nfunction getCallbackArgIndex(callee: CallExpression[\"callee\"]): number | null {\n\tif (callee.type === \"Identifier\" && DIRECT_TEST_CALLS.has(callee.name))\n\t\treturn 1;\n\n\tif (\n\t\tcallee.type === \"MemberExpression\"\n\t\t&& !callee.computed\n\t\t&& callee.object.type === \"Identifier\"\n\t\t&& DIRECT_TEST_CALLS.has(callee.object.name)\n\t\t&& callee.property.type === \"Identifier\"\n\t) {\n\t\tif (TEST_WRAPPER_CALLS.has(callee.property.name))\n\t\t\treturn 1;\n\n\t\tif (TEST_HOOK_CALLS.has(callee.property.name))\n\t\t\treturn 0;\n\t}\n\n\treturn null;\n}\n\nfunction getPageFixtureProperty(param: ArrowFunctionExpression[\"params\"][0] | FunctionExpression[\"params\"][0]) {\n\tif (!param || param.type !== \"ObjectPattern\")\n\t\treturn null;\n\n\tfor (const property of param.properties) {\n\t\tif (property.type !== \"Property\" || property.computed)\n\t\t\tcontinue;\n\n\t\tif (property.key.type === \"Identifier\" && property.key.name === \"page\")\n\t\t\treturn property;\n\t}\n\n\treturn null;\n}\n\nexport const noPageFixtureInSpecsRule: Rule.RuleModule = {\n\tmeta: {\n\t\ttype: \"problem\",\n\t\tdocs: {\n\t\t\tdescription:\n\t\t\t\t\"Disallow Playwright's default `page` fixture in spec callbacks. Prefer generated fixtures and POMs instead.\",\n\t\t},\n\t\tmessages: {\n\t\t\tnoPageFixture:\n\t\t\t\t\"Do not destructure the default `page` fixture in spec callbacks. Use generated fixtures and POMs instead.\",\n\t\t},\n\t\tschema: [],\n\t},\n\tcreate(context) {\n\t\tconst filename = context.getFilename();\n\t\tif (!isSpecFile(filename))\n\t\t\treturn {};\n\n\t\treturn {\n\t\t\tCallExpression(node: CallExpression) {\n\t\t\t\tconst callbackArgIndex = getCallbackArgIndex(node.callee);\n\t\t\t\tif (callbackArgIndex == null)\n\t\t\t\t\treturn;\n\n\t\t\t\tconst callback = node.arguments[callbackArgIndex];\n\t\t\t\tif (!isFunctionExpression(callback))\n\t\t\t\t\treturn;\n\n\t\t\t\tconst pageFixtureProperty = getPageFixtureProperty(callback.params[0]);\n\t\t\t\tif (!pageFixtureProperty)\n\t\t\t\t\treturn;\n\n\t\t\t\tcontext.report({\n\t\t\t\t\tnode: pageFixtureProperty,\n\t\t\t\t\tmessageId: \"noPageFixture\",\n\t\t\t\t});\n\t\t\t},\n\t\t};\n\t},\n};\n","import type { Rule } from \"eslint\";\n\nconst bannedPlaywrightApis = new Set([\"locator\", \"getByRole\", \"getByText\", \"getByLabel\"]);\n\nconst bannedPageApis = new Set([\n\t\"$eval\",\n\t\"$$eval\",\n\t\"click\",\n\t\"evaluate\",\n\t\"isHidden\",\n\t\"isVisible\",\n\t\"waitForSelector\",\n]);\n\nconst SPEC_FILE_SUFFIXES = [\".spec.ts\", \".spec.tsx\", \".spec.js\", \".spec.jsx\"];\n\nfunction isSpecFile(filename: string): boolean {\n\treturn SPEC_FILE_SUFFIXES.some((suffix) => filename.endsWith(suffix));\n}\n\nexport const noRawPlaywrightApisRule: Rule.RuleModule = {\n\tmeta: {\n\t\ttype: \"problem\",\n\t\tdocs: {\n\t\t\tdescription:\n\t\t\t\t\"Ban raw Playwright APIs in spec files. Use generated fixtures/POMs or a custom POM for unsupported surfaces instead.\",\n\t\t},\n\t\tmessages: {\n\t\t\tlegacyCursorHelper:\n\t\t\t\t\"Do not use {{name}} in Playwright spec files. Prefer generated fixtures/POMs or a custom POM for unsupported surfaces.\",\n\t\t\trawPlaywrightApi:\n\t\t\t\t\"Do not call {{name}} directly in Playwright spec files. Prefer generated fixtures/POM methods or a custom POM for unsupported surfaces.\",\n\t\t\trawPlaywrightPageApi:\n\t\t\t\t\"Do not call page.{{name}} directly in Playwright spec files. Prefer generated fixtures/POM methods or a custom POM for unsupported surfaces.\",\n\t\t},\n\t\tschema: [],\n\t},\n\tcreate(context) {\n\t\tif (!isSpecFile(context.filename)) {\n\t\t\treturn {};\n\t\t}\n\n\t\tconst sourceCode = context.sourceCode;\n\n\t\treturn {\n\t\t\tCallExpression(node) {\n\t\t\t\tif (node.callee.type === \"Identifier\" && node.callee.name.includes(\"animateCursor\")) {\n\t\t\t\t\tcontext.report({\n\t\t\t\t\t\tnode: node.callee,\n\t\t\t\t\t\tmessageId: \"legacyCursorHelper\",\n\t\t\t\t\t\tdata: {\n\t\t\t\t\t\t\tname: node.callee.name,\n\t\t\t\t\t\t},\n\t\t\t\t\t});\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tif (\n\t\t\t\t\tnode.callee.type !== \"MemberExpression\"\n\t\t\t\t\t|| node.callee.computed\n\t\t\t\t\t|| node.callee.property.type !== \"Identifier\"\n\t\t\t\t) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tconst objectText = sourceCode.getText(node.callee.object);\n\t\t\t\tconst apiName = node.callee.property.name;\n\n\t\t\t\tif (\n\t\t\t\t\t(objectText === \"page\" || objectText === \"playwrightPage\")\n\t\t\t\t\t&& bannedPageApis.has(apiName)\n\t\t\t\t) {\n\t\t\t\t\tcontext.report({\n\t\t\t\t\t\tnode: node.callee.property,\n\t\t\t\t\t\tmessageId: \"rawPlaywrightPageApi\",\n\t\t\t\t\t\tdata: {\n\t\t\t\t\t\t\tname: apiName,\n\t\t\t\t\t\t},\n\t\t\t\t\t});\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tif (!bannedPlaywrightApis.has(apiName)) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tcontext.report({\n\t\t\t\t\tnode: node.callee.property,\n\t\t\t\t\tmessageId: \"rawPlaywrightApi\",\n\t\t\t\t\tdata: {\n\t\t\t\t\t\tname: apiName,\n\t\t\t\t\t},\n\t\t\t\t});\n\t\t\t},\n\t\t};\n\t},\n};\n","import type { Rule } from \"eslint\";\nimport type { AST as VueAST } from \"vue-eslint-parser\";\n\ntype VAttribute = VueAST.VAttribute;\ntype VDirective = VueAST.VDirective;\ntype VElement = VueAST.VElement;\ntype VueAttribute = VAttribute | VDirective;\ntype VueTemplateVisitor = {\n\tVElement: (node: VElement) => void;\n};\n\nfunction isVueTemplateFile(filename: string): boolean {\n\treturn filename.endsWith(\".vue\");\n}\n\nfunction isWhitespaceCharacter(character: string): boolean {\n\treturn character === \" \"\n\t\t|| character === \"\\t\"\n\t\t|| character === \"\\n\"\n\t\t|| character === \"\\r\"\n\t\t|| character === \"\\f\";\n}\n\nfunction removeAttributeWithWhitespace(\n\tattribute: VueAttribute,\n\tcontext: Rule.RuleContext,\n\tfixer: Rule.RuleFixer,\n): Rule.Fix {\n\tconst sourceText = context.sourceCode.getText();\n\tconst [start, end] = attribute.range;\n\n\tlet adjustedStart = start;\n\twhile (adjustedStart > 0 && isWhitespaceCharacter(sourceText[adjustedStart - 1])) {\n\t\tadjustedStart -= 1;\n\t}\n\n\treturn fixer.removeRange([adjustedStart, end]);\n}\n\nfunction isTargetAttribute(attribute: VueAttribute, attributeName: string): boolean {\n\tif (!attribute.directive) {\n\t\treturn attribute.key.type === \"VIdentifier\" && attribute.key.name === attributeName;\n\t}\n\n\tif (attribute.key.type !== \"VDirectiveKey\") {\n\t\treturn false;\n\t}\n\n\tconst directiveName = attribute.key.name;\n\tconst argument = attribute.key.argument;\n\n\treturn directiveName.type === \"VIdentifier\"\n\t\t&& directiveName.name === \"bind\"\n\t\t&& argument?.type === \"VIdentifier\"\n\t\t&& argument.name === attributeName;\n}\n\nfunction findExistingTestIdAttribute(node: VElement, attributeName: string): VueAttribute | undefined {\n\treturn node.startTag.attributes.find(attribute => isTargetAttribute(attribute, attributeName));\n}\n\nfunction defineVueTemplateVisitor(\n\tcontext: Rule.RuleContext,\n\ttemplateVisitor: VueTemplateVisitor,\n): Rule.RuleListener {\n\tconst parserServices = context.sourceCode.parserServices as {\n\t\tdefineTemplateBodyVisitor?: (\n\t\t\ttemplateBodyVisitor: VueTemplateVisitor,\n\t\t\tscriptVisitor: Rule.RuleListener,\n\t\t\toptions: { templateBodyTriggerSelector: \"Program\" },\n\t\t) => Rule.RuleListener;\n\t};\n\n\tif (!parserServices.defineTemplateBodyVisitor) {\n\t\treturn {};\n\t}\n\n\treturn parserServices.defineTemplateBodyVisitor(\n\t\ttemplateVisitor,\n\t\t{},\n\t\t{ templateBodyTriggerSelector: \"Program\" },\n\t);\n}\n\nexport const removeExistingTestIdAttributesRule: Rule.RuleModule = {\n\tmeta: {\n\t\ttype: \"suggestion\",\n\t\tdocs: {\n\t\t\tdescription:\n\t\t\t\t\"Remove existing test-id attributes from Vue templates so vue-pom-generator can generate them consistently.\",\n\t\t},\n\t\tfixable: \"code\",\n\t\tmessages: {\n\t\t\tremoveExistingTestIdAttribute:\n\t\t\t\t\"Remove explicit {{attribute}}. vue-pom-generator can generate it; run this rule with --fix to clean legacy attributes project-wide.\",\n\t\t},\n\t\tschema: [\n\t\t\t{\n\t\t\t\ttype: \"object\",\n\t\t\t\tproperties: {\n\t\t\t\t\tattribute: {\n\t\t\t\t\t\ttype: \"string\",\n\t\t\t\t\t\tdescription: \"Attribute name to remove. Defaults to data-testid.\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tadditionalProperties: false,\n\t\t\t},\n\t\t],\n\t},\n\tcreate(context): Rule.RuleListener {\n\t\tif (!isVueTemplateFile(context.filename)) {\n\t\t\treturn {};\n\t\t}\n\n\t\tconst options = (context.options[0] ?? {}) as { attribute?: string };\n\t\tconst attributeName = (options.attribute ?? \"data-testid\").trim() || \"data-testid\";\n\n\t\treturn defineVueTemplateVisitor(context, {\n\t\t\tVElement(node: VElement) {\n\t\t\t\tconst existingAttribute = findExistingTestIdAttribute(node, attributeName);\n\t\t\t\tif (!existingAttribute) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tcontext.report({\n\t\t\t\t\tnode: existingAttribute,\n\t\t\t\t\tmessageId: \"removeExistingTestIdAttribute\",\n\t\t\t\t\tdata: { attribute: attributeName },\n\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\treturn removeAttributeWithWhitespace(existingAttribute, context, fixer);\n\t\t\t\t\t},\n\t\t\t\t});\n\t\t\t},\n\t\t});\n\t},\n};","import type { Rule } from \"eslint\";\nimport type { CallExpression, Expression, MemberExpression } from \"estree\";\n\nimport { noPageFixtureInSpecsRule } from \"./no-page-fixture-in-specs\";\nimport { noRawPlaywrightApisRule } from \"./no-raw-playwright-apis\";\nimport { removeExistingTestIdAttributesRule } from \"./remove-existing-test-id-attributes\";\n\n/**\n * Playwright locator action methods that should be called via generated POM\n * methods rather than directly on element getters.\n */\nconst LOCATOR_ACTIONS = new Set([\n\t\"click\",\n\t\"dblclick\",\n\t\"fill\",\n\t\"check\",\n\t\"uncheck\",\n\t\"type\",\n\t\"clear\",\n\t\"selectOption\",\n\t\"setInputFiles\",\n\t\"tap\",\n\t\"hover\",\n\t\"focus\",\n\t\"dispatchEvent\",\n\t\"press\",\n\t\"selectText\",\n]);\n\n/**\n * Locator chain methods that are transparent for the purposes of this rule —\n * `.last().click()` is still a raw action on a POM getter.\n */\nconst CHAIN_METHODS = new Set([\"last\", \"first\", \"nth\", \"filter\"]);\n\nfunction startsWithUppercaseLetter(value: string): boolean {\n\tconst first = value.charCodeAt(0);\n\treturn first >= 65 && first <= 90;\n}\n\n/**\n * Returns the PascalCase getter name if `node` is (or chains from) a direct\n * PascalCase member-expression access. Returns null otherwise.\n *\n * Handles:\n * pom.SubmitButton → \"SubmitButton\"\n * pom.SubmitButton.last() → \"SubmitButton\"\n * pom.SubmitButton.nth(0) → \"SubmitButton\"\n */\nfunction getPomGetterName(node: Expression): string | null {\n\tif (node.type === \"MemberExpression\" && !node.computed && node.property.type === \"Identifier\") {\n\t\tconst name = node.property.name;\n\t\tif (startsWithUppercaseLetter(name)) return name;\n\t}\n\n\tif (\n\t\tnode.type === \"CallExpression\"\n\t\t&& node.callee.type === \"MemberExpression\"\n\t\t&& !node.callee.computed\n\t\t&& node.callee.property.type === \"Identifier\"\n\t\t&& CHAIN_METHODS.has(node.callee.property.name)\n\t) {\n\t\treturn getPomGetterName((node.callee as MemberExpression).object as Expression);\n\t}\n\n\treturn null;\n}\n\nexport const noRawLocatorActionRule: Rule.RuleModule = {\n\tmeta: {\n\t\ttype: \"suggestion\",\n\t\tdocs: {\n\t\t\tdescription:\n\t\t\t\t\"Disallow calling raw Playwright action methods directly on POM element getters. Use the generated typed POM methods instead (e.g. `clickSubmitButton()`).\",\n\t\t},\n\t\tmessages: {\n\t\t\tnoRawAction:\n\t\t\t\t\"Use the generated POM method instead of `{{getter}}.{{method}}()`. \"\n\t\t\t\t+ \"Call `click{{getter}}()` / `type{{getter}}(text)` or similar.\",\n\t\t},\n\t\tschema: [],\n\t},\n\tcreate(context) {\n\t\treturn {\n\t\t\tCallExpression(node: CallExpression) {\n\t\t\t\tif (node.callee.type !== \"MemberExpression\") return;\n\t\t\t\tconst callee = node.callee as MemberExpression;\n\t\t\t\tif (callee.computed || callee.property.type !== \"Identifier\") return;\n\n\t\t\t\tconst methodName = callee.property.name;\n\t\t\t\tif (!LOCATOR_ACTIONS.has(methodName)) return;\n\n\t\t\t\tconst getterName = getPomGetterName(callee.object as Expression);\n\t\t\t\tif (!getterName) return;\n\n\t\t\t\tcontext.report({\n\t\t\t\t\tnode,\n\t\t\t\t\tmessageId: \"noRawAction\",\n\t\t\t\t\tdata: { getter: getterName, method: methodName },\n\t\t\t\t});\n\t\t\t},\n\t\t};\n\t},\n};\n\nexport const plugin = {\n\trules: {\n\t\t\"no-page-fixture-in-specs\": noPageFixtureInSpecsRule,\n\t\t\"no-raw-locator-action\": noRawLocatorActionRule,\n\t\t\"no-raw-playwright-apis\": noRawPlaywrightApisRule,\n\t\t\"remove-existing-test-id-attributes\": removeExistingTestIdAttributesRule,\n\t},\n} satisfies { rules: Record<string, Rule.RuleModule> };\n\nexport { noPageFixtureInSpecsRule };\nexport { noRawPlaywrightApisRule };\nexport { removeExistingTestIdAttributesRule };\n"],"names":["SPEC_FILE_SUFFIXES","isSpecFile"],"mappings":";AAIA,MAAM,oBAAoB,oBAAI,IAAI,CAAC,QAAQ,IAAI,CAAC;AAChD,MAAM,yCAAyB,IAAI,CAAC,QAAQ,QAAQ,SAAS,MAAM,CAAC;AACpE,MAAM,sCAAsB,IAAI,CAAC,cAAc,aAAa,aAAa,UAAU,CAAC;AACpF,MAAMA,2CAAyB,IAAI;AAAA,EAClC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC;AAED,SAASC,aAAW,UAA2B;AAC9C,QAAM,WAAW,KAAK,SAAS,QAAQ;AACvC,SAAO,MAAM,KAAKD,oBAAkB,EAAE,KAAK,CAAA,WAAU,SAAS,SAAS,MAAM,CAAC;AAC/E;AAEA,SAAS,qBACR,MACuD;AACvD,SAAO,QAAQ,QACX,OAAO,SAAS,YAChB,UAAU,SACT,KAAK,SAAS,6BAA6B,KAAK,SAAS;AAC/D;AAEA,SAAS,oBAAoB,QAAiD;AAC7E,MAAI,OAAO,SAAS,gBAAgB,kBAAkB,IAAI,OAAO,IAAI;AACpE,WAAO;AAER,MACC,OAAO,SAAS,sBACb,CAAC,OAAO,YACR,OAAO,OAAO,SAAS,gBACvB,kBAAkB,IAAI,OAAO,OAAO,IAAI,KACxC,OAAO,SAAS,SAAS,cAC3B;AACD,QAAI,mBAAmB,IAAI,OAAO,SAAS,IAAI;AAC9C,aAAO;AAER,QAAI,gBAAgB,IAAI,OAAO,SAAS,IAAI;AAC3C,aAAO;AAAA,EACT;AAEA,SAAO;AACR;AAEA,SAAS,uBAAuB,OAA+E;AAC9G,MAAI,CAAC,SAAS,MAAM,SAAS;AAC5B,WAAO;AAER,aAAW,YAAY,MAAM,YAAY;AACxC,QAAI,SAAS,SAAS,cAAc,SAAS;AAC5C;AAED,QAAI,SAAS,IAAI,SAAS,gBAAgB,SAAS,IAAI,SAAS;AAC/D,aAAO;AAAA,EACT;AAEA,SAAO;AACR;AAEO,MAAM,2BAA4C;AAAA,EACxD,MAAM;AAAA,IACL,MAAM;AAAA,IACN,MAAM;AAAA,MACL,aACC;AAAA,IAAA;AAAA,IAEF,UAAU;AAAA,MACT,eACC;AAAA,IAAA;AAAA,IAEF,QAAQ,CAAA;AAAA,EAAC;AAAA,EAEV,OAAO,SAAS;AACf,UAAM,WAAW,QAAQ,YAAA;AACzB,QAAI,CAACC,aAAW,QAAQ;AACvB,aAAO,CAAA;AAER,WAAO;AAAA,MACN,eAAe,MAAsB;AACpC,cAAM,mBAAmB,oBAAoB,KAAK,MAAM;AACxD,YAAI,oBAAoB;AACvB;AAED,cAAM,WAAW,KAAK,UAAU,gBAAgB;AAChD,YAAI,CAAC,qBAAqB,QAAQ;AACjC;AAED,cAAM,sBAAsB,uBAAuB,SAAS,OAAO,CAAC,CAAC;AACrE,YAAI,CAAC;AACJ;AAED,gBAAQ,OAAO;AAAA,UACd,MAAM;AAAA,UACN,WAAW;AAAA,QAAA,CACX;AAAA,MACF;AAAA,IAAA;AAAA,EAEF;AACD;AC7GA,MAAM,2CAA2B,IAAI,CAAC,WAAW,aAAa,aAAa,YAAY,CAAC;AAExF,MAAM,qCAAqB,IAAI;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC;AAED,MAAM,qBAAqB,CAAC,YAAY,aAAa,YAAY,WAAW;AAE5E,SAAS,WAAW,UAA2B;AAC9C,SAAO,mBAAmB,KAAK,CAAC,WAAW,SAAS,SAAS,MAAM,CAAC;AACrE;AAEO,MAAM,0BAA2C;AAAA,EACvD,MAAM;AAAA,IACL,MAAM;AAAA,IACN,MAAM;AAAA,MACL,aACC;AAAA,IAAA;AAAA,IAEF,UAAU;AAAA,MACT,oBACC;AAAA,MACD,kBACC;AAAA,MACD,sBACC;AAAA,IAAA;AAAA,IAEF,QAAQ,CAAA;AAAA,EAAC;AAAA,EAEV,OAAO,SAAS;AACf,QAAI,CAAC,WAAW,QAAQ,QAAQ,GAAG;AAClC,aAAO,CAAA;AAAA,IACR;AAEA,UAAM,aAAa,QAAQ;AAE3B,WAAO;AAAA,MACN,eAAe,MAAM;AACpB,YAAI,KAAK,OAAO,SAAS,gBAAgB,KAAK,OAAO,KAAK,SAAS,eAAe,GAAG;AACpF,kBAAQ,OAAO;AAAA,YACd,MAAM,KAAK;AAAA,YACX,WAAW;AAAA,YACX,MAAM;AAAA,cACL,MAAM,KAAK,OAAO;AAAA,YAAA;AAAA,UACnB,CACA;AACD;AAAA,QACD;AAEA,YACC,KAAK,OAAO,SAAS,sBAClB,KAAK,OAAO,YACZ,KAAK,OAAO,SAAS,SAAS,cAChC;AACD;AAAA,QACD;AAEA,cAAM,aAAa,WAAW,QAAQ,KAAK,OAAO,MAAM;AACxD,cAAM,UAAU,KAAK,OAAO,SAAS;AAErC,aACE,eAAe,UAAU,eAAe,qBACtC,eAAe,IAAI,OAAO,GAC5B;AACD,kBAAQ,OAAO;AAAA,YACd,MAAM,KAAK,OAAO;AAAA,YAClB,WAAW;AAAA,YACX,MAAM;AAAA,cACL,MAAM;AAAA,YAAA;AAAA,UACP,CACA;AACD;AAAA,QACD;AAEA,YAAI,CAAC,qBAAqB,IAAI,OAAO,GAAG;AACvC;AAAA,QACD;AAEA,gBAAQ,OAAO;AAAA,UACd,MAAM,KAAK,OAAO;AAAA,UAClB,WAAW;AAAA,UACX,MAAM;AAAA,YACL,MAAM;AAAA,UAAA;AAAA,QACP,CACA;AAAA,MACF;AAAA,IAAA;AAAA,EAEF;AACD;ACrFA,SAAS,kBAAkB,UAA2B;AACrD,SAAO,SAAS,SAAS,MAAM;AAChC;AAEA,SAAS,sBAAsB,WAA4B;AAC1D,SAAO,cAAc,OACjB,cAAc,OACd,cAAc,QACd,cAAc,QACd,cAAc;AACnB;AAEA,SAAS,8BACR,WACA,SACA,OACW;AACX,QAAM,aAAa,QAAQ,WAAW,QAAA;AACtC,QAAM,CAAC,OAAO,GAAG,IAAI,UAAU;AAE/B,MAAI,gBAAgB;AACpB,SAAO,gBAAgB,KAAK,sBAAsB,WAAW,gBAAgB,CAAC,CAAC,GAAG;AACjF,qBAAiB;AAAA,EAClB;AAEA,SAAO,MAAM,YAAY,CAAC,eAAe,GAAG,CAAC;AAC9C;AAEA,SAAS,kBAAkB,WAAyB,eAAgC;AACnF,MAAI,CAAC,UAAU,WAAW;AACzB,WAAO,UAAU,IAAI,SAAS,iBAAiB,UAAU,IAAI,SAAS;AAAA,EACvE;AAEA,MAAI,UAAU,IAAI,SAAS,iBAAiB;AAC3C,WAAO;AAAA,EACR;AAEA,QAAM,gBAAgB,UAAU,IAAI;AACpC,QAAM,WAAW,UAAU,IAAI;AAE/B,SAAO,cAAc,SAAS,iBAC1B,cAAc,SAAS,UACvB,UAAU,SAAS,iBACnB,SAAS,SAAS;AACvB;AAEA,SAAS,4BAA4B,MAAgB,eAAiD;AACrG,SAAO,KAAK,SAAS,WAAW,KAAK,eAAa,kBAAkB,WAAW,aAAa,CAAC;AAC9F;AAEA,SAAS,yBACR,SACA,iBACoB;AACpB,QAAM,iBAAiB,QAAQ,WAAW;AAQ1C,MAAI,CAAC,eAAe,2BAA2B;AAC9C,WAAO,CAAA;AAAA,EACR;AAEA,SAAO,eAAe;AAAA,IACrB;AAAA,IACA,CAAA;AAAA,IACA,EAAE,6BAA6B,UAAA;AAAA,EAAU;AAE3C;AAEO,MAAM,qCAAsD;AAAA,EAClE,MAAM;AAAA,IACL,MAAM;AAAA,IACN,MAAM;AAAA,MACL,aACC;AAAA,IAAA;AAAA,IAEF,SAAS;AAAA,IACT,UAAU;AAAA,MACT,+BACC;AAAA,IAAA;AAAA,IAEF,QAAQ;AAAA,MACP;AAAA,QACC,MAAM;AAAA,QACN,YAAY;AAAA,UACX,WAAW;AAAA,YACV,MAAM;AAAA,YACN,aAAa;AAAA,UAAA;AAAA,QACd;AAAA,QAED,sBAAsB;AAAA,MAAA;AAAA,IACvB;AAAA,EACD;AAAA,EAED,OAAO,SAA4B;AAClC,QAAI,CAAC,kBAAkB,QAAQ,QAAQ,GAAG;AACzC,aAAO,CAAA;AAAA,IACR;AAEA,UAAM,UAAW,QAAQ,QAAQ,CAAC,KAAK,CAAA;AACvC,UAAM,iBAAiB,QAAQ,aAAa,eAAe,UAAU;AAErE,WAAO,yBAAyB,SAAS;AAAA,MACxC,SAAS,MAAgB;AACxB,cAAM,oBAAoB,4BAA4B,MAAM,aAAa;AACzE,YAAI,CAAC,mBAAmB;AACvB;AAAA,QACD;AAEA,gBAAQ,OAAO;AAAA,UACd,MAAM;AAAA,UACN,WAAW;AAAA,UACX,MAAM,EAAE,WAAW,cAAA;AAAA,UACnB,IAAI,OAAO;AACV,mBAAO,8BAA8B,mBAAmB,SAAS,KAAK;AAAA,UACvE;AAAA,QAAA,CACA;AAAA,MACF;AAAA,IAAA,CACA;AAAA,EACF;AACD;AC5HA,MAAM,sCAAsB,IAAI;AAAA,EAC/B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC;AAMD,MAAM,oCAAoB,IAAI,CAAC,QAAQ,SAAS,OAAO,QAAQ,CAAC;AAEhE,SAAS,0BAA0B,OAAwB;AAC1D,QAAM,QAAQ,MAAM,WAAW,CAAC;AAChC,SAAO,SAAS,MAAM,SAAS;AAChC;AAWA,SAAS,iBAAiB,MAAiC;AAC1D,MAAI,KAAK,SAAS,sBAAsB,CAAC,KAAK,YAAY,KAAK,SAAS,SAAS,cAAc;AAC9F,UAAM,OAAO,KAAK,SAAS;AAC3B,QAAI,0BAA0B,IAAI,EAAG,QAAO;AAAA,EAC7C;AAEA,MACC,KAAK,SAAS,oBACX,KAAK,OAAO,SAAS,sBACrB,CAAC,KAAK,OAAO,YACb,KAAK,OAAO,SAAS,SAAS,gBAC9B,cAAc,IAAI,KAAK,OAAO,SAAS,IAAI,GAC7C;AACD,WAAO,iBAAkB,KAAK,OAA4B,MAAoB;AAAA,EAC/E;AAEA,SAAO;AACR;AAEO,MAAM,yBAA0C;AAAA,EACtD,MAAM;AAAA,IACL,MAAM;AAAA,IACN,MAAM;AAAA,MACL,aACC;AAAA,IAAA;AAAA,IAEF,UAAU;AAAA,MACT,aACC;AAAA,IAAA;AAAA,IAGF,QAAQ,CAAA;AAAA,EAAC;AAAA,EAEV,OAAO,SAAS;AACf,WAAO;AAAA,MACN,eAAe,MAAsB;AACpC,YAAI,KAAK,OAAO,SAAS,mBAAoB;AAC7C,cAAM,SAAS,KAAK;AACpB,YAAI,OAAO,YAAY,OAAO,SAAS,SAAS,aAAc;AAE9D,cAAM,aAAa,OAAO,SAAS;AACnC,YAAI,CAAC,gBAAgB,IAAI,UAAU,EAAG;AAEtC,cAAM,aAAa,iBAAiB,OAAO,MAAoB;AAC/D,YAAI,CAAC,WAAY;AAEjB,gBAAQ,OAAO;AAAA,UACd;AAAA,UACA,WAAW;AAAA,UACX,MAAM,EAAE,QAAQ,YAAY,QAAQ,WAAA;AAAA,QAAW,CAC/C;AAAA,MACF;AAAA,IAAA;AAAA,EAEF;AACD;AAEO,MAAM,SAAS;AAAA,EACrB,OAAO;AAAA,IACN,4BAA4B;AAAA,IAC5B,yBAAyB;AAAA,IACzB,0BAA0B;AAAA,IAC1B,sCAAsC;AAAA,EAAA;AAExC;"}
|
|
1
|
+
{"version":3,"file":"index.mjs","sources":["../../eslint/no-page-fixture-in-specs.ts","../../eslint/no-raw-playwright-apis.ts","../../eslint/remove-existing-test-id-attributes.ts","../../eslint/index.ts"],"sourcesContent":["import path from \"node:path\";\nimport type { Rule } from \"eslint\";\nimport type { ArrowFunctionExpression, CallExpression, FunctionExpression } from \"estree\";\n\nconst DIRECT_TEST_CALLS = new Set([\"test\", \"it\"]);\nconst TEST_WRAPPER_CALLS = new Set([\"only\", \"skip\", \"fixme\", \"fail\"]);\nconst TEST_HOOK_CALLS = new Set([\"beforeEach\", \"beforeAll\", \"afterEach\", \"afterAll\"]);\nconst SPEC_FILE_SUFFIXES = new Set([\n\t\".spec.ts\",\n\t\".spec.tsx\",\n\t\".spec.js\",\n\t\".spec.jsx\",\n\t\".spec.cts\",\n\t\".spec.ctsx\",\n\t\".spec.cjs\",\n\t\".spec.cjsx\",\n\t\".spec.mts\",\n\t\".spec.mtsx\",\n\t\".spec.mjs\",\n\t\".spec.mjsx\",\n]);\n\nfunction isSpecFile(filename: string): boolean {\n\tconst basename = path.basename(filename);\n\treturn Array.from(SPEC_FILE_SUFFIXES).some(suffix => basename.endsWith(suffix));\n}\n\nfunction isFunctionExpression(\n\tnode: CallExpression[\"arguments\"][number] | null | undefined,\n): node is ArrowFunctionExpression | FunctionExpression {\n\treturn node != null\n\t\t&& typeof node === \"object\"\n\t\t&& \"type\" in node\n\t\t&& (node.type === \"ArrowFunctionExpression\" || node.type === \"FunctionExpression\");\n}\n\nfunction getCallbackArgIndex(callee: CallExpression[\"callee\"]): number | null {\n\tif (callee.type === \"Identifier\" && DIRECT_TEST_CALLS.has(callee.name))\n\t\treturn 1;\n\n\tif (\n\t\tcallee.type === \"MemberExpression\"\n\t\t&& !callee.computed\n\t\t&& callee.object.type === \"Identifier\"\n\t\t&& DIRECT_TEST_CALLS.has(callee.object.name)\n\t\t&& callee.property.type === \"Identifier\"\n\t) {\n\t\tif (TEST_WRAPPER_CALLS.has(callee.property.name))\n\t\t\treturn 1;\n\n\t\tif (TEST_HOOK_CALLS.has(callee.property.name))\n\t\t\treturn 0;\n\t}\n\n\treturn null;\n}\n\nfunction getPageFixtureProperty(param: ArrowFunctionExpression[\"params\"][0] | FunctionExpression[\"params\"][0]) {\n\tif (!param || param.type !== \"ObjectPattern\")\n\t\treturn null;\n\n\tfor (const property of param.properties) {\n\t\tif (property.type !== \"Property\" || property.computed)\n\t\t\tcontinue;\n\n\t\tif (property.key.type === \"Identifier\" && property.key.name === \"page\")\n\t\t\treturn property;\n\t}\n\n\treturn null;\n}\n\nexport const noPageFixtureInSpecsRule: Rule.RuleModule = {\n\tmeta: {\n\t\ttype: \"problem\",\n\t\tdocs: {\n\t\t\tdescription:\n\t\t\t\t\"Disallow Playwright's default `page` fixture in spec callbacks. Prefer generated fixtures and POMs instead.\",\n\t\t},\n\t\tmessages: {\n\t\t\tnoPageFixture:\n\t\t\t\t\"Do not destructure the default `page` fixture in spec callbacks. Use generated fixtures and POMs instead.\",\n\t\t},\n\t\tschema: [],\n\t},\n\tcreate(context) {\n\t\tconst filename = context.getFilename();\n\t\tif (!isSpecFile(filename))\n\t\t\treturn {};\n\n\t\treturn {\n\t\t\tCallExpression(node: CallExpression) {\n\t\t\t\tconst callbackArgIndex = getCallbackArgIndex(node.callee);\n\t\t\t\tif (callbackArgIndex == null)\n\t\t\t\t\treturn;\n\n\t\t\t\tconst callback = node.arguments[callbackArgIndex];\n\t\t\t\tif (!isFunctionExpression(callback))\n\t\t\t\t\treturn;\n\n\t\t\t\tconst pageFixtureProperty = getPageFixtureProperty(callback.params[0]);\n\t\t\t\tif (!pageFixtureProperty)\n\t\t\t\t\treturn;\n\n\t\t\t\tcontext.report({\n\t\t\t\t\tnode: pageFixtureProperty,\n\t\t\t\t\tmessageId: \"noPageFixture\",\n\t\t\t\t});\n\t\t\t},\n\t\t};\n\t},\n};\n","import type { Rule } from \"eslint\";\nimport type { MemberExpression } from \"estree\";\n\n// Locator-filter methods available on Page/Locator/Frame etc. Banned regardless of\n// the receiver object. `getByTestId` is the generator's own test-id contract — specs\n// should reach it through a generated POM accessor, never a raw `*.getByTestId(...)`.\nconst bannedPlaywrightApis = new Set([\"locator\", \"getByRole\", \"getByText\", \"getByLabel\", \"getByTestId\"]);\n\nconst bannedPageApis = new Set([\n\t\"$eval\",\n\t\"$$eval\",\n\t\"click\",\n\t\"evaluate\",\n\t\"isHidden\",\n\t\"isVisible\",\n\t\"waitForSelector\",\n]);\n\nconst SPEC_FILE_SUFFIXES = [\".spec.ts\", \".spec.tsx\", \".spec.js\", \".spec.jsx\"];\n\nfunction isSpecFile(filename: string): boolean {\n\treturn SPEC_FILE_SUFFIXES.some((suffix) => filename.endsWith(suffix));\n}\n\n/**\n * Resolve the accessed property name from a MemberExpression callee, covering both\n * the usual member access (`page.getByTestId(...)`) and the computed equivalent\n * (`page[\"getByTestId\"](...)`). A computed access whose key is a non-Literal\n * (e.g. `obj[dynamicKey]()`) cannot be resolved to a name, so it returns\n * `undefined` and is left alone — it could be anything at runtime.\n */\nfunction resolveMemberPropertyName(callee: MemberExpression): string | undefined {\n\tconst { property, computed } = callee;\n\tif (!computed && property.type === \"Identifier\") {\n\t\treturn property.name;\n\t}\n\tif (computed && property.type === \"Literal\" && typeof property.value === \"string\") {\n\t\treturn property.value;\n\t}\n\treturn undefined;\n}\n\nexport const noRawPlaywrightApisRule: Rule.RuleModule = {\n\tmeta: {\n\t\ttype: \"problem\",\n\t\tdocs: {\n\t\t\tdescription:\n\t\t\t\t\"Ban raw Playwright APIs in spec files. Use generated fixtures/POMs or a custom POM for unsupported surfaces instead.\",\n\t\t},\n\t\tmessages: {\n\t\t\tlegacyCursorHelper:\n\t\t\t\t\"Do not use {{name}} in Playwright spec files. Prefer generated fixtures/POMs or a custom POM for unsupported surfaces.\",\n\t\t\trawPlaywrightApi:\n\t\t\t\t\"Do not call {{name}} directly in Playwright spec files. Prefer generated fixtures/POM methods or a custom POM for unsupported surfaces.\",\n\t\t\trawPlaywrightPageApi:\n\t\t\t\t\"Do not call page.{{name}} directly in Playwright spec files. Prefer generated fixtures/POM methods or a custom POM for unsupported surfaces.\",\n\t\t},\n\t\tschema: [],\n\t},\n\tcreate(context) {\n\t\tif (!isSpecFile(context.filename)) {\n\t\t\treturn {};\n\t\t}\n\n\t\tconst sourceCode = context.sourceCode;\n\n\t\treturn {\n\t\t\tCallExpression(node) {\n\t\t\t\tif (node.callee.type === \"Identifier\" && node.callee.name.includes(\"animateCursor\")) {\n\t\t\t\t\tcontext.report({\n\t\t\t\t\t\tnode: node.callee,\n\t\t\t\t\t\tmessageId: \"legacyCursorHelper\",\n\t\t\t\t\t\tdata: {\n\t\t\t\t\t\t\tname: node.callee.name,\n\t\t\t\t\t\t},\n\t\t\t\t\t});\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tif (node.callee.type !== \"MemberExpression\") {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tconst apiName = resolveMemberPropertyName(node.callee as MemberExpression);\n\t\t\t\tif (apiName === undefined) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tconst objectText = sourceCode.getText(node.callee.object);\n\n\t\t\t\tif (\n\t\t\t\t\t(objectText === \"page\" || objectText === \"playwrightPage\")\n\t\t\t\t\t&& bannedPageApis.has(apiName)\n\t\t\t\t) {\n\t\t\t\t\tcontext.report({\n\t\t\t\t\t\tnode: node.callee.property,\n\t\t\t\t\t\tmessageId: \"rawPlaywrightPageApi\",\n\t\t\t\t\t\tdata: {\n\t\t\t\t\t\t\tname: apiName,\n\t\t\t\t\t\t},\n\t\t\t\t\t});\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tif (!bannedPlaywrightApis.has(apiName)) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tcontext.report({\n\t\t\t\t\tnode: node.callee.property,\n\t\t\t\t\tmessageId: \"rawPlaywrightApi\",\n\t\t\t\t\tdata: {\n\t\t\t\t\t\tname: apiName,\n\t\t\t\t\t},\n\t\t\t\t});\n\t\t\t},\n\t\t};\n\t},\n};\n","import type { Rule } from \"eslint\";\nimport type { AST as VueAST } from \"vue-eslint-parser\";\n\ntype VAttribute = VueAST.VAttribute;\ntype VDirective = VueAST.VDirective;\ntype VElement = VueAST.VElement;\ntype VueAttribute = VAttribute | VDirective;\ntype VueTemplateVisitor = {\n\tVElement: (node: VElement) => void;\n};\n\nfunction isVueTemplateFile(filename: string): boolean {\n\treturn filename.endsWith(\".vue\");\n}\n\nfunction isWhitespaceCharacter(character: string): boolean {\n\treturn character === \" \"\n\t\t|| character === \"\\t\"\n\t\t|| character === \"\\n\"\n\t\t|| character === \"\\r\"\n\t\t|| character === \"\\f\";\n}\n\nfunction removeAttributeWithWhitespace(\n\tattribute: VueAttribute,\n\tcontext: Rule.RuleContext,\n\tfixer: Rule.RuleFixer,\n): Rule.Fix {\n\tconst sourceText = context.sourceCode.getText();\n\tconst [start, end] = attribute.range;\n\n\tlet adjustedStart = start;\n\twhile (adjustedStart > 0 && isWhitespaceCharacter(sourceText[adjustedStart - 1])) {\n\t\tadjustedStart -= 1;\n\t}\n\n\treturn fixer.removeRange([adjustedStart, end]);\n}\n\nfunction isTargetAttribute(attribute: VueAttribute, attributeName: string): boolean {\n\tif (!attribute.directive) {\n\t\treturn attribute.key.type === \"VIdentifier\" && attribute.key.name === attributeName;\n\t}\n\n\tif (attribute.key.type !== \"VDirectiveKey\") {\n\t\treturn false;\n\t}\n\n\tconst directiveName = attribute.key.name;\n\tconst argument = attribute.key.argument;\n\n\treturn directiveName.type === \"VIdentifier\"\n\t\t&& directiveName.name === \"bind\"\n\t\t&& argument?.type === \"VIdentifier\"\n\t\t&& argument.name === attributeName;\n}\n\nfunction findExistingTestIdAttribute(node: VElement, attributeName: string): VueAttribute | undefined {\n\treturn node.startTag.attributes.find(attribute => isTargetAttribute(attribute, attributeName));\n}\n\nfunction defineVueTemplateVisitor(\n\tcontext: Rule.RuleContext,\n\ttemplateVisitor: VueTemplateVisitor,\n): Rule.RuleListener {\n\tconst parserServices = context.sourceCode.parserServices as {\n\t\tdefineTemplateBodyVisitor?: (\n\t\t\ttemplateBodyVisitor: VueTemplateVisitor,\n\t\t\tscriptVisitor: Rule.RuleListener,\n\t\t\toptions: { templateBodyTriggerSelector: \"Program\" },\n\t\t) => Rule.RuleListener;\n\t};\n\n\tif (!parserServices.defineTemplateBodyVisitor) {\n\t\treturn {};\n\t}\n\n\treturn parserServices.defineTemplateBodyVisitor(\n\t\ttemplateVisitor,\n\t\t{},\n\t\t{ templateBodyTriggerSelector: \"Program\" },\n\t);\n}\n\nexport const removeExistingTestIdAttributesRule: Rule.RuleModule = {\n\tmeta: {\n\t\ttype: \"suggestion\",\n\t\tdocs: {\n\t\t\tdescription:\n\t\t\t\t\"Remove existing test-id attributes from Vue templates so vue-pom-generator can generate them consistently.\",\n\t\t},\n\t\tfixable: \"code\",\n\t\tmessages: {\n\t\t\tremoveExistingTestIdAttribute:\n\t\t\t\t\"Remove explicit {{attribute}}. vue-pom-generator can generate it; run this rule with --fix to clean legacy attributes project-wide.\",\n\t\t},\n\t\tschema: [\n\t\t\t{\n\t\t\t\ttype: \"object\",\n\t\t\t\tproperties: {\n\t\t\t\t\tattribute: {\n\t\t\t\t\t\ttype: \"string\",\n\t\t\t\t\t\tdescription: \"Attribute name to remove. Defaults to data-testid.\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tadditionalProperties: false,\n\t\t\t},\n\t\t],\n\t},\n\tcreate(context): Rule.RuleListener {\n\t\tif (!isVueTemplateFile(context.filename)) {\n\t\t\treturn {};\n\t\t}\n\n\t\tconst options = (context.options[0] ?? {}) as { attribute?: string };\n\t\tconst attributeName = (options.attribute ?? \"data-testid\").trim() || \"data-testid\";\n\n\t\treturn defineVueTemplateVisitor(context, {\n\t\t\tVElement(node: VElement) {\n\t\t\t\tconst existingAttribute = findExistingTestIdAttribute(node, attributeName);\n\t\t\t\tif (!existingAttribute) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tcontext.report({\n\t\t\t\t\tnode: existingAttribute,\n\t\t\t\t\tmessageId: \"removeExistingTestIdAttribute\",\n\t\t\t\t\tdata: { attribute: attributeName },\n\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\treturn removeAttributeWithWhitespace(existingAttribute, context, fixer);\n\t\t\t\t\t},\n\t\t\t\t});\n\t\t\t},\n\t\t});\n\t},\n};","import type { Rule } from \"eslint\";\nimport type { CallExpression, Expression, MemberExpression } from \"estree\";\n\nimport { noPageFixtureInSpecsRule } from \"./no-page-fixture-in-specs\";\nimport { noRawPlaywrightApisRule } from \"./no-raw-playwright-apis\";\nimport { removeExistingTestIdAttributesRule } from \"./remove-existing-test-id-attributes\";\n\n/**\n * Playwright locator action methods that should be called via generated POM\n * methods rather than directly on element getters.\n */\nconst LOCATOR_ACTIONS = new Set([\n\t\"click\",\n\t\"dblclick\",\n\t\"fill\",\n\t\"check\",\n\t\"uncheck\",\n\t\"type\",\n\t\"clear\",\n\t\"selectOption\",\n\t\"setInputFiles\",\n\t\"tap\",\n\t\"hover\",\n\t\"focus\",\n\t\"dispatchEvent\",\n\t\"press\",\n\t\"selectText\",\n]);\n\n/**\n * Locator chain methods that are transparent for the purposes of this rule —\n * `.last().click()` is still a raw action on a POM getter.\n */\nconst CHAIN_METHODS = new Set([\"last\", \"first\", \"nth\", \"filter\"]);\n\nfunction startsWithUppercaseLetter(value: string): boolean {\n\tconst first = value.charCodeAt(0);\n\treturn first >= 65 && first <= 90;\n}\n\n/**\n * Returns the PascalCase getter name if `node` is (or chains from) a direct\n * PascalCase member-expression access. Returns null otherwise.\n *\n * Handles:\n * pom.SubmitButton → \"SubmitButton\"\n * pom.SubmitButton.last() → \"SubmitButton\"\n * pom.SubmitButton.nth(0) → \"SubmitButton\"\n */\nfunction getPomGetterName(node: Expression): string | null {\n\tif (node.type === \"MemberExpression\" && !node.computed && node.property.type === \"Identifier\") {\n\t\tconst name = node.property.name;\n\t\tif (startsWithUppercaseLetter(name)) return name;\n\t}\n\n\tif (\n\t\tnode.type === \"CallExpression\"\n\t\t&& node.callee.type === \"MemberExpression\"\n\t\t&& !node.callee.computed\n\t\t&& node.callee.property.type === \"Identifier\"\n\t\t&& CHAIN_METHODS.has(node.callee.property.name)\n\t) {\n\t\treturn getPomGetterName((node.callee as MemberExpression).object as Expression);\n\t}\n\n\treturn null;\n}\n\nexport const noRawLocatorActionRule: Rule.RuleModule = {\n\tmeta: {\n\t\ttype: \"suggestion\",\n\t\tdocs: {\n\t\t\tdescription:\n\t\t\t\t\"Disallow calling raw Playwright action methods directly on POM element getters. Use the generated typed POM methods instead (e.g. `clickSubmitButton()`).\",\n\t\t},\n\t\tmessages: {\n\t\t\tnoRawAction:\n\t\t\t\t\"Use the generated POM method instead of `{{getter}}.{{method}}()`. \"\n\t\t\t\t+ \"Call `click{{getter}}()` / `type{{getter}}(text)` or similar.\",\n\t\t},\n\t\tschema: [],\n\t},\n\tcreate(context) {\n\t\treturn {\n\t\t\tCallExpression(node: CallExpression) {\n\t\t\t\tif (node.callee.type !== \"MemberExpression\") return;\n\t\t\t\tconst callee = node.callee as MemberExpression;\n\t\t\t\tif (callee.computed || callee.property.type !== \"Identifier\") return;\n\n\t\t\t\tconst methodName = callee.property.name;\n\t\t\t\tif (!LOCATOR_ACTIONS.has(methodName)) return;\n\n\t\t\t\tconst getterName = getPomGetterName(callee.object as Expression);\n\t\t\t\tif (!getterName) return;\n\n\t\t\t\tcontext.report({\n\t\t\t\t\tnode,\n\t\t\t\t\tmessageId: \"noRawAction\",\n\t\t\t\t\tdata: { getter: getterName, method: methodName },\n\t\t\t\t});\n\t\t\t},\n\t\t};\n\t},\n};\n\nexport const plugin = {\n\trules: {\n\t\t\"no-page-fixture-in-specs\": noPageFixtureInSpecsRule,\n\t\t\"no-raw-locator-action\": noRawLocatorActionRule,\n\t\t\"no-raw-playwright-apis\": noRawPlaywrightApisRule,\n\t\t\"remove-existing-test-id-attributes\": removeExistingTestIdAttributesRule,\n\t},\n} satisfies { rules: Record<string, Rule.RuleModule> };\n\nexport { noPageFixtureInSpecsRule };\nexport { noRawPlaywrightApisRule };\nexport { removeExistingTestIdAttributesRule };\n"],"names":["SPEC_FILE_SUFFIXES","isSpecFile"],"mappings":";AAIA,MAAM,oBAAoB,oBAAI,IAAI,CAAC,QAAQ,IAAI,CAAC;AAChD,MAAM,yCAAyB,IAAI,CAAC,QAAQ,QAAQ,SAAS,MAAM,CAAC;AACpE,MAAM,sCAAsB,IAAI,CAAC,cAAc,aAAa,aAAa,UAAU,CAAC;AACpF,MAAMA,2CAAyB,IAAI;AAAA,EAClC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC;AAED,SAASC,aAAW,UAA2B;AAC9C,QAAM,WAAW,KAAK,SAAS,QAAQ;AACvC,SAAO,MAAM,KAAKD,oBAAkB,EAAE,KAAK,CAAA,WAAU,SAAS,SAAS,MAAM,CAAC;AAC/E;AAEA,SAAS,qBACR,MACuD;AACvD,SAAO,QAAQ,QACX,OAAO,SAAS,YAChB,UAAU,SACT,KAAK,SAAS,6BAA6B,KAAK,SAAS;AAC/D;AAEA,SAAS,oBAAoB,QAAiD;AAC7E,MAAI,OAAO,SAAS,gBAAgB,kBAAkB,IAAI,OAAO,IAAI;AACpE,WAAO;AAER,MACC,OAAO,SAAS,sBACb,CAAC,OAAO,YACR,OAAO,OAAO,SAAS,gBACvB,kBAAkB,IAAI,OAAO,OAAO,IAAI,KACxC,OAAO,SAAS,SAAS,cAC3B;AACD,QAAI,mBAAmB,IAAI,OAAO,SAAS,IAAI;AAC9C,aAAO;AAER,QAAI,gBAAgB,IAAI,OAAO,SAAS,IAAI;AAC3C,aAAO;AAAA,EACT;AAEA,SAAO;AACR;AAEA,SAAS,uBAAuB,OAA+E;AAC9G,MAAI,CAAC,SAAS,MAAM,SAAS;AAC5B,WAAO;AAER,aAAW,YAAY,MAAM,YAAY;AACxC,QAAI,SAAS,SAAS,cAAc,SAAS;AAC5C;AAED,QAAI,SAAS,IAAI,SAAS,gBAAgB,SAAS,IAAI,SAAS;AAC/D,aAAO;AAAA,EACT;AAEA,SAAO;AACR;AAEO,MAAM,2BAA4C;AAAA,EACxD,MAAM;AAAA,IACL,MAAM;AAAA,IACN,MAAM;AAAA,MACL,aACC;AAAA,IAAA;AAAA,IAEF,UAAU;AAAA,MACT,eACC;AAAA,IAAA;AAAA,IAEF,QAAQ,CAAA;AAAA,EAAC;AAAA,EAEV,OAAO,SAAS;AACf,UAAM,WAAW,QAAQ,YAAA;AACzB,QAAI,CAACC,aAAW,QAAQ;AACvB,aAAO,CAAA;AAER,WAAO;AAAA,MACN,eAAe,MAAsB;AACpC,cAAM,mBAAmB,oBAAoB,KAAK,MAAM;AACxD,YAAI,oBAAoB;AACvB;AAED,cAAM,WAAW,KAAK,UAAU,gBAAgB;AAChD,YAAI,CAAC,qBAAqB,QAAQ;AACjC;AAED,cAAM,sBAAsB,uBAAuB,SAAS,OAAO,CAAC,CAAC;AACrE,YAAI,CAAC;AACJ;AAED,gBAAQ,OAAO;AAAA,UACd,MAAM;AAAA,UACN,WAAW;AAAA,QAAA,CACX;AAAA,MACF;AAAA,IAAA;AAAA,EAEF;AACD;ACzGA,MAAM,2CAA2B,IAAI,CAAC,WAAW,aAAa,aAAa,cAAc,aAAa,CAAC;AAEvG,MAAM,qCAAqB,IAAI;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC;AAED,MAAM,qBAAqB,CAAC,YAAY,aAAa,YAAY,WAAW;AAE5E,SAAS,WAAW,UAA2B;AAC9C,SAAO,mBAAmB,KAAK,CAAC,WAAW,SAAS,SAAS,MAAM,CAAC;AACrE;AASA,SAAS,0BAA0B,QAA8C;AAChF,QAAM,EAAE,UAAU,SAAA,IAAa;AAC/B,MAAI,CAAC,YAAY,SAAS,SAAS,cAAc;AAChD,WAAO,SAAS;AAAA,EACjB;AACA,MAAI,YAAY,SAAS,SAAS,aAAa,OAAO,SAAS,UAAU,UAAU;AAClF,WAAO,SAAS;AAAA,EACjB;AACA,SAAO;AACR;AAEO,MAAM,0BAA2C;AAAA,EACvD,MAAM;AAAA,IACL,MAAM;AAAA,IACN,MAAM;AAAA,MACL,aACC;AAAA,IAAA;AAAA,IAEF,UAAU;AAAA,MACT,oBACC;AAAA,MACD,kBACC;AAAA,MACD,sBACC;AAAA,IAAA;AAAA,IAEF,QAAQ,CAAA;AAAA,EAAC;AAAA,EAEV,OAAO,SAAS;AACf,QAAI,CAAC,WAAW,QAAQ,QAAQ,GAAG;AAClC,aAAO,CAAA;AAAA,IACR;AAEA,UAAM,aAAa,QAAQ;AAE3B,WAAO;AAAA,MACN,eAAe,MAAM;AACpB,YAAI,KAAK,OAAO,SAAS,gBAAgB,KAAK,OAAO,KAAK,SAAS,eAAe,GAAG;AACpF,kBAAQ,OAAO;AAAA,YACd,MAAM,KAAK;AAAA,YACX,WAAW;AAAA,YACX,MAAM;AAAA,cACL,MAAM,KAAK,OAAO;AAAA,YAAA;AAAA,UACnB,CACA;AACD;AAAA,QACD;AAEA,YAAI,KAAK,OAAO,SAAS,oBAAoB;AAC5C;AAAA,QACD;AAEA,cAAM,UAAU,0BAA0B,KAAK,MAA0B;AACzE,YAAI,YAAY,QAAW;AAC1B;AAAA,QACD;AAEA,cAAM,aAAa,WAAW,QAAQ,KAAK,OAAO,MAAM;AAExD,aACE,eAAe,UAAU,eAAe,qBACtC,eAAe,IAAI,OAAO,GAC5B;AACD,kBAAQ,OAAO;AAAA,YACd,MAAM,KAAK,OAAO;AAAA,YAClB,WAAW;AAAA,YACX,MAAM;AAAA,cACL,MAAM;AAAA,YAAA;AAAA,UACP,CACA;AACD;AAAA,QACD;AAEA,YAAI,CAAC,qBAAqB,IAAI,OAAO,GAAG;AACvC;AAAA,QACD;AAEA,gBAAQ,OAAO;AAAA,UACd,MAAM,KAAK,OAAO;AAAA,UAClB,WAAW;AAAA,UACX,MAAM;AAAA,YACL,MAAM;AAAA,UAAA;AAAA,QACP,CACA;AAAA,MACF;AAAA,IAAA;AAAA,EAEF;AACD;AC3GA,SAAS,kBAAkB,UAA2B;AACrD,SAAO,SAAS,SAAS,MAAM;AAChC;AAEA,SAAS,sBAAsB,WAA4B;AAC1D,SAAO,cAAc,OACjB,cAAc,OACd,cAAc,QACd,cAAc,QACd,cAAc;AACnB;AAEA,SAAS,8BACR,WACA,SACA,OACW;AACX,QAAM,aAAa,QAAQ,WAAW,QAAA;AACtC,QAAM,CAAC,OAAO,GAAG,IAAI,UAAU;AAE/B,MAAI,gBAAgB;AACpB,SAAO,gBAAgB,KAAK,sBAAsB,WAAW,gBAAgB,CAAC,CAAC,GAAG;AACjF,qBAAiB;AAAA,EAClB;AAEA,SAAO,MAAM,YAAY,CAAC,eAAe,GAAG,CAAC;AAC9C;AAEA,SAAS,kBAAkB,WAAyB,eAAgC;AACnF,MAAI,CAAC,UAAU,WAAW;AACzB,WAAO,UAAU,IAAI,SAAS,iBAAiB,UAAU,IAAI,SAAS;AAAA,EACvE;AAEA,MAAI,UAAU,IAAI,SAAS,iBAAiB;AAC3C,WAAO;AAAA,EACR;AAEA,QAAM,gBAAgB,UAAU,IAAI;AACpC,QAAM,WAAW,UAAU,IAAI;AAE/B,SAAO,cAAc,SAAS,iBAC1B,cAAc,SAAS,UACvB,UAAU,SAAS,iBACnB,SAAS,SAAS;AACvB;AAEA,SAAS,4BAA4B,MAAgB,eAAiD;AACrG,SAAO,KAAK,SAAS,WAAW,KAAK,eAAa,kBAAkB,WAAW,aAAa,CAAC;AAC9F;AAEA,SAAS,yBACR,SACA,iBACoB;AACpB,QAAM,iBAAiB,QAAQ,WAAW;AAQ1C,MAAI,CAAC,eAAe,2BAA2B;AAC9C,WAAO,CAAA;AAAA,EACR;AAEA,SAAO,eAAe;AAAA,IACrB;AAAA,IACA,CAAA;AAAA,IACA,EAAE,6BAA6B,UAAA;AAAA,EAAU;AAE3C;AAEO,MAAM,qCAAsD;AAAA,EAClE,MAAM;AAAA,IACL,MAAM;AAAA,IACN,MAAM;AAAA,MACL,aACC;AAAA,IAAA;AAAA,IAEF,SAAS;AAAA,IACT,UAAU;AAAA,MACT,+BACC;AAAA,IAAA;AAAA,IAEF,QAAQ;AAAA,MACP;AAAA,QACC,MAAM;AAAA,QACN,YAAY;AAAA,UACX,WAAW;AAAA,YACV,MAAM;AAAA,YACN,aAAa;AAAA,UAAA;AAAA,QACd;AAAA,QAED,sBAAsB;AAAA,MAAA;AAAA,IACvB;AAAA,EACD;AAAA,EAED,OAAO,SAA4B;AAClC,QAAI,CAAC,kBAAkB,QAAQ,QAAQ,GAAG;AACzC,aAAO,CAAA;AAAA,IACR;AAEA,UAAM,UAAW,QAAQ,QAAQ,CAAC,KAAK,CAAA;AACvC,UAAM,iBAAiB,QAAQ,aAAa,eAAe,UAAU;AAErE,WAAO,yBAAyB,SAAS;AAAA,MACxC,SAAS,MAAgB;AACxB,cAAM,oBAAoB,4BAA4B,MAAM,aAAa;AACzE,YAAI,CAAC,mBAAmB;AACvB;AAAA,QACD;AAEA,gBAAQ,OAAO;AAAA,UACd,MAAM;AAAA,UACN,WAAW;AAAA,UACX,MAAM,EAAE,WAAW,cAAA;AAAA,UACnB,IAAI,OAAO;AACV,mBAAO,8BAA8B,mBAAmB,SAAS,KAAK;AAAA,UACvE;AAAA,QAAA,CACA;AAAA,MACF;AAAA,IAAA,CACA;AAAA,EACF;AACD;AC5HA,MAAM,sCAAsB,IAAI;AAAA,EAC/B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,CAAC;AAMD,MAAM,oCAAoB,IAAI,CAAC,QAAQ,SAAS,OAAO,QAAQ,CAAC;AAEhE,SAAS,0BAA0B,OAAwB;AAC1D,QAAM,QAAQ,MAAM,WAAW,CAAC;AAChC,SAAO,SAAS,MAAM,SAAS;AAChC;AAWA,SAAS,iBAAiB,MAAiC;AAC1D,MAAI,KAAK,SAAS,sBAAsB,CAAC,KAAK,YAAY,KAAK,SAAS,SAAS,cAAc;AAC9F,UAAM,OAAO,KAAK,SAAS;AAC3B,QAAI,0BAA0B,IAAI,EAAG,QAAO;AAAA,EAC7C;AAEA,MACC,KAAK,SAAS,oBACX,KAAK,OAAO,SAAS,sBACrB,CAAC,KAAK,OAAO,YACb,KAAK,OAAO,SAAS,SAAS,gBAC9B,cAAc,IAAI,KAAK,OAAO,SAAS,IAAI,GAC7C;AACD,WAAO,iBAAkB,KAAK,OAA4B,MAAoB;AAAA,EAC/E;AAEA,SAAO;AACR;AAEO,MAAM,yBAA0C;AAAA,EACtD,MAAM;AAAA,IACL,MAAM;AAAA,IACN,MAAM;AAAA,MACL,aACC;AAAA,IAAA;AAAA,IAEF,UAAU;AAAA,MACT,aACC;AAAA,IAAA;AAAA,IAGF,QAAQ,CAAA;AAAA,EAAC;AAAA,EAEV,OAAO,SAAS;AACf,WAAO;AAAA,MACN,eAAe,MAAsB;AACpC,YAAI,KAAK,OAAO,SAAS,mBAAoB;AAC7C,cAAM,SAAS,KAAK;AACpB,YAAI,OAAO,YAAY,OAAO,SAAS,SAAS,aAAc;AAE9D,cAAM,aAAa,OAAO,SAAS;AACnC,YAAI,CAAC,gBAAgB,IAAI,UAAU,EAAG;AAEtC,cAAM,aAAa,iBAAiB,OAAO,MAAoB;AAC/D,YAAI,CAAC,WAAY;AAEjB,gBAAQ,OAAO;AAAA,UACd;AAAA,UACA,WAAW;AAAA,UACX,MAAM,EAAE,QAAQ,YAAY,QAAQ,WAAA;AAAA,QAAW,CAC/C;AAAA,MACF;AAAA,IAAA;AAAA,EAEF;AACD;AAEO,MAAM,SAAS;AAAA,EACrB,OAAO;AAAA,IACN,4BAA4B;AAAA,IAC5B,yBAAyB;AAAA,IACzB,0BAA0B;AAAA,IAC1B,sCAAsC;AAAA,EAAA;AAExC;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"no-raw-playwright-apis.d.ts","sourceRoot":"","sources":["../../eslint/no-raw-playwright-apis.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"no-raw-playwright-apis.d.ts","sourceRoot":"","sources":["../../eslint/no-raw-playwright-apis.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AA0CnC,eAAO,MAAM,uBAAuB,EAAE,IAAI,CAAC,UA4E1C,CAAC"}
|
package/dist/index.cjs
CHANGED
|
@@ -4580,6 +4580,9 @@ async function introspectNuxtPages(projectRoot, options = {}) {
|
|
|
4580
4580
|
routePathMap.set(pathTemplate, componentName);
|
|
4581
4581
|
routeMetaEntries.push({
|
|
4582
4582
|
componentName,
|
|
4583
|
+
// Nuxt file-based routes are named by convention, but the static walk does not
|
|
4584
|
+
// recover those names — leave null so callers fall back to path-template navigation.
|
|
4585
|
+
name: null,
|
|
4583
4586
|
pathTemplate,
|
|
4584
4587
|
params,
|
|
4585
4588
|
query: []
|
|
@@ -4673,6 +4676,7 @@ async function parseRouterFileFromCwd(routerEntryPath, options = {}) {
|
|
|
4673
4676
|
if (typeof pathTemplate === "string" && pathTemplate.length) {
|
|
4674
4677
|
routeMetaEntries.push({
|
|
4675
4678
|
componentName,
|
|
4679
|
+
name: typeof r.name === "string" && r.name.length ? r.name : null,
|
|
4676
4680
|
pathTemplate,
|
|
4677
4681
|
params: paramsMeta,
|
|
4678
4682
|
query: queryKeys
|
|
@@ -4819,19 +4823,31 @@ async function getRouteMetaByComponent(projectRoot, routerEntry, routerType, opt
|
|
|
4819
4823
|
const map = /* @__PURE__ */ new Map();
|
|
4820
4824
|
for (const entry of routeMetaEntries) {
|
|
4821
4825
|
const list = map.get(entry.componentName) ?? [];
|
|
4822
|
-
list.push({ template: entry.pathTemplate });
|
|
4826
|
+
list.push({ name: entry.name, template: entry.pathTemplate, params: entry.params });
|
|
4823
4827
|
map.set(entry.componentName, list);
|
|
4824
4828
|
}
|
|
4825
|
-
const
|
|
4829
|
+
const dedupeRoutes = (entries) => {
|
|
4830
|
+
const seen = /* @__PURE__ */ new Set();
|
|
4831
|
+
const unique = [];
|
|
4832
|
+
for (const entry of entries) {
|
|
4833
|
+
if (seen.has(entry.template))
|
|
4834
|
+
continue;
|
|
4835
|
+
seen.add(entry.template);
|
|
4836
|
+
unique.push(entry);
|
|
4837
|
+
}
|
|
4838
|
+
return unique;
|
|
4839
|
+
};
|
|
4840
|
+
const choosePrimaryTemplate = (entries) => {
|
|
4826
4841
|
if (!entries.length)
|
|
4827
4842
|
return null;
|
|
4828
|
-
return entries.slice().sort((a, b) => a.template.length - b.template.length || a.template.localeCompare(b.template))[0];
|
|
4843
|
+
return entries.slice().sort((a, b) => a.template.length - b.template.length || a.template.localeCompare(b.template))[0].template;
|
|
4829
4844
|
};
|
|
4830
4845
|
const sorted = Array.from(map.entries()).sort((a, b) => a[0].localeCompare(b[0]));
|
|
4831
4846
|
return Object.fromEntries(
|
|
4832
|
-
sorted.map(([componentName,
|
|
4833
|
-
const
|
|
4834
|
-
|
|
4847
|
+
sorted.map(([componentName, rawEntries]) => {
|
|
4848
|
+
const routes = dedupeRoutes(rawEntries);
|
|
4849
|
+
const primaryTemplate = choosePrimaryTemplate(routes);
|
|
4850
|
+
return primaryTemplate ? [componentName, { template: primaryTemplate, routes }] : null;
|
|
4835
4851
|
}).filter((entry) => !!entry)
|
|
4836
4852
|
);
|
|
4837
4853
|
}
|
|
@@ -4846,27 +4862,131 @@ function generateRouteProperty(routeMeta) {
|
|
|
4846
4862
|
})
|
|
4847
4863
|
];
|
|
4848
4864
|
}
|
|
4849
|
-
function
|
|
4865
|
+
function buildParamTypeString(params) {
|
|
4866
|
+
return `{ ${params.map((p) => `${p.name}${p.optional ? "?" : ""}: string | number`).join("; ")} }`;
|
|
4867
|
+
}
|
|
4868
|
+
function chooseParamlessRoute(routes) {
|
|
4869
|
+
const paramless = routes.filter((r) => r.params.length === 0);
|
|
4870
|
+
if (!paramless.length)
|
|
4871
|
+
return null;
|
|
4872
|
+
return paramless.slice().sort((a, b) => a.template.length - b.template.length || a.template.localeCompare(b.template))[0];
|
|
4873
|
+
}
|
|
4874
|
+
function chooseParametrizedRoute(routes) {
|
|
4875
|
+
const parametrized = routes.filter((r) => r.params.length > 0);
|
|
4876
|
+
if (!parametrized.length)
|
|
4877
|
+
return null;
|
|
4878
|
+
return parametrized.slice().sort((a, b) => a.params.length - b.params.length || a.template.length - b.template.length || a.template.localeCompare(b.template))[0];
|
|
4879
|
+
}
|
|
4880
|
+
const GOTO_RUNTIME_LINES = [
|
|
4881
|
+
"const runtimeEnv = (globalThis as { process?: { env?: Record<string, string | undefined> } }).process?.env;",
|
|
4882
|
+
"const runtimeBaseUrl = runtimeEnv?.PLAYWRIGHT_RUNTIME_BASE_URL ?? runtimeEnv?.PLAYWRIGHT_TEST_BASE_URL ?? runtimeEnv?.VITE_PLAYWRIGHT_BASE_URL;",
|
|
4883
|
+
"const resolvedUrl = runtimeBaseUrl ? new URL(targetUrl, runtimeBaseUrl).toString() : targetUrl;",
|
|
4884
|
+
"await this.page.goto(resolvedUrl);"
|
|
4885
|
+
];
|
|
4886
|
+
const ROUTER_GLOBAL_NAME = "__appRouter";
|
|
4887
|
+
const pushBlock = (routeNameExpr, paramsExpr, nullable) => {
|
|
4888
|
+
const routerType = `{ ${ROUTER_GLOBAL_NAME}?: { push: (to: { name: string; params: Record<string, unknown> }) => Promise<unknown>; resolve: (to: { name: string; params: Record<string, unknown> }) => { href: string } } }`;
|
|
4889
|
+
const routeParamsLine = paramsExpr === "undefined" ? "const routeParams = {};" : nullable ? `const routeParams = Object.fromEntries(Object.entries(${paramsExpr} ?? {}).filter(([, v]) => v !== undefined));` : `const routeParams = Object.fromEntries(Object.entries(${paramsExpr}).filter(([, v]) => v !== undefined));`;
|
|
4890
|
+
return [
|
|
4891
|
+
routeParamsLine,
|
|
4892
|
+
`const isCold = await this.page.evaluate(() => typeof (globalThis as { ${ROUTER_GLOBAL_NAME}?: unknown }).${ROUTER_GLOBAL_NAME} === "undefined");`,
|
|
4893
|
+
`if (isCold) {`,
|
|
4894
|
+
` await this.page.goto("/", { waitUntil: "commit" });`,
|
|
4895
|
+
` await this.page.waitForFunction(() => typeof (globalThis as { ${ROUTER_GLOBAL_NAME}?: unknown }).${ROUTER_GLOBAL_NAME} !== "undefined", { timeout: 15000 });`,
|
|
4896
|
+
` const href = await this.page.evaluate(({ name, params }) => (globalThis as ${routerType}).${ROUTER_GLOBAL_NAME}?.resolve({ name, params })?.href, { name: ${routeNameExpr}, params: routeParams });`,
|
|
4897
|
+
` if (href) { await this.page.goto(href, { waitUntil: "domcontentloaded" }); }`,
|
|
4898
|
+
`} else {`,
|
|
4899
|
+
` await this.page.evaluate(async ({ name, params }) => {`,
|
|
4900
|
+
` await (globalThis as ${routerType}).${ROUTER_GLOBAL_NAME}?.push({ name, params });`,
|
|
4901
|
+
` }, { name: ${routeNameExpr}, params: routeParams });`,
|
|
4902
|
+
`}`
|
|
4903
|
+
];
|
|
4904
|
+
};
|
|
4905
|
+
function generateGoToMethod(componentName, routeMeta) {
|
|
4906
|
+
if (!routeMeta) {
|
|
4907
|
+
return [
|
|
4908
|
+
createClassMethod({
|
|
4909
|
+
name: "goTo",
|
|
4910
|
+
isAsync: true,
|
|
4911
|
+
statements: [
|
|
4912
|
+
`throw new Error("[pom] No router path found for component/page-object '${componentName}'.");`
|
|
4913
|
+
]
|
|
4914
|
+
})
|
|
4915
|
+
];
|
|
4916
|
+
}
|
|
4917
|
+
const paramless = chooseParamlessRoute(routeMeta.routes);
|
|
4918
|
+
const parametrized = chooseParametrizedRoute(routeMeta.routes);
|
|
4919
|
+
const hasParamless = paramless !== null;
|
|
4920
|
+
const hasParametrized = parametrized !== null;
|
|
4921
|
+
if (!hasParamless && !hasParametrized) {
|
|
4922
|
+
return [
|
|
4923
|
+
createClassMethod({
|
|
4924
|
+
name: "goTo",
|
|
4925
|
+
isAsync: true,
|
|
4926
|
+
statements: [
|
|
4927
|
+
`throw new Error("[pom] No router path found for component/page-object '${componentName}'.");`
|
|
4928
|
+
]
|
|
4929
|
+
})
|
|
4930
|
+
];
|
|
4931
|
+
}
|
|
4932
|
+
const paramStatements = (entry) => {
|
|
4933
|
+
const lines = [];
|
|
4934
|
+
for (const param of entry.params) {
|
|
4935
|
+
const token = getParamToken(param.name);
|
|
4936
|
+
if (param.optional) {
|
|
4937
|
+
lines.push(`targetUrl = params.${param.name} === undefined ? targetUrl.replaceAll(${JSON.stringify(`/${token}`)}, "") : targetUrl.replaceAll(${JSON.stringify(token)}, String(params.${param.name}));`);
|
|
4938
|
+
} else {
|
|
4939
|
+
lines.push(`targetUrl = targetUrl.replaceAll(${JSON.stringify(token)}, String(params.${param.name}));`);
|
|
4940
|
+
}
|
|
4941
|
+
}
|
|
4942
|
+
return lines;
|
|
4943
|
+
};
|
|
4944
|
+
if (hasParamless && !hasParametrized) {
|
|
4945
|
+
const route = paramless;
|
|
4946
|
+
return [
|
|
4947
|
+
createClassMethod({
|
|
4948
|
+
name: "goTo",
|
|
4949
|
+
isAsync: true,
|
|
4950
|
+
statements: route.name !== null ? pushBlock(JSON.stringify(route.name), "undefined", false) : [`const targetUrl = ${JSON.stringify(route.template)};`, ...GOTO_RUNTIME_LINES]
|
|
4951
|
+
})
|
|
4952
|
+
];
|
|
4953
|
+
}
|
|
4954
|
+
const paramType = buildParamTypeString(parametrized.params);
|
|
4955
|
+
if (hasParametrized && !hasParamless) {
|
|
4956
|
+
const route = parametrized;
|
|
4957
|
+
const allOptional = route.params.every((p) => p.optional);
|
|
4958
|
+
return [
|
|
4959
|
+
createClassMethod({
|
|
4960
|
+
name: "goTo",
|
|
4961
|
+
isAsync: true,
|
|
4962
|
+
parameters: [{ name: "params", type: paramType, hasQuestionToken: allOptional }],
|
|
4963
|
+
statements: route.name !== null ? pushBlock(JSON.stringify(route.name), "params", allOptional) : [`let targetUrl = ${JSON.stringify(route.template)};`, ...paramStatements(route), ...GOTO_RUNTIME_LINES]
|
|
4964
|
+
})
|
|
4965
|
+
];
|
|
4966
|
+
}
|
|
4967
|
+
const paramlessRoute = paramless;
|
|
4968
|
+
const parametrizedRoute = parametrized;
|
|
4969
|
+
const usePush = paramlessRoute.name !== null && parametrizedRoute.name !== null;
|
|
4850
4970
|
return [
|
|
4851
4971
|
createClassMethod({
|
|
4852
4972
|
name: "goTo",
|
|
4853
4973
|
isAsync: true,
|
|
4854
|
-
|
|
4855
|
-
"
|
|
4856
|
-
|
|
4857
|
-
|
|
4858
|
-
|
|
4859
|
-
|
|
4860
|
-
|
|
4861
|
-
|
|
4862
|
-
|
|
4863
|
-
|
|
4864
|
-
`
|
|
4974
|
+
overloads: [
|
|
4975
|
+
{ parameters: [], returnType: "Promise<void>" },
|
|
4976
|
+
{ parameters: [{ name: "params", type: paramType }], returnType: "Promise<void>" }
|
|
4977
|
+
],
|
|
4978
|
+
parameters: [{ name: "params", type: paramType, hasQuestionToken: true }],
|
|
4979
|
+
statements: usePush ? pushBlock(
|
|
4980
|
+
`params ? ${JSON.stringify(parametrizedRoute.name)} : ${JSON.stringify(paramlessRoute.name)}`,
|
|
4981
|
+
"params",
|
|
4982
|
+
true
|
|
4983
|
+
) : [
|
|
4984
|
+
`const template = params ? ${JSON.stringify(parametrizedRoute.template)} : ${JSON.stringify(paramlessRoute.template)};`,
|
|
4985
|
+
"let targetUrl = template;",
|
|
4986
|
+
`if (params) {`,
|
|
4987
|
+
...paramStatements(parametrizedRoute).map((line) => ` ${line}`),
|
|
4865
4988
|
"}",
|
|
4866
|
-
|
|
4867
|
-
"const runtimeBaseUrl = runtimeEnv?.PLAYWRIGHT_RUNTIME_BASE_URL ?? runtimeEnv?.PLAYWRIGHT_TEST_BASE_URL ?? runtimeEnv?.VITE_PLAYWRIGHT_BASE_URL;",
|
|
4868
|
-
"const targetUrl = runtimeBaseUrl ? new URL(route.template, runtimeBaseUrl).toString() : route.template;",
|
|
4869
|
-
"await this.page.goto(targetUrl);"
|
|
4989
|
+
...GOTO_RUNTIME_LINES
|
|
4870
4990
|
]
|
|
4871
4991
|
})
|
|
4872
4992
|
];
|
|
@@ -5910,7 +6030,7 @@ function prepareViewObjectModelClass(componentName, dependencies, componentHiera
|
|
|
5910
6030
|
if (isView && options.vueRouterFluentChaining) {
|
|
5911
6031
|
const routeMeta = options.routeMetaByComponent?.[componentName] ?? null;
|
|
5912
6032
|
members.push(...generateRouteProperty(routeMeta));
|
|
5913
|
-
members.push(...
|
|
6033
|
+
members.push(...generateGoToMethod(className, routeMeta));
|
|
5914
6034
|
}
|
|
5915
6035
|
members.push(...generateMethodsContentForDependencies(componentName, dependencies));
|
|
5916
6036
|
return {
|