feat(lint): enforce definePage layout meta on pages-v2
Adds a custom ESLint rule (local-rules/require-v2-layout-meta) that
fails any src/pages-v2/**.vue page missing
definePage({ meta: { layout: 'OrganizerLayoutV2' } }) (or PortalLayoutV2
under pages-v2/portal), preventing a silent wrong-shell fallback to the
default layout (RFC-WS-GUI-REDESIGN AD-G2). Wires eslint-plugin-local-rules
+ a pages-v2 override. The RuleTester spec is called at top level (ESLint
RuleTester self-manages describe/it under Vitest) and vitest.config.ts
gains the eslint-rules test glob so the spec is discovered.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,43 @@
|
||||
import { createRequire } from 'node:module'
|
||||
import { RuleTester } from 'eslint'
|
||||
|
||||
// Project is ESLint 8.57 — RuleTester uses the legacy `parser` +
|
||||
// `parserOptions` shape (NOT ESLint-9 `languageOptions`). createRequire
|
||||
// gives us a CJS `require` inside this ESM test for the .cjs rule + the
|
||||
// parser path.
|
||||
//
|
||||
// RuleTester.run internally calls describe/it itself — do NOT wrap it in
|
||||
// an `it()` block; call it directly inside (or at the top level of) the
|
||||
// describe so Vitest does not see a describe-inside-it violation.
|
||||
const require = createRequire(import.meta.url)
|
||||
const rule = require('../require-v2-layout-meta.cjs')
|
||||
|
||||
const ruleTester = new RuleTester({
|
||||
parser: require.resolve('vue-eslint-parser'),
|
||||
parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
|
||||
})
|
||||
|
||||
ruleTester.run('require-v2-layout-meta', rule, {
|
||||
valid: [
|
||||
{
|
||||
filename: 'src/pages-v2/dashboard.vue',
|
||||
code: '<script setup lang="ts">definePage({ meta: { layout: \'OrganizerLayoutV2\' } })</script><template><div/></template>',
|
||||
},
|
||||
{
|
||||
filename: 'src/pages/dashboard.vue',
|
||||
code: '<script setup lang="ts">const x = 1</script><template><div/></template>',
|
||||
},
|
||||
],
|
||||
invalid: [
|
||||
{
|
||||
filename: 'src/pages-v2/dashboard.vue',
|
||||
code: '<script setup lang="ts">const x = 1</script><template><div/></template>',
|
||||
errors: [{ messageId: 'missing' }],
|
||||
},
|
||||
{
|
||||
filename: 'src/pages-v2/events/index.vue',
|
||||
code: '<script setup lang="ts">definePage({ meta: { layout: \'default\' } })</script><template><div/></template>',
|
||||
errors: [{ messageId: 'wrongLayout' }],
|
||||
},
|
||||
],
|
||||
})
|
||||
59
apps/app/eslint-rules/require-v2-layout-meta.cjs
Normal file
59
apps/app/eslint-rules/require-v2-layout-meta.cjs
Normal file
@@ -0,0 +1,59 @@
|
||||
/**
|
||||
* Enforces that every src/pages-v2/**.vue page declares
|
||||
* definePage({ meta: { layout: 'OrganizerLayoutV2' } })
|
||||
* (or 'PortalLayoutV2' for src/pages-v2/portal/**). Without this a v2
|
||||
* page silently falls back to the `default` layout — a no-error
|
||||
* wrong-shell bug. RFC-WS-GUI-REDESIGN AD-G2.
|
||||
*/
|
||||
'use strict'
|
||||
|
||||
module.exports = {
|
||||
meta: {
|
||||
type: 'problem',
|
||||
docs: { description: 'require definePage layout meta on pages-v2' },
|
||||
messages: {
|
||||
missing: 'pages-v2 page must call definePage({ meta: { layout: ... } }).',
|
||||
wrongLayout: 'pages-v2 layout must be {{expected}} (got {{actual}}).',
|
||||
},
|
||||
schema: [],
|
||||
},
|
||||
create(context) {
|
||||
const filename = (context.filename || context.getFilename() || '').replace(/\\/g, '/')
|
||||
if (!filename.includes('src/pages-v2/'))
|
||||
return {}
|
||||
|
||||
const expected = filename.includes('src/pages-v2/portal/')
|
||||
? 'PortalLayoutV2'
|
||||
: 'OrganizerLayoutV2'
|
||||
|
||||
let sawDefinePage = false
|
||||
|
||||
return {
|
||||
CallExpression(node) {
|
||||
if (node.callee.type !== 'Identifier' || node.callee.name !== 'definePage')
|
||||
return
|
||||
sawDefinePage = true
|
||||
|
||||
const arg = node.arguments[0]
|
||||
const metaProp = arg && arg.type === 'ObjectExpression'
|
||||
? arg.properties.find(p => p.key && p.key.name === 'meta')
|
||||
: null
|
||||
const layoutProp = metaProp && metaProp.value.type === 'ObjectExpression'
|
||||
? metaProp.value.properties.find(p => p.key && p.key.name === 'layout')
|
||||
: null
|
||||
|
||||
if (!layoutProp || layoutProp.value.value !== expected) {
|
||||
context.report({
|
||||
node,
|
||||
messageId: 'wrongLayout',
|
||||
data: { expected, actual: layoutProp ? String(layoutProp.value.value) : 'none' },
|
||||
})
|
||||
}
|
||||
},
|
||||
'Program:exit': function (node) {
|
||||
if (!sawDefinePage)
|
||||
context.report({ node, messageId: 'missing' })
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
Reference in New Issue
Block a user