Skip to content
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

docs: add details for "pulling code" and "install dependencies" #5193

Merged
merged 2 commits into from
May 28, 2023
Merged

docs: add details for "pulling code" and "install dependencies" #5193

merged 2 commits into from
May 28, 2023

Conversation

Wai-Dung
Copy link
Contributor

@Wai-Dung Wai-Dung commented May 28, 2023

Add necessary detailled information for "Pulling code" and "Install Dependencies", especially for when npm's version >= 7.x, '--legacy-peer-deps' is always ignored by new comers, which will raise installation problems.


  • npm test passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

Add necessary detailled information for "Pulling code" and "Install
Dependencies", especially for when npm's version >= 7.x,
'--legacy-peer-deps' is always ignored by new comers, which will raise
installation problems.
change "," to the English comma
当你的 npm 版本高于等于 7.X 时,你可以使用以下命令:

```bash
npm i --legacy-peer-deps
Copy link
Member

Choose a reason for hiding this comment

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

具体是那个依赖出现了问题?我们可以修复一下,不提倡添加 --legacy-peer-deps 参数来安装依赖。

Copy link
Contributor Author

@Wai-Dung Wai-Dung May 28, 2023

Choose a reason for hiding this comment

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

PS D:\Projects\egg> npm i
npm ERR! code ERESOLVE
npm ERR! ERESOLVE could not resolve
npm ERR!
npm ERR! While resolving: dumi-theme-egg@1.2.2
npm ERR! Found: react@16.14.0
npm ERR! node_modules/react
npm ERR! dev react@"^16.14.0" from the root project
npm ERR! peer react@"^16.8.0 || ^17.0.0" from @ahooksjs/use-request@2.8.15
npm ERR! node_modules/@ahooksjs/use-request
npm ERR! @ahooksjs/use-request@"^2.8.0" from @umijs/plugin-request@2.9.0
npm ERR! node_modules/@umijs/plugin-request
npm ERR! @umijs/plugin-request@"2.9.0" from @umijs/preset-react@2.1.6
npm ERR! node_modules/@umijs/preset-react
npm ERR! dev @umijs/preset-react@"^2.1.6" from the root project
npm ERR! 83 more (@ant-design/icons, @ant-design/react-slick, ...)
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer react@"^17.x" from dumi-theme-egg@1.2.2
npm ERR! node_modules/dumi-theme-egg
npm ERR! dev dumi-theme-egg@"^1.2.2" from the root project
npm ERR!
npm ERR! Conflicting peer dependency: react@17.0.2
npm ERR! node_modules/react
npm ERR! peer react@"^17.x" from dumi-theme-egg@1.2.2
npm ERR! node_modules/dumi-theme-egg
npm ERR! dev dumi-theme-egg@"^1.2.2" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When it's <= 7.X, nothing happened?

Copy link
Member

Choose a reason for hiding this comment

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

明白了,依赖的 dumi 太老。下一个大版本会解决掉。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

对的,临时性解决方案。但是不写上去的话很多贡献者可能会问。这个一个必然的问题。谢谢理解。

@codecov
Copy link

codecov bot commented May 28, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (5ac2e54) 99.85% compared to head (bbe150d) 99.85%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5193   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files          35       35           
  Lines        3489     3489           
  Branches      512      512           
=======================================
  Hits         3484     3484           
  Misses          5        5           
Impacted Files Coverage Δ
lib/core/messenger/ipc.js 100.00% <100.00%> (ø)
lib/core/messenger/local.js 100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@fengmk2 fengmk2 merged commit edb3609 into eggjs:master May 28, 2023
18 checks passed
@github-actions
Copy link

🎉 This PR is included in version 3.16.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants