fix(eslint-plugin): [ban-ts-comment] counts graphemes instead of `String.prototype.length` #5704

sosukesuzuki · 2022-10-01T05:47:14Z

PR Checklist

Addresses an existing open issue: fixes Bug: [ts-ban-comment] doesn't report error for a description includes with multiple code units #5678
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

Counts graphemes instead of String.prototype.length (code units).

FYI ESLint id-length rule has been fixed for similar bug: eslint/eslint#16321

typescript-eslint · 2022-10-01T05:47:15Z

Thanks for the PR, @sosukesuzuki!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

nx-cloud · 2022-10-01T05:47:16Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit f17c78f. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 from NxCloud.

netlify · 2022-10-01T05:47:32Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`f17c78f`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/63d05ed449544c0009033f09
😎 Deploy Preview	https://deploy-preview-5704--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

JoshuaKGoldberg

Great, thanks for sending this in so quickly! Just asking for another test case.

packages/eslint-plugin/src/rules/ban-ts-comment.ts

packages/eslint-plugin/tests/rules/ban-ts-comment.test.ts

yarn.lock

codecov · 2022-10-01T06:07:40Z

Codecov Report

Merging #5704 (814b429) into main (47074b0) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 814b429 differs from pull request most recent head f17c78f. Consider uploading reports for the commit f17c78f to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5704   +/-   ##
=======================================
  Coverage   91.27%   91.27%           
=======================================
  Files         366      366           
  Lines       12447    12453    +6     
  Branches     3646     3648    +2     
=======================================
+ Hits        11361    11367    +6     
  Misses        772      772           
  Partials      314      314

Flag	Coverage Δ
unittest	`91.27% <100.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/eslint-plugin/src/rules/ban-ts-comment.ts	`97.43% <100.00%> (+0.46%)`	⬆️

Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>

JoshuaKGoldberg

Super, thanks @sosukesuzuki!

packages/eslint-plugin/package.json

bradzacher

rc for above comment

JoshuaKGoldberg · 2022-11-16T15:04:49Z

👋 Hey @sosukesuzuki! Just checking in, is this still something you have time for? No worries if not - I just don't want to leave it hanging.

JoshuaKGoldberg · 2023-01-24T22:35:10Z

Chatted with @bradzacher - full dependency for grapheme-splitter should be the way to go. !

JoshuaKGoldberg

🚢

I did the thing

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.48.2` -> `5.50.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.48.2/5.50.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.48.2` -> `5.50.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.48.2/5.50.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.50.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5500-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5490v5500-2023-01-31) [Compare Source](typescript-eslint/typescript-eslint@v5.49.0...v5.50.0) ##### Bug Fixes - **eslint-plugin:** \[ban-ts-comment] counts graphemes instead of `String.prototype.length` ([#5704](typescript-eslint/typescript-eslint#5704)) ([09d57ce](typescript-eslint/typescript-eslint@09d57ce)) - **eslint-plugin:** \[prefer-optional-chain] fix `ThisExpression` and `PrivateIdentifier` errors ([#6028](typescript-eslint/typescript-eslint#6028)) ([85e783c](typescript-eslint/typescript-eslint@85e783c)) - **eslint-plugin:** \[prefer-optional-chain] fixer produces wrong logic ([#5919](typescript-eslint/typescript-eslint#5919)) ([b0f6c8e](typescript-eslint/typescript-eslint@b0f6c8e)), closes [#1438](typescript-eslint/typescript-eslint#1438) ##### Features - **eslint-plugin:** add `key-spacing` rule extension for interface & type declarations ([#6211](typescript-eslint/typescript-eslint#6211)) ([67706e7](typescript-eslint/typescript-eslint@67706e7)) ### [`v5.49.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5490-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5482v5490-2023-01-23) [Compare Source](typescript-eslint/typescript-eslint@v5.48.2...v5.49.0) ##### Features - **eslint-plugin:** \[naming-convention] add support for `#private` modifier on class members ([#6259](typescript-eslint/typescript-eslint#6259)) ([c8a6d80](typescript-eslint/typescript-eslint@c8a6d80)) #### [5.48.2](typescript-eslint/typescript-eslint@v5.48.1...v5.48.2) (2023-01-16) **Note:** Version bump only for package [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin) #### [5.48.1](typescript-eslint/typescript-eslint@v5.48.0...v5.48.1) (2023-01-09) **Note:** Version bump only for package [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.50.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5500-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5490v5500-2023-01-31) [Compare Source](typescript-eslint/typescript-eslint@v5.49.0...v5.50.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) ### [`v5.49.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5490-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5482v5490-2023-01-23) [Compare Source](typescript-eslint/typescript-eslint@v5.48.2...v5.49.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.48.2](typescript-eslint/typescript-eslint@v5.48.1...v5.48.2) (2023-01-16) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.48.1](typescript-eslint/typescript-eslint@v5.48.0...v5.48.1) (2023-01-09) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1757 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

