Skip to content

eslint: properties starting with underscore are private #165259

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 4 commits into from
Closed

eslint: properties starting with underscore are private #165259

wants to merge 4 commits into from

Conversation

jrieken
Copy link
Member

@jrieken jrieken commented Nov 2, 2022

rules to check that properties starting with underscore are private

related to #165117

@jrieken jrieken marked this pull request as draft November 2, 2022 17:04
@jrieken jrieken self-assigned this Nov 2, 2022
mjbvz
mjbvz requested changes Nov 2, 2022
View reviewed changes
Copy link
Collaborator

@mjbvz mjbvz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I think we can use the naming-converations rule for this:

"@typescript-eslint/naming-convention": [
  "warn",
  {
	"selector": "default",
	"modifiers": ["public"],
	"format": null,
	"leadingUnderscore": "forbid"
  }
]

@jrieken jrieken mentioned this pull request Nov 3, 2022
Closed
@mjbvz
Copy link
Collaborator

mjbvz commented Nov 3, 2022 •
edited
Loading

Here's an updated eslint rule that forbids leading underscores on public and protected service properties:

"@typescript-eslint/naming-convention": [
	"warn",
{
	"selector": "default",
	"modifiers": [
		"public"
	],
	"format": null,
	"filter": "^_\\w+Service",
	"leadingUnderscore": "forbid"
},
{
	"selector": "default",
	"modifiers": [
		"protected"
	],
	"format": null,
	"filter": "^_\\w+Service",
	"leadingUnderscore": "forbid"
}
],

This identifies 91 errors in our codebase

@mjbvz mjbvz mentioned this pull request Nov 3, 2022
Closed
@jrieken
Copy link
Member Author

jrieken commented Nov 8, 2022

closing this - we have a different approach where we don't need this

@jrieken jrieken closed this Nov 8, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Dec 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mjbvz mjbvz mjbvz requested changes

Assignees

@jrieken jrieken

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jrieken @mjbvz