-
Notifications
You must be signed in to change notification settings - Fork 710
Require ECMAScript private class members #5945
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Bharat Middha (bmiddha)
wants to merge
3
commits into
main
Choose a base branch
from
bmiddha/enforce-native-private-fields
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
9 changes: 9 additions & 0 deletions
9
common/changes/@rushstack/eslint-config/native-private-fields_2026-08-18-12-00-00.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "changes": [ | ||
| { | ||
| "packageName": "@rushstack/eslint-config", | ||
| "comment": "Enable the rule that prefers ECMAScript private class members.", | ||
| "type": "minor" | ||
| } | ||
| ] | ||
| } |
9 changes: 9 additions & 0 deletions
9
common/changes/@rushstack/eslint-plugin/native-private-fields_2026-08-18-12-00-00.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "changes": [ | ||
| { | ||
| "packageName": "@rushstack/eslint-plugin", | ||
| "comment": "Add a rule that requires ECMAScript private syntax for class fields, methods, and accessors.", | ||
| "type": "minor" | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
44 changes: 44 additions & 0 deletions
44
eslint/eslint-plugin/src/prefer-ecmascript-private-members.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. | ||
| // See LICENSE in the project root for license information. | ||
|
|
||
| import type { TSESLint, TSESTree } from '@typescript-eslint/utils'; | ||
|
|
||
| type MessageIds = 'use-ecmascript-private-member'; | ||
| type Options = []; | ||
|
|
||
| const preferEcmascriptPrivateMembersRule: TSESLint.RuleModule<MessageIds, Options> = { | ||
| defaultOptions: [], | ||
| meta: { | ||
| type: 'suggestion', | ||
| messages: { | ||
| 'use-ecmascript-private-member': | ||
| 'Use ECMAScript private syntax ("#member") instead of the TypeScript "private" modifier.' | ||
| }, | ||
| schema: [], | ||
| docs: { | ||
| description: 'Require ECMAScript private syntax for private class fields, methods, and accessors', | ||
| recommended: 'recommended', | ||
| url: 'https://www.npmjs.com/package/@rushstack/eslint-plugin' | ||
| } as TSESLint.RuleMetaDataDocs | ||
| }, | ||
| create: (context: TSESLint.RuleContext<MessageIds, Options>) => ({ | ||
| PropertyDefinition(node: TSESTree.PropertyDefinition): void { | ||
| if (node.accessibility === 'private') { | ||
| context.report({ | ||
| node, | ||
| messageId: 'use-ecmascript-private-member' | ||
| }); | ||
| } | ||
| }, | ||
| MethodDefinition(node: TSESTree.MethodDefinition): void { | ||
| if (node.accessibility === 'private' && node.kind !== 'constructor') { | ||
| context.report({ | ||
| node, | ||
| messageId: 'use-ecmascript-private-member' | ||
| }); | ||
| } | ||
| } | ||
| }) | ||
| }; | ||
|
|
||
| export { preferEcmascriptPrivateMembersRule }; |
80 changes: 80 additions & 0 deletions
80
eslint/eslint-plugin/src/test/prefer-ecmascript-private-members.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. | ||
| // See LICENSE in the project root for license information. | ||
|
|
||
| import type { RuleTester } from '@typescript-eslint/rule-tester'; | ||
|
|
||
| import { preferEcmascriptPrivateMembersRule } from '../prefer-ecmascript-private-members'; | ||
| import { getRuleTesterWithoutProject } from './ruleTester'; | ||
|
|
||
| const ruleTester: RuleTester = getRuleTesterWithoutProject(); | ||
|
|
||
| ruleTester.run('prefer-ecmascript-private-members', preferEcmascriptPrivateMembersRule, { | ||
| invalid: [ | ||
| { | ||
| code: 'class Example { private value: string = ""; }', | ||
| errors: [{ messageId: 'use-ecmascript-private-member' }] | ||
| }, | ||
| { | ||
| code: 'class Example { private static readonly values: Set<string> = new Set(); }', | ||
| errors: [{ messageId: 'use-ecmascript-private-member' }] | ||
| }, | ||
| { | ||
| code: 'class Example { private optional?: string; private assigned!: string; }', | ||
| errors: [ | ||
| { messageId: 'use-ecmascript-private-member' }, | ||
| { messageId: 'use-ecmascript-private-member' } | ||
| ] | ||
| }, | ||
| { | ||
| code: 'class Example { declare private value: string; }', | ||
| errors: [{ messageId: 'use-ecmascript-private-member' }] | ||
| }, | ||
| { | ||
| code: 'class Example { private ["value"]: string = ""; }', | ||
| errors: [{ messageId: 'use-ecmascript-private-member' }] | ||
| }, | ||
| { | ||
| code: 'class Example { private calculate(): number { return 1; } }', | ||
| errors: [{ messageId: 'use-ecmascript-private-member' }] | ||
| }, | ||
| { | ||
| code: [ | ||
| 'class Example {', | ||
| ' private get value(): string { return ""; }', | ||
| ' private set value(value: string) {}', | ||
| '}' | ||
| ].join('\n'), | ||
| errors: [ | ||
| { messageId: 'use-ecmascript-private-member' }, | ||
| { messageId: 'use-ecmascript-private-member' } | ||
| ] | ||
| } | ||
| ], | ||
| valid: [ | ||
| { | ||
| code: 'class Example { #value: string = ""; static #values: Set<string> = new Set(); }' | ||
| }, | ||
| { | ||
| code: [ | ||
| 'class Example {', | ||
| ' #calculate(): number { return 1; }', | ||
| ' get #value(): string { return ""; }', | ||
| ' set #value(value: string) {}', | ||
| '}' | ||
| ].join('\n') | ||
| }, | ||
| { | ||
| code: 'class Example { public value: string = ""; protected otherValue: string = ""; }' | ||
| }, | ||
| { | ||
| code: [ | ||
| 'class Example {', | ||
| ' public constructor(private readonly parameter: string) {}', | ||
| '}' | ||
| ].join('\n') | ||
| }, | ||
| { | ||
| code: 'class Example { private constructor() {} }' | ||
| } | ||
| ] | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.