[chore] Add rule to make provider casing more consistent (#3640)

rohitvinnakota-codecov · web-flow · commit 1eaa0d6bcc61 · 2025-01-08T17:30:08.000Z
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -500,5 +500,13 @@ module.exports = {
     // https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks
     'react-hooks/rules-of-hooks': 'error',
     'react-hooks/exhaustive-deps': 'warn',
+
+    'no-restricted-syntax': [
+      'warn',
+      {
+        selector: "JSXText[value=/\\bGithub\\b|\\bGitlab\\b|\\bBitBucket\\b/]",
+        message: "Use correct casing (GitHub, GitLab, Bitbucket)"
+      }
+    ]
   },
 }
diff --git a/src/pages/AccountSettings/tabs/Admin/GithubIntegrationSection/GithubIntegrationSection.jsx b/src/pages/AccountSettings/tabs/Admin/GithubIntegrationSection/GithubIntegrationSection.jsx
@@ -47,7 +47,7 @@ function GithubIntegrationSection() {
 
   return (
     <div className="flex flex-col gap-2">
-      <h2 className="text-lg font-semibold">Github Integration</h2>
+      <h2 className="text-lg font-semibold">GitHub Integration</h2>
       <GithubIntegrationCopy integrationId={accountDetails?.integrationId} />
     </div>
   )
diff --git a/src/pages/AccountSettings/tabs/Admin/GithubIntegrationSection/GithubIntegrationSection.test.jsx b/src/pages/AccountSettings/tabs/Admin/GithubIntegrationSection/GithubIntegrationSection.test.jsx
@@ -146,7 +146,7 @@ describe('GithubIntegrationSection', () => {
       render(<GithubIntegrationSection />, { wrapper: wrapper() })
 
       const link = await screen.findByRole('link', {
-        name: /Github/i,
+        name: /GitHub/i,
       })
       expect(link).toBeInTheDocument()
     })
diff --git a/src/pages/AccountSettings/tabs/Admin/ManageAdminCard/AdminTable/AdminTable.tsx b/src/pages/AccountSettings/tabs/Admin/ManageAdminCard/AdminTable/AdminTable.tsx
@@ -163,7 +163,7 @@ export default function AdminTable() {
   if (!isLoading && !tableData?.length) {
     return (
       <p>
-        No admins yet. Note that admins in your Github organization are
+        No admins yet. Note that admins in your GitHub organization are
         automatically considered admins.
       </p>
     )
diff --git a/src/pages/AccountSettings/tabs/Admin/ManageAdminCard/ManageAdminCard.test.jsx b/src/pages/AccountSettings/tabs/Admin/ManageAdminCard/ManageAdminCard.test.jsx
@@ -110,7 +110,7 @@ describe('ManageAdminCard', () => {
       render(<ManageAdminCard />, { wrapper })
 
       const noAdmins = await screen.findByText(
-        /No admins yet. Note that admins in your Github organization are automatically considered admins./
+        /No admins yet. Note that admins in your GitHub organization are automatically considered admins./
       )
       expect(noAdmins).toBeInTheDocument()
     })
@@ -123,7 +123,7 @@ describe('ManageAdminCard', () => {
       render(<ManageAdminCard />, { wrapper })
 
       const noAdmins = await screen.findByText(
-        /No admins yet. Note that admins in your Github organization are automatically considered admins./
+        /No admins yet. Note that admins in your GitHub organization are automatically considered admins./
       )
       expect(noAdmins).toBeInTheDocument()
     })
diff --git a/src/pages/CommitDetailPage/CommitCoverage/BotErrorBanner/BotErrorBanner.jsx b/src/pages/CommitDetailPage/CommitCoverage/BotErrorBanner/BotErrorBanner.jsx
@@ -11,7 +11,7 @@ import BannerHeading from 'ui/Banner/BannerHeading'
 export const ProvidersEnum = Object.freeze({
   Github: 'GitHub',
   Gitlab: 'GitLab',
-  BitBucket: 'BitBucket',
+  Bitbucket: 'Bitbucket',
 })
 
 function useProviderSetting() {
@@ -28,7 +28,7 @@ function useProviderSetting() {
   const ghWithNoApp =
     !accountDetails?.integrationId && provider === ProvidersEnum.Github
 
-  const bbProvider = provider === ProvidersEnum.BitBucket
+  const bbProvider = provider === ProvidersEnum.Bitbucket
   const glProvider = provider === ProvidersEnum.Gitlab
 
   return { ghWithNoApp, bbProvider, glProvider, ghWithApp }
@@ -83,7 +83,7 @@ const BotErrorHeading = () => {
 
   if (ghWithApp) {
     return (
-      <p className="font-semibold">There was an issue with the Github app</p>
+      <p className="font-semibold">There was an issue with the GitHub app</p>
     )
   }
 
diff --git a/src/pages/CommitDetailPage/CommitCoverage/BotErrorBanner/BotErrorBanner.test.jsx b/src/pages/CommitDetailPage/CommitCoverage/BotErrorBanner/BotErrorBanner.test.jsx
@@ -59,7 +59,7 @@ describe('BotErrorBanner', () => {
       })
 
       const title = await screen.findByText(
-        'There was an issue with the Github app'
+        'There was an issue with the GitHub app'
       )
       expect(title).toBeInTheDocument()
     })
diff --git a/src/pages/EnterpriseLandingPage/EnterpriseLandingPage.test.tsx b/src/pages/EnterpriseLandingPage/EnterpriseLandingPage.test.tsx
@@ -106,7 +106,7 @@ describe('EnterpriseLandingPage', () => {
     it('displays bitbucket card', async () => {
       render(<EnterpriseLandingPage />, { wrapper })
 
-      const element = await screen.findByRole('heading', { name: 'BitBucket' })
+      const element = await screen.findByRole('heading', { name: 'Bitbucket' })
       expect(element).toBeInTheDocument()
     })
 
@@ -138,7 +138,7 @@ describe('EnterpriseLandingPage', () => {
     it('displays bitbucket button', () => {
       render(<EnterpriseLandingPage />, { wrapper })
 
-      expect(screen.queryByText('BitBucket')).toBeNull()
+      expect(screen.queryByText('Bitbucket')).toBeNull()
     })
   })
 })
diff --git a/src/pages/EnterpriseLandingPage/ProviderCard/ProviderCard.test.tsx b/src/pages/EnterpriseLandingPage/ProviderCard/ProviderCard.test.tsx
@@ -27,7 +27,7 @@ describe('ProviderCard', () => {
         )
 
         const element = screen.getByRole('link', {
-          name: 'Login via BitBucket',
+          name: 'Login via Bitbucket',
         })
         expect(element).toBeInTheDocument()
         expect(element).toHaveAttribute('href', '/login/bb')
@@ -43,7 +43,7 @@ describe('ProviderCard', () => {
         )
 
         const element = screen.getByRole('link', {
-          name: 'Login via BitBucket Server',
+          name: 'Login via Bitbucket Server',
         })
         expect(element).toBeInTheDocument()
         expect(element).toHaveAttribute('href', '/login/bbs')
diff --git a/src/pages/RepoPage/FailedTestsTab/CodecovCLI/CodecovCLI.tsx b/src/pages/RepoPage/FailedTestsTab/CodecovCLI/CodecovCLI.tsx
@@ -83,7 +83,7 @@ function Step4() {
       </Card.Header>
       <Card.Content className="flex flex-col gap-4">
         <p>
-          Codecov offers existing wrappers for the CLI (Github Actions, Circle
+          Codecov offers existing wrappers for the CLI (GitHub Actions, Circle
           CI Orb, Bitrise Step) that makes uploading coverage to Codecov easy,
           as described{' '}
           <A
@@ -164,7 +164,7 @@ function Step6() {
           tests result on the following areas:
         </p>
         <ul className="list-inside list-disc">
-          <li>Github pull request comment</li>
+          <li>GitHub pull request comment</li>
           <li>Failed tests dashboard here.</li>
         </ul>
       </Card.Content>
diff --git a/src/pages/RepoPage/FailedTestsTab/GitHubActions/GitHubActions.tsx b/src/pages/RepoPage/FailedTestsTab/GitHubActions/GitHubActions.tsx
@@ -157,7 +157,7 @@ function Step4() {
           tests result on the following areas:
         </p>
         <ul className="list-inside list-disc">
-          <li>Github pull request comment</li>
+          <li>GitHub pull request comment</li>
           <li>Failed tests dashboard here.</li>
         </ul>
       </Card.Content>
diff --git a/src/pages/SyncProviderPage/SyncButton.test.tsx b/src/pages/SyncProviderPage/SyncButton.test.tsx
@@ -38,7 +38,7 @@ describe('SyncButton', () => {
     it('renders sync button', () => {
       render(<SyncButton provider="bb" />, { wrapper })
 
-      const link = screen.getByRole('link', { name: /Sync with BitBucket/ })
+      const link = screen.getByRole('link', { name: /Sync with Bitbucket/ })
 
       const expectedRedirect = encodeURIComponent('http://localhost:3000/bb')
       expect(link).toBeInTheDocument()
@@ -79,7 +79,7 @@ describe('SyncButton', () => {
       render(<SyncButton provider="bbs" />, { wrapper })
 
       const link = screen.getByRole('link', {
-        name: /Sync with BitBucket Server/,
+        name: /Sync with Bitbucket Server/,
       })
 
       const expectedRedirect = encodeURIComponent('http://localhost:3000/bbs')
diff --git a/src/shared/GlobalBanners/GitHubRateLimitExceeded/GitHubRateLimitExceededBanner.test.tsx b/src/shared/GlobalBanners/GitHubRateLimitExceeded/GitHubRateLimitExceededBanner.test.tsx
@@ -24,7 +24,7 @@ describe('GitHubRateLimitExceededBanner', () => {
       const description = screen.getByText(/Unable to calculate/)
       expect(description).toBeInTheDocument()
 
-      const link = screen.getByRole('link', { name: 'Github documentation.' })
+      const link = screen.getByRole('link', { name: 'GitHub documentation.' })
       expect(link).toBeInTheDocument()
       expect(link).toHaveAttribute(
         'href',
diff --git a/src/shared/GlobalBanners/GitHubRateLimitExceeded/GitHubRateLimitExceededBanner.tsx b/src/shared/GlobalBanners/GitHubRateLimitExceeded/GitHubRateLimitExceededBanner.tsx
@@ -28,7 +28,7 @@ const GitHubRateLimitExceededBanner = () => {
             hook={undefined}
             isExternal={true}
           >
-            Github documentation.
+            GitHub documentation.
           </A>
         </Alert.Description>
       </Alert>
diff --git a/src/shared/ListRepo/OrgControlTable/RepoOrgNotFound/RepoOrgNotFound.tsx b/src/shared/ListRepo/OrgControlTable/RepoOrgNotFound/RepoOrgNotFound.tsx
@@ -34,7 +34,7 @@ function ResyncButton() {
           isExternal={true}
           className="inline underline"
         >
-          Github rate limits.
+          GitHub rate limits.
         </A>
       </div>
     )
diff --git a/src/shared/utils/loginProviders.ts b/src/shared/utils/loginProviders.ts
@@ -11,12 +11,12 @@ import sentryLogo from 'assets/providers/sentry-icon.svg'
 export const LoginProvidersEnum = {
   BITBUCKET: {
     provider: 'bb',
-    name: 'BitBucket',
+    name: 'Bitbucket',
     external: 'BITBUCKET',
     externalKey: 'bb',
     selfHosted: 'BITBUCKET_SERVER',
     selfHostedKey: 'bbs',
-    selfHostedName: 'BitBucket Server',
+    selfHostedName: 'Bitbucket Server',
     variant: 'bitbucket',
   },
   GITHUB: {
@@ -71,17 +71,17 @@ export function loginProviderToShortName(loginProvider?: string) {
 
 export const LOGIN_PROVIDER_NAMES = {
   gh: 'GitHub',
-  bb: 'BitBucket',
+  bb: 'Bitbucket',
   gl: 'GitLab',
   ghe: 'GitHub Enterprise',
   gle: 'GitLab Enterprise',
-  bbs: 'BitBucket Server',
+  bbs: 'Bitbucket Server',
   github: 'GitHub',
-  bitbucket: 'BitBucket',
+  bitbucket: 'Bitbucket',
   gitlab: 'GitLab',
   github_enterprise: 'GitHub Enterprise',
   gitlab_enterprise: 'GitLab Enterprise',
-  bitbucket_server: 'BitBucket Server',
+  bitbucket_server: 'Bitbucket Server',
   sentry: 'Sentry',
   okta: 'Okta',
 } as const
@@ -99,21 +99,21 @@ export function loginProviderToName(loginProvider?: string) {
 export const LOGIN_PROVIDER_IMAGES = {
   GitHub: githubLogo,
   GitLab: gitlabLogo,
-  BitBucket: bitbucketLogo,
+  Bitbucket: bitbucketLogo,
   'GitHub Enterprise': githubLogo,
   'GitLab Enterprise': gitlabLogo,
-  'BitBucket Server': bitbucketLogo,
+  'Bitbucket Server': bitbucketLogo,
   Sentry: sentryLogo,
   Okta: oktaLogo,
 } as const
 
 export const LOGIN_PROVIDER_DARK_MODE_IMAGES = {
   GitHub: githubLogoWhite,
   GitLab: gitlabLogo,
-  BitBucket: bitbucketLogo,
+  Bitbucket: bitbucketLogo,
   'GitHub Enterprise': githubLogoWhite,
   'GitLab Enterprise': gitlabLogo,
-  'BitBucket Server': bitbucketLogo,
+  'Bitbucket Server': bitbucketLogo,
   Sentry: sentryLogoWhite,
   Okta: oktaLogo,
 } as const
diff --git a/src/shared/utils/provider.test.ts b/src/shared/utils/provider.test.ts
@@ -11,74 +11,74 @@ vi.mock('config')
 
 describe('providerToName', () => {
   describe('when called with gh', () => {
-    it('returns Github', () => {
+    it('returns GitHub', () => {
       expect(providerToName('gh')).toBe('GitHub')
     })
   })
 
   describe('when called with gl', () => {
-    it('returns Gitlab', () => {
+    it('returns GitLab', () => {
       expect(providerToName('gl')).toBe('GitLab')
     })
   })
 
   describe('when called with bb', () => {
-    it('returns BitBucket', () => {
-      expect(providerToName('bb')).toBe('BitBucket')
+    it('returns Bitbucket', () => {
+      expect(providerToName('bb')).toBe('Bitbucket')
     })
   })
 
   describe('when called with ghe', () => {
-    it('returns Github Enterprise', () => {
+    it('returns GitHub Enterprise', () => {
       expect(providerToName('ghe')).toBe('GitHub Enterprise')
     })
   })
 
   describe('when called with gle', () => {
-    it('returns Gitlab Enterprise', () => {
+    it('returns GitLab Enterprise', () => {
       expect(providerToName('gle')).toBe('GitLab Enterprise')
     })
   })
 
   describe('when called with bbs', () => {
-    it('returns BitBucket Server', () => {
-      expect(providerToName('bbs')).toBe('BitBucket Server')
+    it('returns Bitbucket Server', () => {
+      expect(providerToName('bbs')).toBe('Bitbucket Server')
     })
   })
 
-  describe('when called with Github', () => {
-    it('returns Github', () => {
+  describe('when called with GitHub', () => {
+    it('returns GitHub', () => {
       expect(providerToName('github')).toBe('GitHub')
     })
   })
 
-  describe('when called with Gitlab', () => {
-    it('returns Gitlab', () => {
+  describe('when called with GitLab', () => {
+    it('returns GitLab', () => {
       expect(providerToName('gitlab')).toBe('GitLab')
     })
   })
 
-  describe('when called with BitBucket', () => {
-    it('returns BitBucket', () => {
-      expect(providerToName('bitbucket')).toBe('BitBucket')
+  describe('when called with Bitbucket', () => {
+    it('returns Bitbucket', () => {
+      expect(providerToName('bitbucket')).toBe('Bitbucket')
     })
   })
 
   describe('when called with github_enterprise', () => {
-    it('returns Github Enterprise', () => {
+    it('returns GitHub Enterprise', () => {
       expect(providerToName('github_enterprise')).toBe('GitHub Enterprise')
     })
   })
 
   describe('when called with gitlab-enterprise', () => {
-    it('returns Gitlab Enterprise', () => {
+    it('returns GitLab Enterprise', () => {
       expect(providerToName('gitlab_enterprise')).toBe('GitLab Enterprise')
     })
   })
 
   describe('when called with bitbucket_server', () => {
-    it('returns BitBucket Server', () => {
-      expect(providerToName('bitbucket_server')).toBe('BitBucket Server')
+    it('returns Bitbucket Server', () => {
+      expect(providerToName('bitbucket_server')).toBe('Bitbucket Server')
     })
   })
 })
@@ -203,19 +203,19 @@ describe('providerToInternalProvider', () => {
     })
   })
 
-  describe('when called with Github', () => {
+  describe('when called with GitHub', () => {
     it('returns github', () => {
       expect(providerToInternalProvider('github')).toBe('github')
     })
   })
 
-  describe('when called with Gitlab', () => {
+  describe('when called with GitLab', () => {
     it('returns gitlab', () => {
       expect(providerToInternalProvider('gitlab')).toBe('gitlab')
     })
   })
 
-  describe('when called with BitBucket', () => {
+  describe('when called with Bitbucket', () => {
     it('returns bitbucket', () => {
       expect(providerToInternalProvider('bitbucket')).toBe('bitbucket')
     })
diff --git a/src/shared/utils/provider.ts b/src/shared/utils/provider.ts

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ function GithubIntegrationSection() {`
`47`	`47`
`48`	`48`	`return (`
`49`	`49`	`<div className="flex flex-col gap-2">`
`50`		`- <h2 className="text-lg font-semibold">Github Integration</h2>`
	`50`	`+ <h2 className="text-lg font-semibold">GitHub Integration</h2>`
`51`	`51`	`<GithubIntegrationCopy integrationId={accountDetails?.integrationId} />`
`52`	`52`	`</div>`
`53`	`53`	`)`
Original file line number	Diff line number	Diff line change
`@@ -163,7 +163,7 @@ export default function AdminTable() {`
`163`	`163`	`if (!isLoading && !tableData?.length) {`
`164`	`164`	`return (`
`165`	`165`	`<p>`
`166`		`- No admins yet. Note that admins in your Github organization are`
	`166`	`+ No admins yet. Note that admins in your GitHub organization are`
`167`	`167`	`automatically considered admins.`
`168`	`168`	`</p>`
`169`	`169`	`)`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ describe('BotErrorBanner', () => {`
`59`	`59`	`})`
`60`	`60`
`61`	`61`	`const title = await screen.findByText(`
`62`		`- 'There was an issue with the Github app'`
	`62`	`+ 'There was an issue with the GitHub app'`
`63`	`63`	`)`
`64`	`64`	`expect(title).toBeInTheDocument()`
`65`	`65`	`})`