@lark-apaas/fullstack-presets 1.1.7 → 1.1.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/lib/recommend/eslint/eslint-client.js +26 -23
- package/package.json +1 -1
- package/lib/custom-eslint-rules/no-welcome-index-route.d.ts +0 -12
- package/lib/custom-eslint-rules/no-welcome-index-route.js +0 -123
- package/lib/custom-eslint-rules/require-index-route.d.ts +0 -14
- package/lib/custom-eslint-rules/require-index-route.js +0 -98
|
@@ -56,6 +56,8 @@ exports.default = {
|
|
|
56
56
|
'no-undef': 'off', // 禁止使用未声明的变量
|
|
57
57
|
'no-console': 'off', // 允许使用 console
|
|
58
58
|
'prefer-const': 'off', // 不强制使用 const
|
|
59
|
+
'no-case-declarations': 'off', // 允许在 case 块中使用词法声明
|
|
60
|
+
'no-empty': 'off', // 允许空的 catch 块
|
|
59
61
|
// Import 规则
|
|
60
62
|
'import/no-unresolved': 'error', // 检查导入路径是否存在
|
|
61
63
|
// 其他规则
|
|
@@ -112,35 +114,36 @@ exports.default = {
|
|
|
112
114
|
selector: 'AssignmentExpression[left.object.name="location"][left.property.name="href"]',
|
|
113
115
|
message: "Please don't use `location.href` to navigate. Use `useNavigate` hook from 'react-router-dom' instead.",
|
|
114
116
|
},
|
|
115
|
-
// SelectItem组件的value属性值不能为空字符串
|
|
116
|
-
{
|
|
117
|
-
message: 'The `value` attribute of the `SelectItem` component cannot be an empty string.',
|
|
118
|
-
selector: 'JSXOpeningElement[name.name="SelectItem"]:has(JSXAttribute[name.name="value"][value.value=""]), JSXOpeningElement[name.name="SelectItem"]:has(JSXAttribute[name.name="value"][value.expression.value=""])',
|
|
119
|
-
},
|
|
120
117
|
// 禁止a标签href使用相对路径
|
|
121
118
|
{
|
|
122
119
|
selector: "JSXOpeningElement[name.name='a']:has(JSXAttribute[name.name='href'][value.value=/^(?!https?:|\\u002F\\u002F|mailto:|tel:|#).+/])",
|
|
123
120
|
message: "Please don't use relative paths in <a> tags. Use NavLink from 'react-router-dom' instead.",
|
|
124
121
|
},
|
|
125
122
|
// 禁止 variant 为 outline|link|ghost 的 Button 使用 text-white
|
|
126
|
-
{
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
//
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
//
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
123
|
+
// {
|
|
124
|
+
// selector:
|
|
125
|
+
// 'JSXElement[openingElement.name.name="Button"]' +
|
|
126
|
+
// ':has(JSXAttribute[name.name="variant"][value.value=/^(outline|link|ghost)$/])' +
|
|
127
|
+
// ':has(JSXAttribute[name.name="className"][value.value=/text-white/])',
|
|
128
|
+
// message:
|
|
129
|
+
// 'Button with variant="outline|link|ghost" should not use "text-white" className. This causes visibility issues. Consider using proper semantic color tokens from `client/src/tailwind-theme.css`',
|
|
130
|
+
// },
|
|
131
|
+
// // 禁止在 Button 上组合 text-primary-foreground 与 bg-background 并用的情况
|
|
132
|
+
// {
|
|
133
|
+
// selector:
|
|
134
|
+
// 'JSXElement[openingElement.name.name="Button"]' +
|
|
135
|
+
// ':has(JSXAttribute[name.name="className"][value.value=/text-primary-foreground/])' +
|
|
136
|
+
// ':has(JSXAttribute[name.name="className"][value.value=/bg-background/])',
|
|
137
|
+
// message:
|
|
138
|
+
// 'Button should not use "text-primary-foreground" and "bg-background" className. This causes visibility issues. Consider using proper semantic color tokens from `client/src/tailwind-theme.css`',
|
|
139
|
+
// },
|
|
140
|
+
// // 禁止使用 text-accent
|
|
141
|
+
// {
|
|
142
|
+
// selector:
|
|
143
|
+
// 'JSXAttribute[name.name="className"][value.value=/(^|\\s)text-accent(\\s|$)/]',
|
|
144
|
+
// message:
|
|
145
|
+
// 'Classname "text-accent" would cause visibility issues. Consider using proper semantic color tokens from `client/src/tailwind-theme.css`',
|
|
146
|
+
// },
|
|
144
147
|
// 禁止在 Tailwind 任意值语法中使用包含空格的 hsl/rgb 值
|
|
145
148
|
{
|
|
146
149
|
selector: 'JSXAttribute[name.name="className"][value.value=/\\[hsl\\([^\\]]*\\s[^\\]]*\\)/]',
|
package/package.json
CHANGED
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* ESLint rule to disallow Welcome or PagePlaceholder components as the default home page route.
|
|
3
|
-
*
|
|
4
|
-
* This rule enforces that the first-level index route (the actual home page at "/")
|
|
5
|
-
* should use an actual page component rather than placeholder components from the framework.
|
|
6
|
-
*
|
|
7
|
-
* Only checks the first-level index route nested directly under a parent Route (typically Layout).
|
|
8
|
-
* Only flags Welcome/PagePlaceholder if they are imported from @lark-apaas/client-toolkit.
|
|
9
|
-
*/
|
|
10
|
-
import type { Rule } from 'eslint';
|
|
11
|
-
declare const rule: Rule.RuleModule;
|
|
12
|
-
export default rule;
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const rule = {
|
|
4
|
-
meta: {
|
|
5
|
-
type: 'problem',
|
|
6
|
-
docs: {
|
|
7
|
-
description: 'Disallow Welcome or PagePlaceholder from @lark-apaas/client-toolkit as the default home page route element',
|
|
8
|
-
category: 'Best Practices',
|
|
9
|
-
recommended: true,
|
|
10
|
-
},
|
|
11
|
-
messages: {
|
|
12
|
-
noWelcomeIndex: 'Index route should not use {{componentName}} from @lark-apaas/client-toolkit as the element. Please create and use your own home page component (e.g., HomePage, Dashboard).',
|
|
13
|
-
},
|
|
14
|
-
schema: [],
|
|
15
|
-
},
|
|
16
|
-
create(context) {
|
|
17
|
-
// Track imports from @lark-apaas/client-toolkit
|
|
18
|
-
const toolkitImports = new Set();
|
|
19
|
-
return {
|
|
20
|
-
ImportDeclaration(node) {
|
|
21
|
-
const importNode = node;
|
|
22
|
-
const source = importNode.source?.value;
|
|
23
|
-
// Check if importing from @lark-apaas/client-toolkit (any subpath)
|
|
24
|
-
if (typeof source === 'string' &&
|
|
25
|
-
source.startsWith('@lark-apaas/client-toolkit')) {
|
|
26
|
-
// Collect all imported names
|
|
27
|
-
importNode.specifiers?.forEach(specifier => {
|
|
28
|
-
if (specifier.type === 'ImportSpecifier' &&
|
|
29
|
-
specifier.imported?.name) {
|
|
30
|
-
toolkitImports.add(specifier.imported.name);
|
|
31
|
-
}
|
|
32
|
-
});
|
|
33
|
-
}
|
|
34
|
-
},
|
|
35
|
-
JSXElement(node) {
|
|
36
|
-
const element = node;
|
|
37
|
-
const openingElement = element.openingElement;
|
|
38
|
-
if (!openingElement)
|
|
39
|
-
return;
|
|
40
|
-
const elementName = openingElement.name;
|
|
41
|
-
// Check if this is a <Route> element
|
|
42
|
-
if (elementName.type !== 'JSXIdentifier' ||
|
|
43
|
-
elementName.name !== 'Route') {
|
|
44
|
-
return;
|
|
45
|
-
}
|
|
46
|
-
// Check if it has an index prop that is truthy
|
|
47
|
-
const indexAttr = openingElement.attributes.find(attr => attr.type === 'JSXAttribute' &&
|
|
48
|
-
attr.name?.type === 'JSXIdentifier' &&
|
|
49
|
-
attr.name?.name === 'index');
|
|
50
|
-
// If no index attribute, skip this route
|
|
51
|
-
if (!indexAttr) {
|
|
52
|
-
return;
|
|
53
|
-
}
|
|
54
|
-
// Check if index={false} explicitly
|
|
55
|
-
const indexValue = indexAttr.value;
|
|
56
|
-
if (indexValue?.type === 'JSXExpressionContainer' &&
|
|
57
|
-
indexValue.expression?.type === 'Literal' &&
|
|
58
|
-
indexValue.expression.value === false) {
|
|
59
|
-
return;
|
|
60
|
-
}
|
|
61
|
-
// Check if this is a first-level index route (nested under exactly one parent Route)
|
|
62
|
-
// The structure should be: <Routes> -> <Route element={<Layout />}> -> <Route index>
|
|
63
|
-
let routeParentCount = 0;
|
|
64
|
-
let current = element.parent;
|
|
65
|
-
while (current) {
|
|
66
|
-
if (current.type === 'JSXElement') {
|
|
67
|
-
const currentElement = current;
|
|
68
|
-
const currentOpeningElement = currentElement.openingElement;
|
|
69
|
-
const currentElementName = currentOpeningElement?.name;
|
|
70
|
-
if (currentElementName?.type === 'JSXIdentifier' &&
|
|
71
|
-
currentElementName.name === 'Route') {
|
|
72
|
-
routeParentCount++;
|
|
73
|
-
}
|
|
74
|
-
else if (currentElementName?.type === 'JSXIdentifier' &&
|
|
75
|
-
currentElementName.name === 'Routes') {
|
|
76
|
-
// Stop when we reach Routes
|
|
77
|
-
break;
|
|
78
|
-
}
|
|
79
|
-
}
|
|
80
|
-
current = current.parent;
|
|
81
|
-
}
|
|
82
|
-
// Only check if this is a first-level route (exactly 1 parent Route)
|
|
83
|
-
// This corresponds to the default home page pattern:
|
|
84
|
-
// <Routes><Route element={<Layout />}><Route index /></Route></Routes>
|
|
85
|
-
if (routeParentCount !== 1) {
|
|
86
|
-
return;
|
|
87
|
-
}
|
|
88
|
-
// Find the element prop
|
|
89
|
-
const elementProp = openingElement.attributes.find(attr => attr.type === 'JSXAttribute' &&
|
|
90
|
-
attr.name?.type === 'JSXIdentifier' &&
|
|
91
|
-
attr.name?.name === 'element');
|
|
92
|
-
if (!elementProp) {
|
|
93
|
-
return;
|
|
94
|
-
}
|
|
95
|
-
// Check if the element prop value is a JSXExpressionContainer with a JSXElement
|
|
96
|
-
const propValue = elementProp.value;
|
|
97
|
-
if (propValue?.type === 'JSXExpressionContainer' &&
|
|
98
|
-
propValue.expression?.type === 'JSXElement') {
|
|
99
|
-
const jsxElement = propValue.expression;
|
|
100
|
-
const jsxOpeningElement = jsxElement.openingElement;
|
|
101
|
-
const jsxElementName = jsxOpeningElement?.name;
|
|
102
|
-
// Check if the component name is Welcome or PagePlaceholder
|
|
103
|
-
if (jsxElementName?.type === 'JSXIdentifier' &&
|
|
104
|
-
(jsxElementName.name === 'Welcome' ||
|
|
105
|
-
jsxElementName.name === 'PagePlaceholder')) {
|
|
106
|
-
const componentName = jsxElementName.name;
|
|
107
|
-
// Only report if this component was imported from @lark-apaas/client-toolkit
|
|
108
|
-
if (toolkitImports.has(componentName)) {
|
|
109
|
-
context.report({
|
|
110
|
-
node: elementProp,
|
|
111
|
-
messageId: 'noWelcomeIndex',
|
|
112
|
-
data: {
|
|
113
|
-
componentName,
|
|
114
|
-
},
|
|
115
|
-
});
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
},
|
|
120
|
-
};
|
|
121
|
-
},
|
|
122
|
-
};
|
|
123
|
-
exports.default = rule;
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* ESLint rule to require a default index route in RoutesComponent.
|
|
3
|
-
*
|
|
4
|
-
* This rule enforces that the RoutesComponent must have a first-level index route
|
|
5
|
-
* to handle the default "/" path. This ensures users don't see a 404 when visiting
|
|
6
|
-
* the application root.
|
|
7
|
-
*
|
|
8
|
-
* Valid configurations:
|
|
9
|
-
* 1. <Route index element={...} /> (first-level, nested under one parent Route)
|
|
10
|
-
* 2. <Route path="/" element={...} /> (first-level or top-level)
|
|
11
|
-
*/
|
|
12
|
-
import type { Rule } from 'eslint';
|
|
13
|
-
declare const rule: Rule.RuleModule;
|
|
14
|
-
export default rule;
|
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const rule = {
|
|
4
|
-
meta: {
|
|
5
|
-
type: 'problem',
|
|
6
|
-
docs: {
|
|
7
|
-
description: 'Require a default index route in RoutesComponent to handle the root path',
|
|
8
|
-
category: 'Best Practices',
|
|
9
|
-
recommended: true,
|
|
10
|
-
},
|
|
11
|
-
messages: {
|
|
12
|
-
missingIndexRoute: 'RoutesComponent is missing a default home page route. Add either:\n - <Route index element={<HomePage />} /> (nested under Layout)\n - <Route path="/" element={<HomePage />} /> (at any level)',
|
|
13
|
-
},
|
|
14
|
-
schema: [],
|
|
15
|
-
},
|
|
16
|
-
create(context) {
|
|
17
|
-
let inRoutesComponent = false;
|
|
18
|
-
let hasDefaultRoute = false;
|
|
19
|
-
let routeDepth = 0;
|
|
20
|
-
return {
|
|
21
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
22
|
-
VariableDeclarator(node) {
|
|
23
|
-
// Check if this is RoutesComponent
|
|
24
|
-
if (node.id?.name === 'RoutesComponent') {
|
|
25
|
-
inRoutesComponent = true;
|
|
26
|
-
hasDefaultRoute = false;
|
|
27
|
-
routeDepth = 0;
|
|
28
|
-
}
|
|
29
|
-
},
|
|
30
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
31
|
-
'VariableDeclarator:exit'(node) {
|
|
32
|
-
if (node.id?.name === 'RoutesComponent') {
|
|
33
|
-
if (!hasDefaultRoute) {
|
|
34
|
-
context.report({
|
|
35
|
-
node,
|
|
36
|
-
messageId: 'missingIndexRoute',
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
inRoutesComponent = false;
|
|
40
|
-
}
|
|
41
|
-
},
|
|
42
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
43
|
-
JSXElement(node) {
|
|
44
|
-
if (!inRoutesComponent)
|
|
45
|
-
return;
|
|
46
|
-
const elementName = node.openingElement?.name?.name;
|
|
47
|
-
// Track Route depth
|
|
48
|
-
if (elementName === 'Route') {
|
|
49
|
-
routeDepth++;
|
|
50
|
-
// Only check first-level routes (depth 1 or 2)
|
|
51
|
-
// depth 1: <Routes><Route index /></Routes>
|
|
52
|
-
// depth 2: <Routes><Route><Route index /></Route></Routes>
|
|
53
|
-
if (routeDepth <= 2) {
|
|
54
|
-
const attributes = node.openingElement?.attributes || [];
|
|
55
|
-
// Check for index attribute
|
|
56
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
57
|
-
const indexAttr = attributes.find((attr) => attr.type === 'JSXAttribute' && attr.name?.name === 'index');
|
|
58
|
-
if (indexAttr) {
|
|
59
|
-
// Make sure it's not index={false}
|
|
60
|
-
const isIndexFalse = indexAttr.value?.type === 'JSXExpressionContainer' &&
|
|
61
|
-
indexAttr.value.expression?.type === 'Literal' &&
|
|
62
|
-
indexAttr.value.expression.value === false;
|
|
63
|
-
if (!isIndexFalse) {
|
|
64
|
-
hasDefaultRoute = true;
|
|
65
|
-
}
|
|
66
|
-
}
|
|
67
|
-
// Check for path="/"
|
|
68
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
69
|
-
const pathAttr = attributes.find((attr) => attr.type === 'JSXAttribute' && attr.name?.name === 'path');
|
|
70
|
-
if (pathAttr) {
|
|
71
|
-
const value = pathAttr.value;
|
|
72
|
-
// Handle path="/"
|
|
73
|
-
if (value?.type === 'Literal' && value.value === '/') {
|
|
74
|
-
hasDefaultRoute = true;
|
|
75
|
-
}
|
|
76
|
-
// Handle path={"/"}
|
|
77
|
-
if (value?.type === 'JSXExpressionContainer' &&
|
|
78
|
-
value.expression?.type === 'Literal' &&
|
|
79
|
-
value.expression.value === '/') {
|
|
80
|
-
hasDefaultRoute = true;
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
}
|
|
84
|
-
}
|
|
85
|
-
},
|
|
86
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
87
|
-
'JSXElement:exit'(node) {
|
|
88
|
-
if (!inRoutesComponent)
|
|
89
|
-
return;
|
|
90
|
-
const elementName = node.openingElement?.name?.name;
|
|
91
|
-
if (elementName === 'Route') {
|
|
92
|
-
routeDepth--;
|
|
93
|
-
}
|
|
94
|
-
},
|
|
95
|
-
};
|
|
96
|
-
},
|
|
97
|
-
};
|
|
98
|
-
exports.default = rule;
|