feat(lint): enforce single-word Multigres component names - #69
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
GuptaManan100
marked this pull request as ready for review
July 4, 2026 09:37
Multigateway, Multipooler, Multiorch, Multiadmin (and Multigres itself) are single words — only the leading M is capitalized. Content, the homepage, and the architecture diagram SVGs had camel-cased forms like MultiPooler/MultiGateway; rename them all to the single-word forms. Add tools/naming_linter.sh (a git grep for the forbidden PascalCase and camelCase forms), a lint:naming npm script, and a Naming Lint CI job so the inconsistency can't creep back in. Signed-off-by: GuptaManan100 <guptamanan100@gmail.com>
GuptaManan100
force-pushed
the
fix-linting
branch
from
July 4, 2026 09:39
b7e2088 to
094186a
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
MultiPooler,MultiOrch,MultiGateway,MultiAdmin) to their single-word formsMultipooler/Multiorch/Multigateway/Multiadmin— only the leadingMis capitalized. Applied across docs, blog posts, the homepage, and the architecture diagram SVGs.tools/naming_linter.sh+ alint:namingnpm script + aNaming Lintjob) that rejects the camel-cased forms so the inconsistency can't creep back in.Description
Mirrors multigres/multigres#1237, which did the same rename and added a
git grep-based linter on the backend. The component names are single words, so only the first letter should be capitalized; the site had 171 occurrences of the PascalCase forms (including plurals likeMultiGateways) across content and the diagram<text>labels.The linter is a
git grepfor[Mm]ulti(Pooler|Orch|Gateway|Gres|Admin), which flags the PascalCase and camelCase forms while leaving the correct single-word forms and the SCREAMING_CASE constant form (e.g.ID_MULTIPOOLER) untouched. It excludes itself (it necessarily spells out the forbidden forms) and relies ongit grepskipping the gitignorednode_modules/build/.sourcetrees.Adapted for this pnpm/Node repo: the check is wired as a
lint:namingnpm script and a new.github/workflows/lint.ymlNaming Lintjob (the repo had no workflows before) rather than a Makefile target. Coverage also extends to the diagram SVGs, since those are the source of truth for the architecture images here.