fix: counts graphemes instead of String length

d0b2ecd

JoshuaKGoldberg requested changes Oct 1, 2022

View reviewed changes

packages/eslint-plugin/src/rules/ban-ts-comment.ts Outdated Show resolved Hide resolved

packages/eslint-plugin/tests/rules/ban-ts-comment.test.ts Show resolved Hide resolved

JoshuaKGoldberg reviewed Oct 1, 2022

View reviewed changes

yarn.lock Show resolved Hide resolved

sosukesuzuki and others added 2 commits October 2, 2022 16:59

Update packages/eslint-plugin/src/rules/ban-ts-comment.ts

4654850

Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>

chore: add valid tests

3d53073

JoshuaKGoldberg previously approved these changes Oct 4, 2022

View reviewed changes

Merge branch 'main' into fix-5678

4328f83

JoshuaKGoldberg enabled auto-merge (squash) October 4, 2022 06:48

JoshuaKGoldberg changed the title ~~fix: ban-ts-comment counts graphemes instead of String.prototype.length~~ fix(eslint-plugin): ban-ts-comment counts graphemes instead of String.prototype.length Oct 4, 2022

bradzacher reviewed Oct 4, 2022

View reviewed changes

packages/eslint-plugin/package.json Show resolved Hide resolved

bradzacher previously requested changes Oct 4, 2022

View reviewed changes

bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Oct 4, 2022

Merge branch 'main'

788464e

JoshuaKGoldberg dismissed their stale review via 788464e December 18, 2022 23:03

JoshuaKGoldberg changed the title ~~fix(eslint-plugin): ban-ts-comment counts graphemes instead of String.prototype.length~~ fix(eslint-plugin): [ban-ts-comment] counts graphemes instead of String.prototype.length Dec 19, 2022

Add grapheme-splitter to peerDependencies

64122ed

JoshuaKGoldberg marked this pull request as draft December 19, 2022 02:11

auto-merge was automatically disabled December 19, 2022 02:11
Pull request was converted to draft

Move to standard dependency

47a3e78

JoshuaKGoldberg marked this pull request as ready for review December 20, 2022 00:02

JoshuaKGoldberg requested a review from bradzacher December 21, 2022 01:07

JoshuaKGoldberg added 2 commits January 24, 2023 17:36

Merge branch 'main' into fix-5678

814b429

No more peerDependency

f17c78f

JoshuaKGoldberg approved these changes Jan 24, 2023

View reviewed changes

JoshuaKGoldberg merged commit 09d57ce into typescript-eslint:main Jan 24, 2023

sosukesuzuki deleted the fix-5678 branch January 27, 2023 16:49

github-actions bot locked as resolved and limited conversation to collaborators Feb 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [ban-ts-comment] counts graphemes instead of `String.prototype.length` #5704

fix(eslint-plugin): [ban-ts-comment] counts graphemes instead of `String.prototype.length` #5704

sosukesuzuki commented Oct 1, 2022

typescript-eslint bot commented Oct 1, 2022

nx-cloud bot commented Oct 1, 2022 •

edited

Loading

netlify bot commented Oct 1, 2022 •

edited

Loading

JoshuaKGoldberg left a comment

codecov bot commented Oct 1, 2022 •

edited

Loading

JoshuaKGoldberg left a comment

bradzacher left a comment

JoshuaKGoldberg commented Nov 16, 2022

JoshuaKGoldberg commented Jan 24, 2023

JoshuaKGoldberg left a comment

fix(eslint-plugin): [ban-ts-comment] counts graphemes instead of String.prototype.length #5704

fix(eslint-plugin): [ban-ts-comment] counts graphemes instead of String.prototype.length #5704

Conversation

sosukesuzuki commented Oct 1, 2022

PR Checklist

Overview

typescript-eslint bot commented Oct 1, 2022

nx-cloud bot commented Oct 1, 2022 • edited Loading

☁️ Nx Cloud Report

netlify bot commented Oct 1, 2022 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 1, 2022 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

bradzacher left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg commented Nov 16, 2022

JoshuaKGoldberg commented Jan 24, 2023

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

fix(eslint-plugin): [ban-ts-comment] counts graphemes instead of `String.prototype.length` #5704

fix(eslint-plugin): [ban-ts-comment] counts graphemes instead of `String.prototype.length` #5704

nx-cloud bot commented Oct 1, 2022 •

edited

Loading

netlify bot commented Oct 1, 2022 •

edited

Loading

codecov bot commented Oct 1, 2022 •

edited

Loading