Skip to content

chore: support pnpm workspace #2842

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.

Sign up for GitHub

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

Merged
xiaoyatong merged 6 commits into from
Dec 10, 2024
Merged

chore: support pnpm workspace #2842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3b2210d
chore: support pnpm workspace
oasis-cloud Dec 9, 2024
854750a
fix: review
oasis-cloud Dec 9, 2024
b588226
fix: review
oasis-cloud Dec 9, 2024
38b4dd2
fix: review
oasis-cloud Dec 10, 2024
79b6112
fix: review
oasis-cloud Dec 10, 2024
1c1f48a
fix: 增加 clone 壳工程的流程
oasis-cloud Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# Other lock files
pnpm-lock.*.yaml

# Editor directories and files
.idea
.vscode
Expand Down
22 changes: 22 additions & 0 deletions .pnpmfile.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
function readPackage(pkg, context) {
if(pkg.name == '@nutui/nutui-react-taro') {
// console.log(pkg)
// delete pkg.devDependencies[]
// delete pkg.dependencies[]
}
if (pkg.name === '@nutui/nutui-taro-demo') {
delete pkg.dependencies['@jdreact/jdreact-jsbundle-commonpack']
delete pkg.dependencies['@jdtaro/plugin-platform-jdhybrid']
delete pkg.dependencies['@jdtaro/taro-platform-jdharmony']
delete pkg.dependencies['@jdtaro/plugin-platform-jdharmony-cpp']
delete pkg.dependencies['@dongdesign/inject-jd-platform-styles']
}
return pkg;
}

module.exports = {
hooks: {
readPackage,
},
}

48 changes: 39 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,25 +71,55 @@ pnpm run dev
# visit in browser: http：http://localhost:3000 (you don't have to open it manually if you've run it in the browser again)
```

### running with mini-program
### running with Taro

```sh
# Clone repository
# Clone the repository
git clone https://github.com/jdf2e/nutui-react.git

# Enter the project dictionary
# Navigate to the project root directory
cd nutui-react

# Install dependencies
pnpm install

# Start development
# dir：packages/nutui-taro-demo/dist/weapp
pnpm run dev:taro:weapp
# Enter mini-program development mode
# Taro H5
pnpm dev:taro h5
# WeChat Mini Program
pnpm dev:taro weapp
# JD Mini Program
pnpm dev:taro jd
# For other platforms, refer to the scripts in the package.json file in the demo directory
```

### running with JDTaro

1. Add a .npmrc file in the root directory of the repository with the following configuration:

```shell
git-branch-lockfile=true
```

```sh
# Clone the repository
git clone https://github.com/jdf2e/nutui-react.git

# Navigate to the project root directory
cd nutui-react

# Install dependencies
pnpm install

# OR run as jd mini-program
# dir：packages/nutui-taro-demo/dist/jd
pnpm run dev:taro:jd
# Enter mini-program development mode
# Taro H5
pnpm dev:jdtaro h5
# WeChat Mini Program
pnpm dev:jdtaro weapp
# JD Mini Program
pnpm dev:jdtaro jd
# harmony cpp
pnpm dev:jdtaro:jdharmonycpp
```

## Build Versions
Expand Down
48 changes: 40 additions & 8 deletions README_ZH.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ pnpm run dev

```

### 本地运行小程序
### 本地运行 Taro 相关的预览

```sh
````sh
# 克隆仓库
git clone https://github.com/jdf2e/nutui-react.git

Expand All @@ -84,14 +84,46 @@ cd nutui-react
pnpm install

# 进入小程序开发模式
# 访问：src/sites/mobile-taro/dist/weapp
pnpm run dev:taro:weapp

# 其他小程序类似，如京东小程序
# 访问：src/sites/mobile-taro/dist/jd
pnpm run dev:taro:jd
```shell
# Taro H5
pnpm dev:taro h5
# 微信小程序
pnpm dev:taro weapp
# 京东小程序
pnpm dev:taro jd
# 其他平台 参考 demo 目录中 package.json 的 script
````

### 本地运行 JDTaro 相关的预览

1. 仓库根目录下增加 .npmrc 文件，增加如下配置:

```shell
git-branch-lockfile=true
```

````sh
# 克隆仓库
git clone https://github.com/jdf2e/nutui-react.git

