FuelLabs/sway

Warn users if they create a package in a workspace without listing them as a member

Open

#4,451 创建于 2023年4月17日

在 GitHub 查看
 (4 评论) (0 反应) (1 负责人)Rust (61,702 star) (5,421 fork)batch import
ODHack13enhancementforcforc-pkggood first issuemay be rewarded

描述

cargo warns users with a warning if they create a package inside a workspace directory like the following:

warning: compiling this new package may not work due to invalid workspace configuration

current package believes it's in a workspace when it's not:
current:   /Users/kayagokalp/fuel/dev/sway/forc-error/Cargo.toml
workspace: /Users/kayagokalp/fuel/dev/sway/Cargo.toml

We might want to do something similar. In our case a child package wouldn't be "thinking" it's in a workspace but it is still pretty easy to forget listing a package in the workspace manifest file.

贡献者指南

技术栈
rust
领域
toolingdeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic Rust knowledgeunderstanding of workspace structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
Investigate how cargo generates warnings for packages not listed in workspace members (e.g., the warning message about invalid workspace configuration). Then, locate the workspace handling code in sway, likely in sway core or similar crates. Add a similar warning when a new package is created inside a workspace directory but not included in the [workspace] members in the root Cargo.toml. Follow the existing warning patterns and ensure compatibility with the workspace manifest parsing.