-
Notifications
You must be signed in to change notification settings - Fork 288
refactor: 打包组件不同主题的 css 文件 #3189
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 8 commits
8504c5a
3703929
c1cb2b7
8468ae2
a78f8ae
8b68016
5f28765
9a86dfa
4e1c313
c4c7ca1
9be4069
0106866
ff354d5
1d33edf
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,16 +1,44 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| module.exports = { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| webpack: { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| module: { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rules: [ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| test: /\.s[ac]ss$/i, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| use: [ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 'style-loader', | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 'css-loader', | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| loader: "sass-loader", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| options: { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| additionalData: `@import '@nutui/nutui-react/dist/styles/variables.scss';` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // JDesign 主题 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // additionalData: `@import '@nutui/nutui-react/dist/styles/variables-jmapp.scss';` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // JRKF 主题 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // additionalData: `@import '@nutui/nutui-react/dist/styles/variables-jrkf.scss';` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| babel: { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plugins: [ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "import", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 'import', | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "libraryName": "@nutui/nutui-react", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "libraryDirectory": "dist/esm", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "style": "css", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "camel2DashComponentName": false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| libraryName: '@nutui/nutui-react', | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| camel2DashComponentName: false, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customName: (name, file) => { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return `@nutui/nutui-react-taro/dist/es/packages/${name.toLowerCase()}` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // 自动加载 scss 样式文件 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customStyleName: (name) => `@nutui/nutui-react-taro/dist/es/packages/${name.toLowerCase()}/style` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // 自动加载 css 样式文件 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // customStyleName: (name) => `@nutui/nutui-react-taro/dist/es/packages/${name.toLowerCase()}/style` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "nutui-react" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 'nutui-react', | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion 更新Babel插件配置 babel-plugin-import配置已更新,使用动态的customName和customStyleName函数来解析组件路径和样式路径,支持按需加载组件样式。 但在38-39行中,注释表示是"自动加载css样式文件",而实际路径与36行的SCSS路径相同,这可能会造成混淆。建议修正这个注释或路径,确保CSS样式文件的正确路径。 - // 自动加载 css 样式文件
- // customStyleName: (name) => `@nutui/nutui-react-taro/dist/es/packages/${name.toLowerCase()}/style`
+ // 自动加载 css 样式文件
+ // customStyleName: (name) => `@nutui/nutui-react-taro/dist/es/packages/${name.toLowerCase()}/style/css`📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,12 +20,13 @@ | |
| "@types/react-dom": "^18.2.7", | ||
| "@typescript-eslint/eslint-plugin": "^6.0.0", | ||
| "@typescript-eslint/parser": "^6.0.0", | ||
| "@vitejs/plugin-react": "^4.0.4", | ||
| "@vitejs/plugin-react-swc": "^3.5.0", | ||
| "eslint": "^8.45.0", | ||
| "eslint-plugin-react-hooks": "^4.6.0", | ||
| "eslint-plugin-react-refresh": "^0.4.3", | ||
| "typescript": "^5.0.2", | ||
| "vite": "^4.4.5", | ||
| "sass-embedded": "^1.86.3", | ||
| "typescript": "~5.6.2", | ||
| "vite": "^6.0.5", | ||
|
Comment on lines
+27
to
+29
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💡 Verification agent 🧩 Analysis chain更新和添加依赖以支持多主题构建 添加了sass-embedded依赖并更新了TypeScript和Vite版本,以支持多主题CSS文件的构建和处理。这些更新对于实现主题变量的预处理和动态样式路径解析非常必要。 请确认这些依赖版本是否与项目中的其他模块兼容,特别是升级到Vite 6可能需要确保所有插件都支持新版本。 🏁 Script executed: #!/bin/bash
# 检查项目中Vite相关的依赖版本
npm ls | grep viteLength of output: 10386 请更新 Vite 相关插件以支持 Vite 6 版本 在
请针对以下几点进行修正:
|
||
| "vite-plugin-imp": "^2.4.0" | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -244,26 +244,28 @@ async function buildUMD() { | |
| }) | ||
| } | ||
|
|
||
| async function buildAllCSS() { | ||
| // 针对不同主题构建全量的 style | ||
| async function buildAllCSS(themeName = '') { | ||
| // 拷贝styles | ||
| const themeStylePath = themeName ? `style-${themeName}` : 'style' | ||
| async function generateAllStyles() { | ||
| const projectID = process.env.VITE_APP_PROJECT_ID | ||
| const content = [ | ||
| `@import './styles/variables${projectID ? `-${projectID}` : ''}.scss';`, | ||
| `@import './styles/variables${themeName ? `-${themeName}` : ''}.scss';`, | ||
| `@import './styles/mixins/index.scss';`, | ||
| `@import './styles/animation/index.scss';`, | ||
| ] | ||
| const scssFiles = await glob([`${dist}/es/packages/**/*.scss`]) | ||
| const scssFiles = await glob([`${dist}/es/packages/**/${themeStylePath}/*.scss`]) | ||
| scssFiles.forEach((file) => { | ||
| content.push( | ||
| `@import '${relativePath('/' + file, `/${dist}/style.scss`)}';`, | ||
| `@import '${relativePath('/' + file, `/${dist}/${themeStylePath}.scss`)}';`, | ||
| ) | ||
| }) | ||
| dest(`${dist}/style.scss`, content.join('\n')) | ||
| await dest(`${dist}/${themeStylePath}.scss`, content.join('\n')) | ||
| } | ||
|
|
||
| await generateAllStyles() | ||
| await vite.build({ | ||
| configFile: false, | ||
| logLevel: 'error', | ||
| resolve: { | ||
| alias: [{ find: '@', replacement: resolve(__dirname, '../src') }], | ||
|
|
@@ -272,11 +274,16 @@ async function buildAllCSS() { | |
| emptyOutDir: false, | ||
| outDir: dist, | ||
| lib: { | ||
| entry: `./${dist}/style.scss`, | ||
| entry: `./${dist}/${themeStylePath}.scss`, | ||
| formats: ['es'], | ||
| name: 'style', | ||
| fileName: 'style', | ||
| }, | ||
| rollupOptions: { | ||
| output: { | ||
| assetFileNames: `${themeStylePath}.css`, // 资源文件名 | ||
| } | ||
| } | ||
| }, | ||
| }) | ||
| } | ||
|
|
@@ -287,6 +294,11 @@ async function buildThemeCSS() { | |
| }) | ||
| const projectID = process.env.VITE_APP_PROJECT_ID | ||
| const inputFiles = {} | ||
| // nuitui 官方包包含全部主题文件,包括: | ||
| // default.css 默认明亮主题 | ||
| // dark.css 默认暗黑主题 | ||
| // jmapp.css、jrkf.css 主题 | ||
| // 例如:jmapp 包只包含 jmapp 的主题文件,且是默认主题文件。 | ||
| files.forEach(filePath => { | ||
| const themeName = basename(filePath, 'scss').replace('theme-', '') | ||
| if (!projectID) { | ||
|
|
@@ -331,16 +343,16 @@ async function copyStyles() { | |
| } | ||
|
|
||
| // 构建样式 | ||
| async function buildCSS(p) { | ||
| const cssFiles = await glob(['src/packages/**/*.scss'], { | ||
| async function buildCSS(themeName = '') { | ||
| const componentScssFiles = await glob(['src/packages/**/*.scss'], { | ||
|
Comment on lines
345
to
+347
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion 在 Sass 编译过程中添加错误处理日志。 当前仅调用 |
||
| ignore: ['src/packages/**/demo.scss'], | ||
| }) | ||
|
|
||
| const variables = await readFile( | ||
| join(__dirname, '../src/styles/variables.scss'), | ||
| join(__dirname, `../src/styles/variables${themeName ? `-${themeName}` : ''}.scss`), | ||
| ) | ||
| for (const file of cssFiles) { | ||
| const button = await readFile(join(__dirname, '../', file), { | ||
| for (const file of componentScssFiles) { | ||
| const scssContent = await readFile(join(__dirname, '../', file), { | ||
| encoding: 'utf8', | ||
| }) | ||
| // countup 是特例 | ||
|
|
@@ -350,30 +362,11 @@ async function buildCSS(p) { | |
| '../src/packages', | ||
| base.replace('.scss', ''), | ||
| ) | ||
| const code = sass.compileString(variables + '\n' + button, { | ||
| loadPaths: [loadPath], | ||
| }) | ||
| const cssPath = relative('src', loadPath) | ||
| // 写 css 文件 | ||
| await dest(join(`${dist}/es`, cssPath, 'style/style.css'), code.css) | ||
| await dest(join(`${dist}/es`, cssPath, 'style/css.js'), `import './style.css'`) | ||
|
|
||
| await dest(join(`${dist}/cjs`, cssPath, 'style/style.css'), code.css) | ||
| await dest( | ||
| join(`${dist}/cjs`, cssPath, 'style/css.js'), | ||
| `import './style.css'`, | ||
| ) | ||
|
|
||
| // copy harmonycss | ||
| if (file.indexOf('countup') === -1) { | ||
| await copy(join(__dirname, '../', file.replace('scss', 'harmony.css')), join(`${dist}/cjs`, cssPath, 'style/style.harmony.css')) | ||
| await copy(join(__dirname, '../', file.replace('scss', 'harmony.css')), join(`${dist}/es`, cssPath, 'style/style.harmony.css')) | ||
| } | ||
|
|
||
| // 删除 import | ||
| // 写入 style.scss | ||
| const atRules = [] | ||
| await postcss([ | ||
| const postcssRes = await postcss([ | ||
| { | ||
| postcssPlugin: 'remove-atrule', | ||
| AtRule(root) { | ||
|
|
@@ -391,13 +384,22 @@ async function buildCSS(p) { | |
| }, | ||
| }, | ||
| ]) | ||
| .process(button, { from: loadPath, syntax: scss }) | ||
| .process(scssContent, { from: loadPath, syntax: scss }) | ||
| .then((result) => { | ||
| dest(join(`${dist}/es`, cssPath, `style/${base}`), result.css) | ||
| dest(join(`${dist}/cjs`, cssPath, `style/${base}`), result.css) | ||
| return result | ||
| }) | ||
| const themeDir = themeName ? `style-${themeName}` : 'style' | ||
| await dest(join(`${dist}/es`, cssPath, `${themeDir}/${base}`), postcssRes.css) | ||
| await dest(join(`${dist}/cjs`, cssPath, `${themeDir}/${base}`), postcssRes.css) | ||
|
|
||
| const code = sass.compileString(variables + '\n' + postcssRes.css.replaceAll('../../../../', '../../'), { | ||
| loadPaths: [loadPath], | ||
| }) | ||
| await dest(join(`${dist}/es`, cssPath, `${themeDir}/style.css`), code.css) | ||
| await dest(join(`${dist}/cjs`, cssPath, `${themeDir}/style.css`), code.css) | ||
|
|
||
| const jsContent = [] | ||
| const cssContent = [] | ||
| atRules.forEach((rule) => { | ||
| rule = rule.replaceAll('\'', '') | ||
| if (rule.indexOf('../styles/') > -1) { | ||
|
|
@@ -407,18 +409,33 @@ async function buildCSS(p) { | |
| const base = basename(rule) | ||
| const ext = extname(base) | ||
| const name = base.replace(ext, '') | ||
| jsContent.push(`import '../../${name}/style';`) | ||
| jsContent.push(`import '../../${name}/${themeDir}';`) | ||
| cssContent.push(`import '../../${name}/${themeDir}/css';`) | ||
| } | ||
| }) | ||
| jsContent.push(`import './${base}';`) | ||
| cssContent.push(`import './style.css';`) | ||
|
|
||
| await dest( | ||
| join(`${dist}/cjs`, cssPath, `style/index.js`), | ||
| join(`${dist}/cjs`, cssPath, `${themeDir}/index.js`), | ||
| jsContent.join('\n'), | ||
| ) | ||
| await dest(join(`${dist}/es`, cssPath, `style/index.js`), jsContent.join('\n')) | ||
| } | ||
| await dest(join(`${dist}/es`, cssPath, `${themeDir}/index.js`), jsContent.join('\n')) | ||
|
|
||
| // 写 css 文件 | ||
| await dest(join(`${dist}/es`, cssPath, `${themeDir}/css.js`), cssContent.join('\n')) | ||
| await dest( | ||
| join(`${dist}/cjs`, cssPath, `${themeDir}/css.js`), | ||
| cssContent.join('\n'), | ||
| ) | ||
|
|
||
| // copy harmonycss | ||
| if (file.indexOf('countup') === -1) { | ||
| const harmonyCss = join(__dirname, '../', file.replace('scss', 'harmony.css')) | ||
| await copy(harmonyCss, join(`${dist}/cjs`, cssPath, 'style/style.harmony.css')) | ||
| await copy(harmonyCss, join(`${dist}/es`, cssPath, 'style/style.harmony.css')) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| function generateReleasePackageJson() { | ||
|
|
@@ -474,18 +491,36 @@ console.time('build UMD') | |
| await buildUMD() | ||
| console.timeEnd('build UMD') | ||
|
|
||
| console.time('Build CSS') | ||
| await buildCSS() | ||
| console.timeEnd('Build CSS') | ||
|
|
||
| console.time('Copy Styles') | ||
| await copyStyles() | ||
| console.timeEnd('Copy Styles') | ||
|
|
||
| console.time('Build CSS') | ||
| await buildCSS() | ||
| console.timeEnd('Build CSS') | ||
|
|
||
| console.time('Build jmapp CSS') | ||
| await buildCSS('jmapp') | ||
| console.timeEnd('Build CSS') | ||
|
|
||
| console.time('Build jrkf CSS') | ||
| await buildCSS('jrkf') | ||
| console.timeEnd('Build jrkf CSS') | ||
|
|
||
| console.time('Build All CSS') | ||
| await buildAllCSS() | ||
| console.timeEnd('Build All CSS') | ||
|
|
||
| console.time('Build All jrkf CSS') | ||
| await buildAllCSS('jrkf') | ||
| console.timeEnd('Build All jrkf CSS') | ||
|
|
||
| console.time('Build All jmapp CSS') | ||
| await buildAllCSS('jmapp') | ||
| console.timeEnd('Build All jmapp CSS') | ||
|
|
||
|
|
||
| console.time('Build Theme CSS') | ||
| await buildThemeCSS() | ||
| console.timeEnd('Build Theme CSS') | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
出来 taro了