@lark-apaas/fullstack-presets 1.1.5-beta.16 → 1.1.5-beta.18
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/custom-stylelint-rules/hsl-variable.d.ts +28 -0
- package/lib/custom-stylelint-rules/hsl-variable.js +110 -0
- package/lib/recommend/stylelint/index.d.ts +2 -0
- package/lib/recommend/stylelint/index.js +37 -0
- package/lib/simple/recommend/stylelint/index.d.ts +2 -0
- package/lib/simple/recommend/stylelint/index.js +37 -0
- package/package.json +6 -2
- 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
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 自定义 Stylelint 规则:校验 CSS 声明中非法的 hsl() 写法
|
|
3
|
+
*
|
|
4
|
+
* 遍历所有 CSS 声明(包括自定义属性 --*),当值中包含 hsl() 时,
|
|
5
|
+
* 使用 css-tree 的词法器验证其是否符合 CSS color 规范。
|
|
6
|
+
*
|
|
7
|
+
* 非法示例:
|
|
8
|
+
* --color: hsl(100%, 50%, 26%); // hue 不能是百分比
|
|
9
|
+
* --color: hsl(200 50% 26% 0.5); // alpha 缺少斜杠
|
|
10
|
+
* --color: hsl(200 50%); // 缺少 lightness
|
|
11
|
+
* color: hsl(); // 空参数
|
|
12
|
+
*
|
|
13
|
+
* 合法示例:
|
|
14
|
+
* --color: hsl(200, 50%, 26%); // CSS3 逗号写法
|
|
15
|
+
* --color: hsl(200 50% 26%); // CSS4 空格写法
|
|
16
|
+
* --color: hsl(200deg 50% 26%); // 带单位的 hue
|
|
17
|
+
* --color: hsl(200 50% 26% / 0.5); // CSS4 带 alpha
|
|
18
|
+
*/
|
|
19
|
+
import stylelint from 'stylelint';
|
|
20
|
+
export declare const ruleName = "custom/hsl-valid-value";
|
|
21
|
+
export declare const messages: {
|
|
22
|
+
invalidHsl: (value: string) => string;
|
|
23
|
+
};
|
|
24
|
+
export declare const meta: {
|
|
25
|
+
url: string;
|
|
26
|
+
};
|
|
27
|
+
declare const _default: stylelint.Plugin;
|
|
28
|
+
export default _default;
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
35
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
36
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
37
|
+
};
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.meta = exports.messages = exports.ruleName = void 0;
|
|
40
|
+
/**
|
|
41
|
+
* 自定义 Stylelint 规则:校验 CSS 声明中非法的 hsl() 写法
|
|
42
|
+
*
|
|
43
|
+
* 遍历所有 CSS 声明(包括自定义属性 --*),当值中包含 hsl() 时,
|
|
44
|
+
* 使用 css-tree 的词法器验证其是否符合 CSS color 规范。
|
|
45
|
+
*
|
|
46
|
+
* 非法示例:
|
|
47
|
+
* --color: hsl(100%, 50%, 26%); // hue 不能是百分比
|
|
48
|
+
* --color: hsl(200 50% 26% 0.5); // alpha 缺少斜杠
|
|
49
|
+
* --color: hsl(200 50%); // 缺少 lightness
|
|
50
|
+
* color: hsl(); // 空参数
|
|
51
|
+
*
|
|
52
|
+
* 合法示例:
|
|
53
|
+
* --color: hsl(200, 50%, 26%); // CSS3 逗号写法
|
|
54
|
+
* --color: hsl(200 50% 26%); // CSS4 空格写法
|
|
55
|
+
* --color: hsl(200deg 50% 26%); // 带单位的 hue
|
|
56
|
+
* --color: hsl(200 50% 26% / 0.5); // CSS4 带 alpha
|
|
57
|
+
*/
|
|
58
|
+
const stylelint_1 = __importDefault(require("stylelint"));
|
|
59
|
+
const csstree = __importStar(require("css-tree"));
|
|
60
|
+
exports.ruleName = 'custom/hsl-valid-value';
|
|
61
|
+
const { report, ruleMessages, validateOptions } = stylelint_1.default.utils;
|
|
62
|
+
exports.messages = ruleMessages(exports.ruleName, {
|
|
63
|
+
invalidHsl: (value) => `Invalid hsl() value: "${value}". Refer to https://developer.mozilla.org/docs/Web/CSS/color_value/hsl`,
|
|
64
|
+
});
|
|
65
|
+
exports.meta = {
|
|
66
|
+
url: 'https://github.com/csstree/stylelint-validator',
|
|
67
|
+
};
|
|
68
|
+
const rule = primary => {
|
|
69
|
+
return (root, result) => {
|
|
70
|
+
const validOptions = validateOptions(result, exports.ruleName, {
|
|
71
|
+
actual: primary,
|
|
72
|
+
possible: [true],
|
|
73
|
+
});
|
|
74
|
+
if (!validOptions || !primary)
|
|
75
|
+
return;
|
|
76
|
+
root.walkDecls(decl => {
|
|
77
|
+
const value = decl.value;
|
|
78
|
+
// 只处理包含 hsl( 的声明值
|
|
79
|
+
if (!/hsl\(/i.test(value))
|
|
80
|
+
return;
|
|
81
|
+
try {
|
|
82
|
+
const ast = csstree.parse(value, { context: 'value' });
|
|
83
|
+
const matchResult = csstree.lexer.matchType('color', ast);
|
|
84
|
+
if (matchResult.error) {
|
|
85
|
+
report({
|
|
86
|
+
message: exports.messages.invalidHsl(value),
|
|
87
|
+
node: decl,
|
|
88
|
+
result,
|
|
89
|
+
ruleName: exports.ruleName,
|
|
90
|
+
word: value,
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
catch {
|
|
95
|
+
// css-tree parse 失败也视为非法值
|
|
96
|
+
report({
|
|
97
|
+
message: exports.messages.invalidHsl(value),
|
|
98
|
+
node: decl,
|
|
99
|
+
result,
|
|
100
|
+
ruleName: exports.ruleName,
|
|
101
|
+
word: value,
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
});
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
rule.ruleName = exports.ruleName;
|
|
108
|
+
rule.messages = exports.messages;
|
|
109
|
+
rule.meta = exports.meta;
|
|
110
|
+
exports.default = stylelint_1.default.createPlugin(exports.ruleName, rule);
|
|
@@ -1,8 +1,45 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
2
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
36
|
exports.stylelintPresets = void 0;
|
|
37
|
+
const hsl_variable_1 = __importStar(require("../../custom-stylelint-rules/hsl-variable"));
|
|
38
|
+
const isLooseMode = process.env.FORCE_FRAMEWORK_LINT_LOOSE_MODE === 'true';
|
|
4
39
|
exports.stylelintPresets = {
|
|
40
|
+
plugins: [hsl_variable_1.default],
|
|
5
41
|
rules: {
|
|
6
42
|
'declaration-block-no-duplicate-custom-properties': true,
|
|
43
|
+
[hsl_variable_1.ruleName]: isLooseMode,
|
|
7
44
|
},
|
|
8
45
|
};
|
|
@@ -1,8 +1,45 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
2
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
36
|
exports.stylelintPresets = void 0;
|
|
37
|
+
const hsl_variable_1 = __importStar(require("../../../custom-stylelint-rules/hsl-variable"));
|
|
38
|
+
const isLooseMode = process.env.FORCE_FRAMEWORK_LINT_LOOSE_MODE === 'true';
|
|
4
39
|
exports.stylelintPresets = {
|
|
40
|
+
plugins: [hsl_variable_1.default],
|
|
5
41
|
rules: {
|
|
6
42
|
'declaration-block-no-duplicate-custom-properties': true,
|
|
43
|
+
[hsl_variable_1.ruleName]: isLooseMode,
|
|
7
44
|
},
|
|
8
45
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lark-apaas/fullstack-presets",
|
|
3
|
-
"version": "1.1.5-beta.
|
|
3
|
+
"version": "1.1.5-beta.18",
|
|
4
4
|
"files": [
|
|
5
5
|
"lib"
|
|
6
6
|
],
|
|
@@ -26,21 +26,25 @@
|
|
|
26
26
|
"@eslint/js": "^9.35.0",
|
|
27
27
|
"@types/node": "^22.19.1",
|
|
28
28
|
"@types/styled-jsx": "^2.2.9",
|
|
29
|
+
"css-tree": "^3.1.0",
|
|
29
30
|
"eslint-import-resolver-alias": "^1.1.2",
|
|
30
31
|
"eslint-plugin-import": "^2.32.0",
|
|
31
32
|
"eslint-plugin-react": "^7.37.5",
|
|
32
33
|
"eslint-plugin-react-hooks": "^5.2.0",
|
|
33
34
|
"globals": "^16.4.0",
|
|
35
|
+
"stylelint": "^17.3.0",
|
|
34
36
|
"tailwindcss-animate": "^1.0.7"
|
|
35
37
|
},
|
|
36
38
|
"devDependencies": {
|
|
37
39
|
"@babel/core": "^7.24.0",
|
|
38
40
|
"@babel/preset-react": "^7.24.0",
|
|
41
|
+
"@types/css-tree": "^2.3.11",
|
|
39
42
|
"@types/eslint": "^9.6.0",
|
|
40
43
|
"eslint": "^9.35.0",
|
|
41
44
|
"styled-jsx": "^5.1.6",
|
|
42
45
|
"typescript": "^5.9.2",
|
|
43
|
-
"typescript-eslint": "^8.44.0"
|
|
46
|
+
"typescript-eslint": "^8.44.0",
|
|
47
|
+
"vitest": "^2.0.0"
|
|
44
48
|
},
|
|
45
49
|
"peerDependencies": {
|
|
46
50
|
"eslint": "^9.0.0",
|
|
@@ -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;
|