重构:提交全新项目代码
This commit is contained in:
1
templates/vite-react-template/.npmrc
Normal file
1
templates/vite-react-template/.npmrc
Normal file
@@ -0,0 +1 @@
|
||||
registry = https://registry.npmmirror.com/
|
||||
8
templates/vite-react-template/.vscode/settings.json
vendored
Normal file
8
templates/vite-react-template/.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"json.schemas": [
|
||||
{
|
||||
"fileMatch": ["/tsconfig.build.json", "/tsconfig.base.json"],
|
||||
"schema": {}
|
||||
}
|
||||
]
|
||||
}
|
||||
34
templates/vite-react-template/package.json
Normal file
34
templates/vite-react-template/package.json
Normal file
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"name": "vite-react-template",
|
||||
"version": "0.0.0",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"sideEffects": ["*.css"],
|
||||
"module": "./dist/index.es.js",
|
||||
"main": "./dist/index.cjs.js",
|
||||
"types": "./dist/index.d.ts",
|
||||
"style": "./dist/index.css",
|
||||
"exports": {
|
||||
".": {
|
||||
"import": "./dist/index.es.js",
|
||||
"require": "./dist/index.cjs.js",
|
||||
"types": "./dist/index.d.ts"
|
||||
},
|
||||
"./index.css": "./dist/index.css"
|
||||
},
|
||||
"files": ["dist"],
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
"build": "vite build --tsconfig tsconfig.build.json"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^25.6.0",
|
||||
"@types/react": "^19.2.14",
|
||||
"@types/react-dom": "^19.2.3",
|
||||
"@vitejs/plugin-react": "^6.0.1",
|
||||
"glob": "^13.0.6",
|
||||
"typescript": "^6.0.3",
|
||||
"vite": "^8.0.9",
|
||||
"vite-plugin-dts": "^4.5.4"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,137 @@
|
||||
// plugins/vite-plugin-gen-index-css.ts
|
||||
import type { Plugin } from "vite";
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
import { globSync } from "glob";
|
||||
|
||||
interface Config {
|
||||
targetDirs: string[];
|
||||
includeExtensions: string[];
|
||||
importSyntax: "@import";
|
||||
importSyntaxTail?: string;
|
||||
excludeFilePattern: RegExp[];
|
||||
excludeDirs: string[];
|
||||
warnDuplicateTailwindImport: boolean;
|
||||
indexFileName: string;
|
||||
}
|
||||
|
||||
const CONFIG: Config = {
|
||||
targetDirs: ["src"],
|
||||
includeExtensions: [".css"],
|
||||
importSyntax: "@import",
|
||||
excludeFilePattern: [/index\.css/, /index\.scss/, /\.(test|spec)\./],
|
||||
excludeDirs: [
|
||||
"__tests__",
|
||||
"tests",
|
||||
"story",
|
||||
"stories",
|
||||
"types",
|
||||
"node_modules",
|
||||
"dist",
|
||||
"build",
|
||||
],
|
||||
warnDuplicateTailwindImport: true,
|
||||
indexFileName: "index.css",
|
||||
};
|
||||
|
||||
const normalizePath = (p: string) => p.replace(/\\/g, "/");
|
||||
|
||||
function isValidFile(filePath: string, config: Config): boolean {
|
||||
const filenameWithExt = filePath.split(/[\\/]/).pop()!;
|
||||
const shouldExcludeFile = config.excludeFilePattern.some((p) =>
|
||||
p.test(filenameWithExt),
|
||||
);
|
||||
if (shouldExcludeFile) return false;
|
||||
|
||||
const normalized = normalizePath(filePath);
|
||||
const shouldExcludeDir = config.excludeDirs.some((dir) =>
|
||||
normalized.includes(`/${dir}/`),
|
||||
);
|
||||
if (shouldExcludeDir) return false;
|
||||
|
||||
const ext = path.extname(filePath);
|
||||
if (!config.includeExtensions.includes(ext)) return false;
|
||||
|
||||
if (config.warnDuplicateTailwindImport) {
|
||||
try {
|
||||
const content = fs.readFileSync(filePath, "utf-8");
|
||||
if (
|
||||
content.includes('@import "tailwindcss"') ||
|
||||
content.includes("@import 'tailwindcss'")
|
||||
) {
|
||||
console.warn(
|
||||
`[gen-index-css] ${filePath} 含有重复的 @import "tailwindcss",建议删除`,
|
||||
);
|
||||
}
|
||||
} catch {
|
||||
// ignore
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
function generateIndexFile(config: Config) {
|
||||
const [targetDir] = config.targetDirs;
|
||||
const dirPath = path.resolve(process.cwd(), targetDir);
|
||||
|
||||
const searchPattern = path.resolve(dirPath, "**", "*.*");
|
||||
|
||||
const allFiles = globSync(searchPattern, {
|
||||
nodir: true,
|
||||
absolute: true,
|
||||
windowsPathsNoEscape: true,
|
||||
dot: false,
|
||||
follow: true,
|
||||
});
|
||||
|
||||
const validFiles = allFiles.filter((f) => isValidFile(f, config));
|
||||
|
||||
console.log(`✅ 有效 CSS 文件数量: ${validFiles.length}`);
|
||||
validFiles.sort();
|
||||
|
||||
const importStatements = validFiles.map((file) => {
|
||||
const relPath = path.relative(dirPath, file);
|
||||
const importPath = "./" + relPath.replace(/\\/g, "/");
|
||||
return `${config.importSyntax} '${importPath}';`;
|
||||
});
|
||||
|
||||
const indexContent = `
|
||||
@import "tailwindcss";
|
||||
${importStatements.join("\n")}
|
||||
`.trim();
|
||||
|
||||
const indexFilePath = path.resolve(dirPath, config.indexFileName);
|
||||
|
||||
// ✅ 内容比对,防止无限 rebuild
|
||||
if (fs.existsSync(indexFilePath)) {
|
||||
const old = fs.readFileSync(indexFilePath, "utf8");
|
||||
if (old === indexContent) return;
|
||||
}
|
||||
|
||||
fs.writeFileSync(indexFilePath, indexContent, "utf8");
|
||||
console.log(`✅ 成功生成 ${config.indexFileName}: ${indexFilePath}`);
|
||||
}
|
||||
|
||||
export function genIndexCssPlugin(): Plugin {
|
||||
return {
|
||||
name: "vite-plugin-gen-index-css",
|
||||
apply: "build",
|
||||
|
||||
buildStart() {
|
||||
try {
|
||||
generateIndexFile(CONFIG);
|
||||
} catch (err) {
|
||||
const msg = err instanceof Error ? err.message : String(err);
|
||||
this.error(`[gen-index-css] failed: ${msg}`);
|
||||
throw err;
|
||||
}
|
||||
},
|
||||
|
||||
handleHotUpdate({ file }) {
|
||||
if (normalizePath(file).endsWith(`/src/${CONFIG.indexFileName}`)) {
|
||||
return [];
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,129 @@
|
||||
// plugins/vite-plugin-gen-index-ts.ts
|
||||
import type { Plugin } from "vite";
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
import { globSync } from "glob";
|
||||
|
||||
interface Config {
|
||||
targetDirs: string[];
|
||||
includeExtensions: string[];
|
||||
excludeKeywords: {
|
||||
dirs: string[];
|
||||
fileSuffixes: string[];
|
||||
filePatterns: RegExp[];
|
||||
};
|
||||
}
|
||||
|
||||
const CONFIG: Config = {
|
||||
targetDirs: ["src"],
|
||||
includeExtensions: [".ts", ".tsx", ".vue"],
|
||||
excludeKeywords: {
|
||||
dirs: ["__tests__", "tests", "story", "stories", "types"],
|
||||
fileSuffixes: [".d.ts"],
|
||||
filePatterns: [
|
||||
/^index\.(ts|tsx|js|jsx)$/,
|
||||
/\.(test|spec)\./,
|
||||
/\.(story|stories)\./,
|
||||
],
|
||||
},
|
||||
};
|
||||
|
||||
const normalizePath = (p: string) => p.replace(/\\/g, "/");
|
||||
|
||||
const isInExcludeDir = (filePath: string) => {
|
||||
const normalized = normalizePath(filePath);
|
||||
return CONFIG.excludeKeywords.dirs.some((dir) =>
|
||||
normalized.includes(`/${dir}/`),
|
||||
);
|
||||
};
|
||||
|
||||
const isExcludeSuffix = (filePath: string) =>
|
||||
CONFIG.excludeKeywords.fileSuffixes.some((suffix) =>
|
||||
filePath.endsWith(suffix),
|
||||
);
|
||||
|
||||
const isMatchExcludePattern = (fileName: string) =>
|
||||
CONFIG.excludeKeywords.filePatterns.some((pattern) => pattern.test(fileName));
|
||||
|
||||
function isValidFile(filePath: string): boolean {
|
||||
const fileName = filePath.split(/[\\/]/).pop()!;
|
||||
|
||||
if (isInExcludeDir(filePath)) return false;
|
||||
if (isExcludeSuffix(filePath)) return false;
|
||||
if (isMatchExcludePattern(fileName)) return false;
|
||||
|
||||
const ext = path.extname(filePath);
|
||||
return CONFIG.includeExtensions.includes(ext);
|
||||
}
|
||||
|
||||
function generateIndexFile(dirPath: string) {
|
||||
const searchPattern = path.resolve(dirPath, "**", "*.*");
|
||||
|
||||
const allFiles = globSync(searchPattern, {
|
||||
nodir: true,
|
||||
absolute: true,
|
||||
windowsPathsNoEscape: true,
|
||||
dot: false,
|
||||
follow: true,
|
||||
});
|
||||
|
||||
const validFiles = allFiles.filter(isValidFile);
|
||||
if (validFiles.length === 0) return;
|
||||
|
||||
validFiles.sort();
|
||||
|
||||
const exportStatements = validFiles.map((file) => {
|
||||
const relPath = path.relative(dirPath, file);
|
||||
const importPath = `./${relPath
|
||||
.replace(/\.[^.]+$/, "")
|
||||
.replace(/\\/g, "/")}`;
|
||||
return `export * from '${importPath}';`;
|
||||
});
|
||||
|
||||
const indexContent = `
|
||||
import './index.css';
|
||||
|
||||
${exportStatements.join("\n")}
|
||||
`.trim();
|
||||
|
||||
const indexFilePath = path.resolve(dirPath, "index.ts");
|
||||
|
||||
// ✅ 内容比对,避免无限 rebuild
|
||||
if (fs.existsSync(indexFilePath)) {
|
||||
const old = fs.readFileSync(indexFilePath, "utf8");
|
||||
if (old === indexContent) return;
|
||||
}
|
||||
|
||||
fs.writeFileSync(indexFilePath, indexContent, "utf8");
|
||||
}
|
||||
|
||||
export function genIndexTsPlugin(): Plugin {
|
||||
return {
|
||||
name: "vite-plugin-gen-index-ts",
|
||||
apply: "build",
|
||||
|
||||
buildStart() {
|
||||
const [targetDir] = CONFIG.targetDirs;
|
||||
if (!targetDir) {
|
||||
this.error("CONFIG.targetDirs is empty");
|
||||
return;
|
||||
}
|
||||
|
||||
const absTargetDir = path.resolve(process.cwd(), targetDir);
|
||||
|
||||
try {
|
||||
generateIndexFile(absTargetDir);
|
||||
} catch (err) {
|
||||
const msg = err instanceof Error ? err.message : String(err);
|
||||
this.error(`[gen-index-ts] failed: ${msg}`);
|
||||
throw err;
|
||||
}
|
||||
},
|
||||
|
||||
handleHotUpdate({ file }) {
|
||||
if (file.replace(/\\/g, "/").endsWith("/src/index.ts")) {
|
||||
return [];
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
4
templates/vite-react-template/src/types/css.d.ts
vendored
Normal file
4
templates/vite-react-template/src/types/css.d.ts
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
declare module '*.css' {
|
||||
const content: { [className: string]: string };
|
||||
export default content;
|
||||
}
|
||||
51
templates/vite-react-template/src/types/env.d.ts
vendored
Normal file
51
templates/vite-react-template/src/types/env.d.ts
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
/// <reference types="vite/client" />
|
||||
|
||||
declare module "*.svg" {
|
||||
import * as React from "react";
|
||||
export const ReactComponent: React.FC<React.SVGProps<SVGSVGElement>>;
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module "*.png" {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module "*.jpg" {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module "*.jpeg" {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module "*.gif" {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module "*.webp" {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
interface ImportMetaEnv {
|
||||
readonly MODE: "development" | "production" | "test";
|
||||
readonly BASE_URL: string;
|
||||
readonly PROD: boolean;
|
||||
readonly DEV: boolean;
|
||||
readonly SSR: boolean;
|
||||
|
||||
// ===== 业务环境变量 =====
|
||||
readonly VITE_API_BASE: string;
|
||||
readonly VITE_UPLOAD_URL?: string;
|
||||
readonly VITE_ENABLE_MOCK?: "true" | "false";
|
||||
readonly VITE_SENTRY_DSN?: string;
|
||||
}
|
||||
|
||||
interface ImportMeta {
|
||||
readonly env: ImportMetaEnv;
|
||||
}
|
||||
40
templates/vite-react-template/tsconfig.base.json
Normal file
40
templates/vite-react-template/tsconfig.base.json
Normal file
@@ -0,0 +1,40 @@
|
||||
{
|
||||
// tsconfig.base.json,用于被 tesconfig.json 和 tesconfig.build.json 继承
|
||||
"compilerOptions": {
|
||||
// 输出模块语法,使用版本号最新的那个,而不是实验性语法 ESNext
|
||||
"module": "es2022",
|
||||
|
||||
// 模块解析策略,模拟 Vite / Rollup / webpack,支持 exports / imports,不强制 Node ESM 的严格规则
|
||||
"moduleResolution": "bundler",
|
||||
|
||||
// 显式声明使用的类型包
|
||||
"types": ["node", "react", "vite/client"],
|
||||
|
||||
// 开启所有严格类型检查,防止 any / 隐式 any 扩散
|
||||
"strict": true,
|
||||
|
||||
// 允许 ESM 导入 CJS
|
||||
"esModuleInterop": true,
|
||||
|
||||
// 跳过 node_modules 类型检查,加快构建,避免第三方类型污染
|
||||
"skipLibCheck": true,
|
||||
|
||||
// 模块检测策略,不会影响 node_modules 中的第三方 CommonJS 依赖,Vite 会在预构建阶段自动将其转换为 ESM。
|
||||
"moduleDetection": "force",
|
||||
|
||||
// 保留源码中的 import / export 语句原样输出,不进行自动转换(如 import → require),通常与 moduleDetection: "force" 搭配使用
|
||||
"verbatimModuleSyntax": true,
|
||||
|
||||
// 是否检查“未使用的局部变量”
|
||||
"noUnusedLocals": true,
|
||||
|
||||
// 是否检查“未使用的函数参数”
|
||||
"noUnusedParameters": true,
|
||||
|
||||
// 是否只允许“可擦除的语法(Erasable Syntax),确保 TypeScript 语法在编译后可完全移除
|
||||
"erasableSyntaxOnly": true,
|
||||
|
||||
// 是否禁止 switch 语句中的 case 贯穿(fallthrough),如果 case 没有 break / return,会报错
|
||||
"noFallthroughCasesInSwitch": true
|
||||
}
|
||||
}
|
||||
122
templates/vite-react-template/tsconfig.build.json
Normal file
122
templates/vite-react-template/tsconfig.build.json
Normal file
@@ -0,0 +1,122 @@
|
||||
{
|
||||
// 此文件仅用于类型检查,不用于类型检查,构建时会指定使用 tsconfig.build.json
|
||||
"extends": "./tsconfig.base.json",
|
||||
"compilerOptions": {
|
||||
// Browser api,需要加 "DOM","DOM.Iterable"
|
||||
// Node api,需要加 "ES2025",始终使用带版本号的最新版本
|
||||
// NextJs api,属于同构,server 端会预处理 DOM,计算url,三个都需要 "ES2025", "DOM", "DOM.Iterable"
|
||||
"lib": ["ES2025", "DOM", "DOM.Iterable"],
|
||||
|
||||
/**
|
||||
* 显式声明使用的类型包
|
||||
* - node:Node.js API
|
||||
* - react:JSX / React 类型
|
||||
* - vite/client:import.meta / env
|
||||
*/
|
||||
"types": ["node", "react", "vite/client"],
|
||||
|
||||
/**
|
||||
* React JSX 编译模式
|
||||
* - 使用 React 17+ 新 JSX Transform
|
||||
* - 不需要手动 import React
|
||||
*/
|
||||
"jsx": "react-jsx",
|
||||
|
||||
/**
|
||||
* 编译输出目录
|
||||
* - tsc / tsc -b 都会用到
|
||||
*/
|
||||
"outDir": "./dist",
|
||||
|
||||
/**
|
||||
* 源码根目录
|
||||
* - 确保 dist 结构与 src 一致
|
||||
* - 对 declaration 路径至关重要
|
||||
*/
|
||||
"rootDir": "./src",
|
||||
|
||||
/**
|
||||
* 生成 .d.ts 类型声明文件
|
||||
* - 组件库 / npm 包发布必需
|
||||
* - 对应用项目无害,仅影响类型输出
|
||||
*/
|
||||
"declaration": true,
|
||||
|
||||
/**
|
||||
* 只做类型检查,不生成 JS 输出
|
||||
* - 适用于 Vite / Next / Nuxt 等 bundler 场景
|
||||
* - 防止 tsc 与构建工具重复 emit
|
||||
*/
|
||||
"noEmit": true,
|
||||
|
||||
/**
|
||||
* 强制单文件可独立编译
|
||||
* - 适配 esbuild / SWC / bundler 编译模型
|
||||
* - 禁止依赖跨文件类型推断(enum / namespace 等)
|
||||
*/
|
||||
"isolatedModules": true,
|
||||
|
||||
/**
|
||||
* 允许在 import 中显式使用 .ts / .tsx 后缀
|
||||
* - 兼容 Node ESM / bundler 对文件扩展名的严格要求
|
||||
* - 避免 `import './foo'` 在 TS + ESM 下歧义
|
||||
*/
|
||||
"allowImportingTsExtensions": true
|
||||
},
|
||||
/**
|
||||
* 参与类型检查和编译的文件
|
||||
* - 只扫描 src
|
||||
* - 其它目录通过 exclude 排除
|
||||
*/
|
||||
"include": ["src", "scripts"],
|
||||
|
||||
/**
|
||||
* 明确排除非源码内容
|
||||
* - 避免污染类型系统
|
||||
* - 防止误入 dist / test / config
|
||||
* - 保证发布包干净
|
||||
*/
|
||||
"exclude": [
|
||||
"node_modules",
|
||||
"dist",
|
||||
|
||||
// ---------- build / cache ----------
|
||||
".turbo/**/*",
|
||||
".cache/**/*",
|
||||
".vite/**/*",
|
||||
|
||||
// ---------- 配置文件 ----------
|
||||
"vite.config.ts",
|
||||
"*.config.ts",
|
||||
"*.config.js",
|
||||
"tsconfig.*.json",
|
||||
|
||||
// ---------- 测试相关 ----------
|
||||
"__tests__/**/*",
|
||||
"test/**/*",
|
||||
"tests/**/*",
|
||||
"**/*.test.ts",
|
||||
"**/*.test.tsx",
|
||||
"**/*.spec.ts",
|
||||
"**/*.spec.tsx",
|
||||
|
||||
// ---------- Storybook ----------
|
||||
".storybook/**/*",
|
||||
"stories/**/*",
|
||||
|
||||
// ---------- 示例 / 脚本 ----------
|
||||
"example/**/*",
|
||||
"examples/**/*",
|
||||
"scripts/**/*",
|
||||
|
||||
// ---------- 环境与静态资源 ----------
|
||||
".env",
|
||||
".env.*",
|
||||
"public/**/*",
|
||||
|
||||
// ---------- 文档 ----------
|
||||
"docs/**/*",
|
||||
"README.md",
|
||||
"LICENSE"
|
||||
]
|
||||
}
|
||||
16
templates/vite-react-template/tsconfig.json
Normal file
16
templates/vite-react-template/tsconfig.json
Normal file
@@ -0,0 +1,16 @@
|
||||
{
|
||||
// 此文件仅用于类型检查,不用于构建,构建时会指定使用 tsconfig.build.json
|
||||
"extends": "./tsconfig.base.json",
|
||||
"compilerOptions": {
|
||||
// node api 使用最新版本号的 "ESxxxx",browser api 使用 "DOM" 和 "DOM.Iterable"
|
||||
"lib": ["ES2025", "DOM", "DOM.Iterable"],
|
||||
|
||||
//显式声明使用的类型包,避免找不到模块
|
||||
"types": ["node", "react", "vite/client"],
|
||||
|
||||
// React JSX 编译模式
|
||||
"jsx": "react-jsx"
|
||||
},
|
||||
// 将类型检查范围扩大至整个子项目,而不只是 src 文件夹,
|
||||
"include": ["**/*"]
|
||||
}
|
||||
43
templates/vite-react-template/vite.config.ts
Normal file
43
templates/vite-react-template/vite.config.ts
Normal file
@@ -0,0 +1,43 @@
|
||||
import { defineConfig } from "vite";
|
||||
import react from "@vitejs/plugin-react";
|
||||
import dts from "vite-plugin-dts";
|
||||
import path from "path";
|
||||
import { genIndexTsPlugin } from "./scripts-plugin/vite-plugin-gen-index-ts";
|
||||
import { genIndexCssPlugin } from "./scripts-plugin/vite-plugin-gen-index-css";
|
||||
|
||||
export default defineConfig({
|
||||
plugins: [
|
||||
genIndexTsPlugin(),
|
||||
genIndexCssPlugin(),
|
||||
react(),
|
||||
dts({
|
||||
insertTypesEntry: true,
|
||||
}),
|
||||
],
|
||||
|
||||
build: {
|
||||
lib: {
|
||||
entry: path.resolve(__dirname, "src/index.ts"),
|
||||
name: "DefgovUIWeb",
|
||||
formats: ["es", "cjs"],
|
||||
fileName: (format) => `index.${format}.js`,
|
||||
},
|
||||
|
||||
rollupOptions: {
|
||||
external: ["react", "react-dom", "react/jsx-runtime"],
|
||||
output: {
|
||||
globals: {
|
||||
react: "React",
|
||||
"react-dom": "ReactDOM",
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
sourcemap: true,
|
||||
cssCodeSplit: true,
|
||||
|
||||
watch: {
|
||||
exclude: ["node_modules", "dist", ".git"],
|
||||
},
|
||||
},
|
||||
});
|
||||
Reference in New Issue
Block a user