typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star16k

feat(eslint-plugin): [max-params] don't count`this: void` parameter#7696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

JoshuaKGoldberg merged 11 commits intotypescript-eslint:mainfromStyleShit:feature/max-params

Oct 17, 2023

Merged

feat(eslint-plugin): [max-params] don't count`this: void` parameter#7696

JoshuaKGoldberg merged 11 commits intotypescript-eslint:mainfromStyleShit:feature/max-params

Oct 17, 2023

Conversation

Copy link

Contributor

StyleShit commentedSep 27, 2023

Closes#7538

feat(eslint-plugin): [max-params] don't countthis: void parameter

d542963

Closestypescript-eslint#7538

Copy link

Contributor

typescript-eslintbot commentedSep 27, 2023

Thanks for the PR,@StyleShit!

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.

Copy link

netlifybot commentedSep 27, 2023•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`b69113a`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/652e90e056d41c00087fcaed
😎 Deploy Preview	https://deploy-preview-7696--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 96 (🟢 up 1 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to yourNetlify site configuration.

Copy link

nx-cloudbot commentedSep 27, 2023•
edited
Loading

☁️ Nx Cloud Report

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

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 19 targets

Sent with 💌 fromNxCloud.

hard-code schema

59f2f37

StyleShit commented

Sep 27, 2023

View reviewed changes

packages/eslint-plugin/src/rules/max-params.ts Outdated

Comment on lines 19 to 37

		const schema = [
		{
		type: 'object',
		properties: {
		maximum: {
		type: 'integer',
		minimum: 0,
		},
		max: {
		type: 'integer',
		minimum: 0,
		},
		countVoidThis: {
		type: 'boolean',
		},
		},
		additionalProperties: false,
		},
		] as JSONSchema4[];

Copy link

ContributorAuthor

StyleShitSep 27, 2023•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

for some reason, I can't getdeepMerge to work properly here.

I've tried adding these lines to add support for array overrides, but I'm not sure why it doesn't work:

 if (isObjectNotArray(firstValue) && isObjectNotArray(secondValue)) {   // object type   acc[key] = deepMerge(firstValue, secondValue);+ } else if (Array.isArray(firstValue)) {+   // array type+   acc[key] = Object.values(+     deepMerge({ ...firstValue }, { ...(secondValue as ObjectLike) }),+   );  } else {   // value type   acc[key] = secondValue; }

seems to work fine when isolated though:
https://tsplay.dev/wX1GLN

Anyway... I should've probably still hard-coded the values here since I don't support passing only a number like the base rule does (maybe I should?)

Base schema:
https://github.com/eslint/eslint/blob/main/lib/rules/max-params.js#L30-L53

Copy link

Member

JoshuaKGoldbergOct 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Extended rules generally directly go offcontext.options, is that what you're looking for?

typescript-eslint/packages/eslint-plugin/src/rules/brace-style.ts

Lines 30 to 32 inca1abb5

	const[style,{ allowSingleLine}={allowSingleLine:false}]=
	// eslint-disable-next-line no-restricted-syntax -- Use raw options for extended rules.
	context.options;

Copy link

ContributorAuthor

StyleShitOct 16, 2023•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Nope, I'm talking aboutbaseRule.meta.schema.
I had some issues when trying to add an option to the base schema, the deepMerge function seems to break it.
Is it OK to keep it hard-coded instead of extending the original schema in runtime?

typescript-eslint/packages/eslint-plugin/src/rules/brace-style.ts

Lines 25 to 27 inca1abb5

	hasSuggestions:baseRule.meta.hasSuggestions,
	schema:baseRule.meta.schema,
	},

Copy link

Member

JoshuaKGoldbergOct 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Ah got it - yeah this is fine. Base rules don't change often and many others already hard-code it (e.g.dot-notation). Thanks for asking!

StyleShit added3 commits

September 27, 2023 15:56

refactor

f9c5958

lint

23c4ce7

snapshot

f613530

StyleShit marked this pull request as ready for review

September 27, 2023 18:00

Merge branch 'main' into feature/max-params

1f82e3a

JoshuaKGoldberg requested changes

Oct 13, 2023

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Looks great to me! Nice and straightforward, I like it. 🙂

Left a couple of suggestions - what do you think?

