Skip to content

build: add custom linting for symbol names #19811

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

Merged
merged 1 commit into from
Jul 1, 2020

Conversation

crisbeto
Copy link
Member

As discussed, we want to prefix some exported class names with an underscore so it's more obvious that they're private. The problem is that our current class naming rule doesn't allow for a class to start with an underscore. These changes add a custom rule that can use a regex to validate the class name. Having our own rule allows us to validate more types of nodes as well (e.g. type nodes which tslint doesn't check).

As discussed, we want to prefix some exported class names with an underscore so it's more obvious that they're private. The problem is that our current class naming rule doesn't allow for a class to start with an underscore. These changes add a custom rule that can use a regex to validate the class name. Having our own rule allows us to validate more types of nodes as well (e.g. `type` nodes which tslint doesn't check).
@crisbeto crisbeto added P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent merge safe target: patch This PR is targeted for the next patch release labels Jun 30, 2020
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Jun 30, 2020
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

@jelbourn jelbourn added lgtm action: merge The PR is ready for merge by the caretaker labels Jun 30, 2020
Copy link
Member

@devversion devversion left a comment

Choose a reason for hiding this comment

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

Nice. This was always quite annoying

@jelbourn jelbourn merged commit cdfec07 into angular:master Jul 1, 2020
jelbourn pushed a commit that referenced this pull request Jul 1, 2020
As discussed, we want to prefix some exported class names with an underscore so it's more obvious that they're private. The problem is that our current class naming rule doesn't allow for a class to start with an underscore. These changes add a custom rule that can use a regex to validate the class name. Having our own rule allows us to validate more types of nodes as well (e.g. `type` nodes which tslint doesn't check).
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Aug 1, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants