docs(website): fix wrong example in `prefer-includes` #7036

Juneezee · 2023-05-17T14:13:54Z

PR Checklist

~~Addresses an existing open issue:~~ Is this necessary for a minor documentation change 🤔 ?
~~That issue was marked as accepting prs~~
Steps in Contributing were taken

Overview

readonlyArray.indexOf(value) === -1 is checking if value is not included in readonlyArray. So it should be
!readonlyArray.includes(value).

typescript-eslint/packages/eslint-plugin/tests/rules/prefer-includes.test.ts

Lines 153 to 179 in 5b0e577

    
               // negative 
        
               { 
        
                 code: ` 
        
                   function f(a: string): void { 
        
                     a.indexOf(b) === -1; 
        
                   } 
        
                 `, 
        
                 output: ` 
        
                   function f(a: string): void { 
        
                     !a.includes(b); 
        
                   } 
        
                 `, 
        
                 errors: [{ messageId: 'preferIncludes' }], 
        
               }, 
        
               { 
        
                 code: ` 
        
                   function f(a: string): void { 
        
                     a.indexOf(b) == -1; 
        
                   } 
        
                 `, 
        
                 output: ` 
        
                   function f(a: string): void { 
        
                     !a.includes(b); 
        
                   } 
        
                 `, 
        
                 errors: [{ messageId: 'preferIncludes' }], 
        
               },

typescript-eslint · 2023-05-17T14:13:56Z

Thanks for the PR, @Juneezee!

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.

netlify · 2023-05-17T14:14:01Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`df6e6e7`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6464e1aea3d36e00089d1fb1
😎 Deploy Preview	https://deploy-preview-7036--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.

`readonlyArray.indexOf(value) === -1` is checking if `value` is **not included** in `readonlyArray`. So it should be `!readonlyArray.includes(value)`. Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>

nx-cloud · 2023-05-17T14:34:15Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit df6e6e7. 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 25 targets

Sent with 💌 from NxCloud.

JoshuaKGoldberg

~~Addresses an existing open issue:~~ Is this necessary for a minor documentation change 🤔 ?

Nope, it's not - thanks for sending!

JoshuaKGoldberg · 2023-05-17T15:00:36Z

Amusingly, I think the typo could arguably be the other way - that we used === instead of !==. But this works too. And I think better shows the rule off.

Juneezee changed the title ~~docs(prefer-includes): fix wrong example~~ docs(website): fix wrong example in prefer-includes May 17, 2023

docs(website): fix wrong example in prefer-includes

df6e6e7

`readonlyArray.indexOf(value) === -1` is checking if `value` is **not included** in `readonlyArray`. So it should be `!readonlyArray.includes(value)`. Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>

JoshuaKGoldberg approved these changes May 17, 2023

View reviewed changes

JoshuaKGoldberg merged commit 8951732 into typescript-eslint:main May 17, 2023

github-actions bot locked as resolved and limited conversation to collaborators May 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs(website): fix wrong example in `prefer-includes` #7036

docs(website): fix wrong example in `prefer-includes` #7036

Uh oh!

Juneezee commented May 17, 2023

Uh oh!

typescript-eslint bot commented May 17, 2023

Uh oh!

netlify bot commented May 17, 2023 •

edited

Loading

Uh oh!

nx-cloud bot commented May 17, 2023 •

edited

Loading

Uh oh!

JoshuaKGoldberg left a comment

Uh oh!

JoshuaKGoldberg commented May 17, 2023

Uh oh!

Uh oh!

	// negative
	{
	code: `
	function f(a: string): void {
	a.indexOf(b) === -1;
	}
	`,
	output: `
	function f(a: string): void {
	!a.includes(b);
	}
	`,
	errors: [{ messageId: 'preferIncludes' }],
	},
	{
	code: `
	function f(a: string): void {
	a.indexOf(b) == -1;
	}
	`,
	output: `
	function f(a: string): void {
	!a.includes(b);
	}
	`,
	errors: [{ messageId: 'preferIncludes' }],
	},

Uh oh!

docs(website): fix wrong example in prefer-includes #7036

docs(website): fix wrong example in prefer-includes #7036

Uh oh!

Conversation

Juneezee commented May 17, 2023

PR Checklist

Overview

Uh oh!

typescript-eslint bot commented May 17, 2023

Uh oh!

netlify bot commented May 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

nx-cloud bot commented May 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg commented May 17, 2023

Uh oh!

Uh oh!

docs(website): fix wrong example in `prefer-includes` #7036

docs(website): fix wrong example in `prefer-includes` #7036

netlify bot commented May 17, 2023 •

edited

Loading

nx-cloud bot commented May 17, 2023 •

edited

Loading