packages/eslint-plugin/docs/rules/max-params.md OutdatedShow resolvedHide resolved

packages/eslint-plugin/src/rules/max-params.ts OutdatedShow resolvedHide resolved

packages/eslint-plugin/src/rules/max-params.ts Outdated

Comment on lines 19 to 37

		const schema = [
		{
		type: 'object',
		properties: {
		maximum: {
		type: 'integer',
		minimum: 0,
		},
		max: {
		type: 'integer',
		minimum: 0,
		},
		countVoidThis: {
		type: 'boolean',
		},
		},
		additionalProperties: false,
		},
		] as JSONSchema4[];

Copy link

Member

JoshuaKGoldbergOct 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Extended rules generally directly go offcontext.options, is that what you're looking for?

typescript-eslint/packages/eslint-plugin/src/rules/brace-style.ts

Lines 30 to 32 inca1abb5

	const[style,{ allowSingleLine}={allowSingleLine:false}]=
	// eslint-disable-next-line no-restricted-syntax -- Use raw options for extended rules.
	context.options;

JoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party label

Oct 13, 2023

StyleShit added3 commits

October 16, 2023 20:10

wip

9b258f7

Merge remote-tracking branch 'origin/feature/max-params' into feature…

ef0a019

…/max-params

Merge remote-tracking branch 'typescript-eslint/main' into feature/ma…

80b6fc1

…x-params

StyleShit requested a review fromJoshuaKGoldberg

October 16, 2023 17:14

github-actionsbot removed the awaiting responseIssues waiting for a reply from the OP or another party label

Oct 16, 2023

JoshuaKGoldberg reviewed

Oct 17, 2023

View reviewed changes

packages/eslint-plugin/src/rules/max-params.ts OutdatedShow resolvedHide resolved

packages/eslint-plugin/src/rules/max-params.ts Outdated

Comment on lines 19 to 37

		const schema = [
		{
		type: 'object',
		properties: {
		maximum: {
		type: 'integer',
		minimum: 0,
		},
		max: {
		type: 'integer',
		minimum: 0,
		},
		countVoidThis: {
		type: 'boolean',
		},
		},
		additionalProperties: false,
		},
		] as JSONSchema4[];

Copy link

Member

JoshuaKGoldbergOct 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Ah got it - yeah this is fine. Base rules don't change often and many others already hard-code it (e.g.dot-notation). Thanks for asking!

JoshuaKGoldberg previously approved these changes

Oct 17, 2023

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Looks great, thanks for iterating on this! Great work 🚀

Just a couple of small things that I can touch up before merging.

packages/eslint-plugin/src/rules/max-params.ts OutdatedShow resolvedHide resolved

Update packages/eslint-plugin/src/rules/max-params.ts

cfc6c29

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

StyleShit dismissedJoshuaKGoldberg’sstale review viacfc6c29

October 17, 2023 13:46

Small PR nits, don't mind me, it's great either way

b69113a

JoshuaKGoldberg merged commit6398d3f intotypescript-eslint:main

Oct 17, 2023

github-actionsbot locked asresolvedand limited conversation to collaborators

Oct 25, 2023

Labels

None yet

Movatterモバイル変換

Uh oh!

feat(eslint-plugin): [max-params] don't countthis: void parameter#7696

feat(eslint-plugin): [max-params] don't countthis: void parameter#7696

Uh oh!

Conversation

StyleShit commentedSep 27, 2023

Uh oh!

typescript-eslintbot commentedSep 27, 2023

Uh oh!

netlifybot commentedSep 27, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

✅ Deploy Preview fortypescript-eslint ready!

Uh oh!

nx-cloudbot commentedSep 27, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

StyleShitSep 27, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldbergOct 13, 2023

Choose a reason for hiding this comment

Uh oh!

StyleShitOct 16, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldbergOct 17, 2023

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JoshuaKGoldbergOct 13, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JoshuaKGoldbergOct 17, 2023

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat(eslint-plugin): [max-params] don't count`this: void` parameter#7696

feat(eslint-plugin): [max-params] don't count`this: void` parameter#7696

netlifybot commentedSep 27, 2023•
edited
Loading

nx-cloudbot commentedSep 27, 2023•
edited
Loading

StyleShitSep 27, 2023•
edited
Loading

StyleShitOct 16, 2023•
edited
Loading