@typescript-eslint/ban-tslint-comment

[ScriptedAlchemy]

Summary

Implements the @typescript-eslint/ban-tslint-comment rule to disallow TSLint directive comments (e.g., // tslint:disable). This helps clean up codebases migrating from TSLint by removing unused directives.

Related Links

• Docs: https://typescript-eslint.io/rules/ban-tslint-comment
• Source: https://github.com/typescript-eslint/typescript-eslint/blob/v8.48.1/packages/eslint-plugin/src/rules/ban-tslint-comment.ts

Checklist

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

---

 

Made with Cursor

[gemini-code-assist]

Summary of Changes

Hello @ScriptedAlchemy, 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 a new linting rule, @typescript-eslint/ban-tslint-comment, designed to identify and remove TSLint directive comments from the codebase. This is particularly useful for projects transitioning from TSLint to ESLint or other linting solutions, ensuring that deprecated directives do not clutter the code or cause confusion. The rule includes automatic fix capabilities to streamline the cleanup process.

Highlights

• New Rule Implementation: The @typescript-eslint/ban-tslint-comment rule has been implemented to disallow TSLint directive comments.
• Codebase Cleanup: This rule helps in cleaning up codebases that are migrating from TSLint by identifying and removing obsolete TSLint directives.
• Automatic Fixes: The new rule includes automatic fix capabilities to streamline the removal of TSLint comments.

Changelog

• internal/config/config.go
  • Imported and registered the new ban_tslint_comment rule within the TypeScript ESLint plugin configuration.
• internal/plugins/typescript/rules/ban_tslint_comment/ban_tslint_comment.go
  • Added the core implementation for the ban-tslint-comment rule.
  • Includes logic to detect TSLint directive comments using regular expressions, extract their values, and provide a fix to remove them.
• internal/plugins/typescript/rules/ban_tslint_comment/ban_tslint_comment.md
  • Added comprehensive documentation for the new rule, detailing its purpose, how it works, and providing examples of both incorrect and correct code.
• internal/plugins/typescript/rules/ban_tslint_comment/ban_tslint_comment_test.go
  • Introduced unit tests for the ban-tslint-comment rule.
  • Verifies the rule's ability to correctly identify and auto-fix various forms of TSLint directive comments.
• packages/rslint-test-tools/rstest.config.mts
  • Enabled the test suite for the ban-tslint-comment rule by uncommenting its entry in the configuration.
• packages/rslint-test-tools/tests/typescript-eslint/rules/snapshots/ban-tslint-comment.test.ts.snap
  • Added snapshot test results for the ban-tslint-comment rule, capturing the expected diagnostic output for different invalid code scenarios.

Activity

• The pull request was created by ScriptedAlchemy.
• Initial changes were pushed to implement the ban-tslint-comment rule, including its core logic, documentation, and tests.
• The test configuration was updated to include the new rule's tests.

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

The implementation of the @typescript-eslint/ban-tslint-comment rule is a solid addition for cleaning up legacy TSLint directives. The core logic for detecting and reporting these comments is correct and follows the existing patterns in the repository. However, the buildFixRange function has some logic issues regarding how it calculates the range for removal, particularly for trailing comments and indentation, which could lead to unintended code merging or messy formatting.

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4cde30d2e4

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[Copilot]

Pull request overview

Adds support for the @typescript-eslint/ban-tslint-comment rule in rslint to detect and auto-fix legacy TSLint directive comments (e.g. // tslint:disable*) during TSLint→ESLint migrations.

Changes:

• Implement new TypeScript rule ban-tslint-comment with autofix support.
• Register the rule in the global rule registry and add Go rule-tester coverage.
• Enable the ported typescript-eslint test and add/update its rstest snapshot.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/rslint-test-tools/tests/typescript-eslint/rules/snapshots/ban-tslint-comment.test.ts.snap	Adds snapshot expectations for the ported ban-tslint-comment rule test.
packages/rslint-test-tools/rstest.config.mts	Enables the ban-tslint-comment test suite in rstest includes.
internal/plugins/typescript/rules/ban_tslint_comment/ban_tslint_comment_test.go	Adds Go rule-tester cases for valid/invalid directive comment detection + fixes.
internal/plugins/typescript/rules/ban_tslint_comment/ban_tslint_comment.md	Documents the new rule and provides examples.
internal/plugins/typescript/rules/ban_tslint_comment/ban_tslint_comment.go	Implements detection + fix logic for TSLint directive comments.
internal/config/config.go	Registers @typescript-eslint/ban-tslint-comment in the TypeScript plugin rule registry.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.