Skip to content

Bug: [ts-ban-comment] doesn't report error for a description includes with multiple code units #5678

Closed
@sosukesuzuki

Description

@sosukesuzuki

Before You File a Bug Report Please Confirm You Have Done The Following...

  • I have tried restarting my IDE and the issue persists.
  • I have updated to the latest version of the packages.
  • I have searched for related issues and found none that matched my issue.
  • I have read the FAQ and my problem is not listed.

Playground Link

https://typescript-eslint.io/play/#ts=4.8.3&sourceType=module&code=PQKgpgzgNglgdgFwAQAEEE8AOkDGAnGTBAWklkWACMBDOYhCYnAewFtWxEAuJAbQCIwePMzz8AuiGAAoacGCoGpAB7YcJISLxJAvBuALHcCwBDsCWO0cDmO0cBmO9IBmzZgDoaeaUA&eslintrc=N4KABGBEBOCuA2BTAzpAXGYBfEWg&tsconfig=N4KABGBEDGD2C2AHAlgGwKYCcDyiAuysAdgM6QBcYoEEkJemy0eAcgK6qoDCAFutAGsylBm3TgwAXxCSgA

Repro Code

/*eslint @typescript-eslint/ban-ts-comment: ["error"]*/

// @ts-expect-error 👨‍👩‍👧‍👦
foo.bar

ESLint Config

// See a comment in Repro Code

module.exports = {
  "rules": {}
}

tsconfig

{
  "compilerOptions": {
    "strictNullChecks": true
  }
}

Expected Result

Report an error because description length is actually 1.

Actual Result

Does not report any errors.

Additional Info

String.prototype.length isn't not enough for this rule. We should to consider to use third party package like https://github.com/orling/grapheme-splitter .

"👨‍👩‍👧‍👦".length; // 11

Versions

package version
@typescript-eslint/eslint-plugin 5.38.0
@typescript-eslint/parser 5.38.0
TypeScript 4.8.3
ESLint 8.15.0
node web

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuebugSomething isn't workinggood first issueGood for newcomerspackage: eslint-pluginIssues related to @typescript-eslint/eslint-plugin

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions