Change forc doc --manifest-path to forc doc --path

[alexanderblv]

Description

Closes #5789

Checklist

• I have linked to any relevant issues.
• I have commented my code, particularly in hard-to-understand areas.
• I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • If my change requires substantial documentation changes, I have requested support from the DevRel team
• I have added tests that prove my fix is effective or that my feature works.
• I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
• I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
• I have requested a review from the relevant team or maintainers.

[CLAassistant]

All committers have signed the CLA.

[kayagokalp]

Hello, thanks for the PR. It seems like you just updated docs and readme, not the command itself.

sway/forc-plugins/forc-doc/src/cli.rs

Line 26 in 24d03f4

pub manifest_path: Option<String>,

[alexanderblv]

Hello, thanks for the PR. It seems like you just updated docs and readme, not the command itself.

sway/forc-plugins/forc-doc/src/cli.rs

Line 26 in 24d03f4

pub manifest_path: Option<String>,

I understand correctly that I have to update manifest_path in all sway files?

[sdankel]

I would prefer to make --path a shorthand for --manifest-path (keeping both as valid CLI flags) so as not to break any existing users.

[alexanderblv]

I would prefer to make --path a shorthand for --manifest-path (keeping both as valid CLI flags) so as not to break any existing users.

So you want to keep both run as valid?
run: forc doc --manifest-path ./sway-lib-std
run: forc doc --path ./sway-lib-std

I'm not sure if the duplicates will lead to good code performance, but if you think so, then I'll do it.

[sdankel]

I would prefer to make --path a shorthand for --manifest-path (keeping both as valid CLI flags) so as not to break any existing users.

So you want to keep both run as valid? run: forc doc --manifest-path ./sway-lib-std run: forc doc --path ./sway-lib-std

I'm not sure if the duplicates will lead to good code performance, but if you think so, then I'll do it.

It shouldn't affect the code performance at all. You can use clap's alias:

    #[clap(long, alias="manifest-path")]
    pub path: Option<String>,

Please fix the compilation errors. You need to update manifest_path in the other places it is used.

[kayagokalp]

Current ci.yml file is invalid, I suggested the correct version of it. But also I think we should not test whole sdk-harness twice just to see that a flag is working with different alias to preserve some valuable CI time. Let's keep the addition to the code to support it for users but remove it from ci. I think @sdankel originally wanted you to add the support to the code not to CI but pinging her in any case.

[kayagokalp]

We can probably use @sdankel's suggestion here:

Suggested change

	#[clap(long)]
	pub manifest_path: Option<String>,
	pub path: Option<String>,
	#[clap(long, alias="manifest-path")]
	pub path: Option<String>,

[sdankel]

I absolutely agree with @kayagokalp , we should not run forc-doc twice in CI. This code still doesn't compile, so I'm going to close this PR. This isn't really close to what we're looking for and I want to leave the opportunity for another contributor to pick up this task.