# 进入项目根目录
cd nutui-react

# 安装依赖
pnpm install --ignore-pnpmfile

# 进入小程序开发模式
```shell
# Taro H5
pnpm dev:jdtaro h5
# 微信小程序
pnpm dev:jdtaro weapp
# 京东小程序
pnpm dev:jdtaro jd
# harmony cpp
pnpm dev:jdtaro:jdharmonycpp
Comment on lines +112 to +124
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Dec 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

建议补充特殊命令的使用说明

以下几点需要补充说明：

  1. 为什么安装依赖时需要使用 --ignore-pnpmfile 参数
  2. dev:jdtaro 与 dev:taro 的区别
  3. harmony cpp 的使用场景和所需环境

这些信息对于开发者正确使用命令至关重要。

````

## 构建版本

> AMD 环境、Webpack、Vite 等构建工具环境、服务端建议使用 es 版，非模块化环境（如通过 `<script>` 标签直接引用）建议使用 umd 压缩版。
Expand Down
23 changes: 8 additions & 15 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,30 +54,23 @@
"clone:rn": "pnpm run update:taro:entry && node ./scripts/rn/copy-file.js",
"dev": "vite --open --force",
"dev:rtl": "VITE_RTL=rtl vite --open --force",
"dev:jmapp": "VITE_APP_PROJECT_ID=jmapp vite --open --force",
"dev:jrkf": "VITE_APP_PROJECT_ID=jrkf vite --open --force",
"dev:theme": "npm run generate:themes-dev && npm run checked && vite --force --config vite.config.theme.ts",
"dev:taro:weapp": "pnpm run update:taro:entry && pnpm --dir ./packages/nutui-taro-demo dev:weapp",
"dev:taro:jd": "pnpm run update:taro:entry && pnpm --dir ./packages/nutui-taro-demo dev:jd",
"dev:taro:h5": "pnpm run update:taro:entry && pnpm --dir ./packages/nutui-taro-demo dev:h5",
"dev:taro:h5:jmapp": "pnpm update:taro:entry && pnpm --dir ./packages/nutui-taro-demo dev:h5:jmapp",
"dev:taro:alipay": "pnpm update:taro:entry && pnpm --dir ./packages/nutui-taro-demo dev:alipay",
"dev:taro:harmony": "pnpm run update:taro:entry && pnpm --dir ./packages/nutui-taro-demo dev:harmony",
"dev:taro:jdharmony": "pnpm run clone:jdharmony && pnpm run update:taro:entry && pnpm --dir ./packages/nutui-taro-demo dev:jdharmony",
"dev:taro:jdharmonycpp": "pnpm run clone:jdharmony cpp && pnpm run update:taro:entry && pnpm --dir ./packages/nutui-taro-demo dev:jdharmonycpp",
"dev:taro:jdhybrid": "pnpm run update:taro:entry && pnpm --dir ./packages/nutui-taro-demo dev:jdhybrid",
"dev:taro:jdrn": "pnpm run clone:rn && pnpm --dir ./packages/nutui-taro-demo dev:jdrn",
"dev:taro:rn:dark": "THEME=dark pnpm dev:taro:rn",
"dev:taro:weapp:jmapp": "pnpm --dir ./packages/nutui-taro-demo && npm run dev:weapp:jmapp",
"dev:taro": "pnpm run update:taro:entry && pnpm --dir ./packages/nutui-taro-demo dev",
"dev:jdtaro": "pnpm run update:taro:entry && JD=1 pnpm --dir ./packages/nutui-taro-demo dev",
"dev:jdtaro:jdharmonycpp": "pnpm run clone:jdharmony cpp &&pnpm run update:taro:entry && JD=1 pnpm --dir ./packages/nutui-taro-demo dev:jdharmonycpp",
"dev:jdtaro:jdharmony": "pnpm run clone:jdharmony && pnpm run update:taro:entry && JD=1 pnpm --dir ./packages/nutui-taro-demo dev:jdharmony",
"dev:taro:jmapp": "pnpm run update:taro:entry && JD=1 pnpm --dir ./packages/nutui-taro-demo dev:jmapp",
"build": "npm run checked && node scripts/build.mjs",
"build:taro": "npm run checked:taro && node scripts/build-taro.mjs",
"build:taro:jd": "pnpm --dir ./packages/nutui-taro-demo build:jd",
"build:taro:jmapp": "npm run checked:taro && VITE_APP_PROJECT_ID=jmapp node scripts/build-taro.mjs",
"build:site": "npm run checked && vite build --config vite.config.site.ts",
"build:site:jmapp": "npm run checked && VITE_APP_PROJECT_ID=jmapp vite build",
"build:taro:site": "pnpm update:taro:entry && npm run checked:taro && npm run generate:file:taro:pages && pnpm --dir ./packages/nutui-taro-demo build:h5",
"build:taro:site:jmapp": "npm run checked:taro && VITE_APP_PROJECT_ID=jmapp npm run generate:file:taro:pages && VITE_APP_PROJECT_ID=jmapp pnpm --dir ./packages/nutui-taro-demo build:h5",
"build:theme:site": "npm run checked && vite build --config vite.config.theme.ts && npm run generate:themes-dev",
"build:jdtaro:site": "pnpm update:taro:entry && npm run checked:taro && npm run generate:file:taro:pages && JD=1 pnpm --dir ./packages/nutui-taro-demo build:h5",
"build:taro:site:jmapp": "npm run checked:taro && VITE_APP_PROJECT_ID=jmapp npm run generate:file:taro:pages && pnpm --dir ./packages/nutui-taro-demo build:h5",
"build:jstaro:site:jmapp": "npm run checked:taro && VITE_APP_PROJECT_ID=jmapp npm run generate:file:taro:pages && JD=1 pnpm --dir ./packages/nutui-taro-demo build:h5",
Comment on lines +71 to +73
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Dec 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

构建脚本命名需要统一规范

构建脚本的命名存在不一致：

  • build:jdtaro:site
  • build:taro:site:jmapp
  • build:jstaro:site:jmapp

建议统一命名规范，例如全部使用 build:jdtaro 或 build:jstaro 前缀。

建议修改为：

-    "build:jdtaro:site": "pnpm update:taro:entry && npm run checked:taro && npm run generate:file:taro:pages && JD=1 pnpm --dir ./packages/nutui-taro-demo build:h5",
-    "build:taro:site:jmapp": "npm run checked:taro && VITE_APP_PROJECT_ID=jmapp npm run generate:file:taro:pages && pnpm --dir ./packages/nutui-taro-demo build:h5",
-    "build:jstaro:site:jmapp": "npm run checked:taro && VITE_APP_PROJECT_ID=jmapp npm run generate:file:taro:pages && JD=1 pnpm --dir ./packages/nutui-taro-demo build:h5",
+    "build:jdtaro:site": "pnpm update:taro:entry && npm run checked:taro && npm run generate:file:taro:pages && JD=1 pnpm --dir ./packages/nutui-taro-demo build:h5",
+    "build:jdtaro:site:jmapp": "npm run checked:taro && VITE_APP_PROJECT_ID=jmapp npm run generate:file:taro:pages && JD=1 pnpm --dir ./packages/nutui-taro-demo build:h5"

Committable suggestion skipped: line range outside the PR's diff.

Comment on lines +60 to +73
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Dec 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

pnpm workspace 配置需要调整

根据验证结果发现以下问题：

  1. 缺少 .npmrc 文件，无法确保 git 分支锁文件的正确性
  2. 根目录 package.json 中未配置 workspaces 字段，与 pnpm-workspace.yaml 配置不一致
  3. packages/nutui-taro-demo 中存在 resolutions 字段警告，需要将其移至工作区根目录

建议进行如下修改：

  • 在根目录创建 .npmrc 文件并添加 git-branch-lockfile=true
  • 在根目录 package.json 中添加 workspaces 配置，与 pnpm-workspace.yaml 保持一致
  • 将 packages/nutui-taro-demo/package.json 中的 resolutions 字段移至根目录 package.json
🔗 Analysis chain

验证 pnpm workspace 配置

根据 PR 目标，需要确保 pnpm workspace 的正确配置。请确认：

  1. .npmrc 文件中是否已添加 git-branch-lockfile=true
  2. workspace 相关的依赖是否正确配置

Let me gather more information about the workspace configuration and dependencies.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 检查 pnpm workspace 配置
echo "检查 .npmrc 配置："
cat .npmrc 2>/dev/null || echo ".npmrc 文件不存在"

echo "检查 pnpm-workspace.yaml 配置："
cat pnpm-workspace.yaml 2>/dev/null || echo "pnpm-workspace.yaml 文件不存在"

echo "检查是否存在工作区包的循环依赖："
pnpm ls -r 2>/dev/null || echo "未找到 pnpm 工作区配置"

Length of output: 753

Script:

#!/bin/bash
# 检查根目录 package.json 中的 workspaces 配置
echo "检查根目录 package.json 配置："
cat package.json | jq '.workspaces'

echo "检查各个工作区包的依赖关系："
for pkg in packages/nutui-codemod packages/nutui-auto-import packages/nutui-taro-demo; do
  if [ -f "$pkg/package.json" ]; then
    echo -e "\n检查 $pkg/package.json:"
    cat "$pkg/package.json" | jq '{name: .name, dependencies: .dependencies, devDependencies: .devDependencies}'
  fi
done

Length of output: 4861

"generate:file": "node scripts/generate-nutui.js",
"generate:themes": "node scripts/generate-themes.js",
"generate:themes-dev": "node scripts/generate-themes-dev.js",
Expand Down
19 changes: 11 additions & 8 deletions packages/nutui-taro-demo/config/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ const path = require('path')
let fileStr = `src/styles/variables.scss`
let themeStr = `src/styles/theme-default.scss`
const projectID = process.env.VITE_APP_PROJECT_ID
const JD = process.env.JD
console.log('JDJDJDJDJDJD', JD)
if (projectID) {
fileStr = `src/styles/variables-${projectID}.scss`
themeStr = `src/styles/theme-${projectID}.scss`
Expand All @@ -18,20 +20,21 @@ if (process.env.TARO_ENV === 'harmony') {
plugins.push('@tarojs/plugin-platform-harmony-ets')
}

if (process.env.TARO_ENV === 'rn' || process.env.TARO_ENV === 'jdrn') {
if ((process.env.TARO_ENV === 'rn' || process.env.TARO_ENV === 'jdrn') && JD) {
plugins.push('@jdtaro/plugin-platform-jdrn')
}

// 小程序、jd H5 通过此插件覆盖
if (
process.env.TARO_ENV === 'weapp' ||
process.env.TARO_ENV === 'jd' ||
process.env.TARO_ENV === 'jdhybrid'
(process.env.TARO_ENV === 'weapp' ||
process.env.TARO_ENV === 'jd' ||
process.env.TARO_ENV === 'jdhybrid') &&
JD
) {
plugins.push('@dongdesign/inject-jd-platform-styles')
}

if (process.env.TARO_ENV === 'jdhybrid') {
if (process.env.TARO_ENV === 'jdhybrid' && JD) {
plugins.push([
'@jdtaro/plugin-platform-jdhybrid',
{
Expand All @@ -43,10 +46,10 @@ if (process.env.TARO_ENV === 'jdhybrid') {
}
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error
if (process.env.TARO_ENV === 'jdharmony') {
if (process.env.TARO_ENV === 'jdharmony' && JD) {
plugins = ['@jdtaro/taro-platform-jdharmony']
}
if (process.env.TARO_ENV === 'jdharmony_cpp') {
if (process.env.TARO_ENV === 'jdharmony_cpp' && JD) {
plugins = ['@jdtaro/plugin-platform-jdharmony-cpp']
}
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
Expand Down Expand Up @@ -74,7 +77,7 @@ const config = {
compiler: {
type: 'webpack5',
prebundle: {
exclude: ['@nutui/icons-react-taro']
exclude: ['@nutui/icons-react-taro'],
},
},
alias:
Expand Down
5 changes: 5 additions & 0 deletions packages/nutui-taro-demo/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
"css": "sass"
},
"scripts": {
"dev": "taro build --watch --type",
"dev:jmapp": "VITE_APP_PROJECT_ID=jmapp taro build --watch --type",
"build": "taro build --type",
"build:jmapp": "taro build --type",

"build:weapp": "taro build --type weapp",
"build:swan": "taro build --type swan",
"build:alipay": "taro build --type alipay",
Expand Down
Loading