-
Notifications
You must be signed in to change notification settings - Fork 29.1k
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
tools: add a linter for README lists #52476
Merged
Merged
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
This file contains 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 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 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,48 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| // Validates the list in the README are in the correct order. | ||
|
|
||
| import { open } from 'node:fs/promises'; | ||
|
|
||
| const lists = [ | ||
| 'TSC voting members', | ||
| 'TSC regular members', | ||
| 'TSC emeriti members', | ||
| 'Collaborators', | ||
| 'Collaborator emeriti', | ||
| 'Triagers', | ||
| ]; | ||
| const tscMembers = new Set(); | ||
|
|
||
| const readme = await open(new URL('../README.md', import.meta.url), 'r'); | ||
|
|
||
| let currentList = null; | ||
| let previousGithubHandle; | ||
| let lineNumber = 0; | ||
|
|
||
| for await (const line of readme.readLines()) { | ||
| lineNumber++; | ||
| if (line.startsWith('### ')) { | ||
| currentList = lists[lists.indexOf(line.slice(4))]; | ||
| previousGithubHandle = null; | ||
| } else if (line.startsWith('#### ')) { | ||
| currentList = lists[lists.indexOf(line.slice(5))]; | ||
| previousGithubHandle = null; | ||
| } else if (currentList && line.startsWith('* [')) { | ||
| const currentGithubHandle = line.slice(3, line.indexOf(']')).toLowerCase(); | ||
| if (previousGithubHandle && previousGithubHandle >= currentGithubHandle) { | ||
| throw new Error(`${currentGithubHandle} should be listed before ${previousGithubHandle} in the ${currentList} list (README.md:${lineNumber})`); | ||
| } | ||
|
|
||
| if (currentList === 'TSC voting members' || currentList === 'TSC regular members') { | ||
| tscMembers.add(currentGithubHandle); | ||
| } else if (currentList === 'Collaborators') { | ||
| tscMembers.delete(currentGithubHandle); | ||
| } | ||
| previousGithubHandle = currentGithubHandle; | ||
| } | ||
| } | ||
|
|
||
| if (tscMembers.size !== 0) { | ||
| throw new Error(`Some TSC members are not listed as Collaborators: ${Array.from(tscMembers)}`); | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe rename this to
nonCollabatorTscMembers?