Add --max-redirection option to fedify webfinger command

[w8385]

Summary

Add --max-redirection option to fedify webfinger command.

Related Issue

• closes Add --max-redirection option to fedify webfinger command #311

Changes

• cli/webfinger.ts
  • Added new option --max-redirection
  • Validates max redirection value by Cliffy
    • built-in type integer validates it is integer.
    • utilized ValidationError when it is negative integer.
• docs/cli.md
  • Reflects changes above

Benefits

• Users can configure the maximum number of redirections by CLI command.
• For these expected invalid values, provide error messages below.

  • Error when type of value is not integer, handle by Cliffy's built-in type integer validation.

    fedify webfinger @[email protected] --max-redirection 0.1
    > ...
    > showHelp
    > ...
    > error: Option "--max-redirection" must be of type "integer", but got "0.1".
    

  • Error when value is negative integer, handle by utilized Cliffy's ValidationError.

    fedify webfinger @[email protected] --max-redirection -1
    > ...
    > showHelp
    > ...
    > error: Option "--max-redirection" must be a non-negative integer, but got "-1".
    

Checklist

• Did you add a changelog entry to the CHANGES.md?
• Did you write some relevant docs about this change (if it's a new feature)?
• Did you write a regression test to reproduce the bug (if it's a bug fix)?
• Did you write some tests for this change (if it's a new feature)?
• Did you run deno task test-all on your machine?

[gemini-code-assist]

Summary of Changes

Hello @w8385, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the fedify webfinger command by introducing a new option that gives users explicit control over the maximum number of HTTP redirections followed during WebFinger lookups. This improves the command's flexibility and provides better error feedback for invalid inputs.

Highlights

• New CLI Option: I've added a new --max-redirection option to the fedify webfinger command. This allows users to specify the maximum number of HTTP redirections to follow during WebFinger lookups, with a default value of 5.
• Input Validation and Error Handling: I've implemented validation for the --max-redirection value, ensuring it's a non-negative integer. A new InvalidMaxRedirectionError class has been introduced to provide clear and specific error messages when an invalid value is supplied.
• Documentation Update: The docs/cli.md file has been updated to include comprehensive documentation for the new --max-redirection option, complete with usage examples demonstrating how to set custom limits or disable redirections entirely.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a --max-redirection option to the fedify webfinger command, allowing users to control the number of followed redirects. The changes include adding the command-line option, validating its value, and updating the documentation. The implementation is solid and follows existing patterns in the codebase. I have one minor suggestion to improve code clarity by removing a redundant return statement.

[github-actions]

The docs for this pull request have been published:

https://a9246115.fedify.pages.dev

[github-actions]

The latest push to this pull request has been published to JSR and npm as a pre-release:

Package	Version	JSR	npm
@fedify/fedify	1.8.1-pr.328.1165+9356087c	JSR	npm
@fedify/cli	1.8.1-pr.328.1165+9356087c	JSR
@fedify/amqp	1.8.1-pr.328.1165+9356087c	JSR	npm
@fedify/express	1.8.1-pr.328.1165+9356087c	JSR	npm
@fedify/h3	1.8.1-pr.328.1165+9356087c	JSR	npm
@fedify/nestjs	1.8.1-pr.328.1165+9356087c		npm
@fedify/postgres	1.8.1-pr.328.1165+9356087c	JSR	npm
@fedify/redis	1.8.1-pr.328.1165+9356087c	JSR	npm
@fedify/testing	1.8.1-pr.328.1165+9356087c	JSR	npm