Skip to content

Development: Remove yargs parser #10963

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

Closed
wants to merge 1 commit into from

Conversation

tobias-lippert
Copy link
Contributor

@tobias-lippert tobias-lippert commented Jun 2, 2025

Checklist

General

Motivation and Context

The client build fails locally with

Unknown error: Error [ERR_REQUIRE_ESM]: require() of ES Module C:\Artemis\node_modules\yargs-parser\build\lib\index.js from C:\Artemis\node_modules\yargs\build\index.cjs not supported.
Instead change the require of index.js in C:\Artemis\node_modules\yargs\build\index.cjs to a dynamic import() which is available in all CommonJS modules.

Description

Removed the yargs parser. It's esm-only since v22.0 which isn't compatible with Artemis.
If it's used indeed, we have to downgrade.

Steps for Testing

  • Make sure all relevant checks pass.

Testserver States

You can manage test servers using Helios. Check environment statuses in the environment list. To deploy to a test server, go to the CI/CD page, find your PR or branch, and trigger the deployment.

Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Summary by CodeRabbit

  • Chores
    • Updated dependency management by removing an override for "yargs-parser". No changes to app functionality.

Copy link
Contributor

coderabbitai bot commented Jun 2, 2025

Walkthrough

The "yargs-parser" version "22.0.0" entry was removed from the "overrides" section of the package.json file. No other dependencies or overrides were modified, and there were no changes to exported or public entities.

Changes

File(s) Change Summary
package.json Removed "yargs-parser" version "22.0.0" from "overrides" section

Suggested labels

chore, ready for review

Suggested reviewers

  • krusche

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
package.json (1)

1-207: Regenerate lockfile and update documentation
After removing an override, it’s best practice to regenerate your lockfile (npm install or yarn install) and clear any CI cache so pipelines pick up the change. Also consider adding a brief note to your CHANGELOG.md or project docs explaining why yargs-parser was removed.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d76e06 and a85fe9c.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • package.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Build and Push Docker Image / Build Docker Image for ls1intum/artemis
  • GitHub Check: Build and Push Docker Image / Build Docker Image for ls1intum/artemis
  • GitHub Check: Build .war artifact
  • GitHub Check: server-tests
  • GitHub Check: client-style
  • GitHub Check: server-style
  • GitHub Check: client-tests
  • GitHub Check: Analyse
🔇 Additional comments (1)
package.json (1)

87-116: Approve removal of yargs-parser override
The yargs-parser entry has been removed from the overrides section to resolve the ESM-only compatibility issue. Confirm that no parts of your codebase still reference yargs-parser and that the build now completes successfully without this override.

Run the following to catch any lingering references:

rg -n '"yargs-parser"'

@tobias-lippert tobias-lippert added ready for review client Pull requests that update TypeScript code. (Added Automatically!) labels Jun 2, 2025
Copy link

github-actions bot commented Jun 2, 2025

End-to-End (E2E) Test Results Summary

TestsPassed ☑️Skipped ⚠️Failed ❌️Time ⏱
End-to-End (E2E) Test Report201 ran197 passed3 skipped1 failed53m 47s 951ms
TestResultTime ⏱
End-to-End (E2E) Test Report
e2e/exercise/quiz-exercise/QuizExerciseParticipation.spec.ts
ts.Quiz Exercise Participation › DnD Quiz participation › Student can participate in DnD Quiz❌ failure2m 3s 558ms

Copy link
Contributor

@florian-glombik florian-glombik left a comment

Choose a reason for hiding this comment

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

E2E tests are pasing again and client starts locally again

@florian-glombik florian-glombik added this to the 8.1.4 milestone Jun 2, 2025
Copy link
Contributor

@jfr2102 jfr2102 left a comment

Choose a reason for hiding this comment

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

thanks 👍
build + e2e + client test are passing
I don't see any usages of it anyway

@tobias-lippert
Copy link
Contributor Author

In case you encounter issues locally, make sure to update your node version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) ready to merge
Projects
Status: Work In Progress
Development

Successfully merging this pull request may close these issues.

3 participants