feat: port rule no-unsafe-finally

[fansenze]

Summary

Port the no-unsafe-finally rule from ESLint to rslint.

Disallow control flow statements in finally blocks

Related Links

• Tracking issue: [Tracking]: eslint core rules #223

• ESLint rule: https://eslint.org/docs/latest/rules/no-unsafe-finally

Checklist

• Tests updated (or not required).
• Documentation updated (or not required).

[gemini-code-assist]

Summary of Changes

Hello, 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 introduces the no-unsafe-finally linting rule, ported from ESLint, to enhance code reliability and predictability. The rule identifies and disallows control flow statements such as return, throw, break, and continue when they appear directly within finally blocks. This prevents unexpected behavior where finally block logic could inadvertently override the intended control flow from try or catch blocks, making code easier to reason about and maintain.

Highlights

• New Linting Rule Implemented: The no-unsafe-finally rule has been ported from ESLint and implemented, disallowing control flow statements (return, throw, break, continue) directly within finally blocks.
• Robust Control Flow Analysis: The rule includes sophisticated logic to differentiate between unsafe control flow statements directly in finally blocks and safe usage within nested functions, loops, or labeled statements inside finally.
• Comprehensive Documentation and Testing: Detailed documentation for the rule has been added, along with extensive unit tests and snapshot tests to cover various valid and invalid code scenarios, ensuring accuracy and reliability.

Changelog

• internal/config/config.go
  • Imported the no_unsafe_finally package.
  • Registered the no-unsafe-finally rule in the global rule registry.
• internal/rules/no_unsafe_finally/no_unsafe_finally.go
  • Added the core implementation for the no-unsafe-finally rule, including helper functions to determine AST node boundaries and check if a control flow statement is unsafely within a finally block.
• internal/rules/no_unsafe_finally/no_unsafe_finally.md
  • Created documentation for the no-unsafe-finally rule, detailing its purpose, incorrect examples, and correct examples.
• internal/rules/no_unsafe_finally/no_unsafe_finally_test.go
  • Added unit tests for the no-unsafe-finally rule, covering various valid and invalid code patterns.
• packages/rslint-test-tools/rstest.config.mts
  • Updated the test configuration to include the new no-unsafe-finally rule's tests.
• packages/rslint-test-tools/tests/eslint/rules/snapshots/no-unsafe-finally.test.ts.snap
  • Generated snapshot tests for the no-unsafe-finally rule's diagnostics.
• packages/rslint-test-tools/tests/eslint/rules/no-unsafe-finally.test.ts
  • Added the rule tester setup for no-unsafe-finally with basic valid and invalid cases.

Activity

• The author has confirmed that tests have been updated.
• The author has confirmed that documentation has been updated.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

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 ports the no-unsafe-finally ESLint rule to rslint. The implementation is solid and includes comprehensive tests and documentation. I've made a couple of suggestions: one to improve the user-facing diagnostic messages to be more specific, and another to remove a duplicate test file entry in the configuration. Overall, this is a great contribution.