From 2f33a9f63fc434c7fd38532c20245cf6dbc1cf8e Mon Sep 17 00:00:00 2001 From: Andre Wanlin Date: Wed, 29 Apr 2026 16:53:20 -0500 Subject: [PATCH] Fixes for non-breaking typos and typos configuration Signed-off-by: Andre Wanlin More Signed-off-by: Andre Wanlin --- .../fix-gitlab-provider-comment-typos.md | 5 ++ .../fix-kubernetes-proxy-variable-typo.md | 5 ++ .../fix-scaffolder-backend-variable-typo.md | 5 ++ .../fix-scaffolder-css-class-name-typo.md | 5 ++ .../scripts/orphan-clean-up/OrphanCleanUp.ps1 | 2 +- .../scripts/orphan-clean-up/orphan_cleanup.sh | 2 +- ... => github-unable-to-resolve-identity.png} | Bin docs/auth/identity-resolver.md | 2 +- docs/features/techdocs/how-to-guides.md | 2 +- .../2023-11-15-backstagecon-kubecon-23.mdx | 2 +- .../entrypoints/discovery/HostDiscovery.ts | 2 +- .../src/lib/bundler/moduleFederation.ts | 2 +- packages/cli/src/wiring/errors.ts | 2 +- .../MarkdownContent.stories.tsx | 2 +- .../MarkdownContent/MarkdownContent.tsx | 2 +- .../src/apis/definitions/auth.ts | 2 +- .../src/wiring/createExtension.test.ts | 4 +- .../src/wiring/createExtensionBlueprint.ts | 4 +- .../src/commands/package-docs/Cache.ts | 2 +- .../auth-backend/src/providers/router.test.ts | 2 +- plugins/auth-node/src/types.ts | 2 +- .../src/__testUtils__/mocks.ts | 4 +- .../GitlabDiscoveryEntityProvider.ts | 6 +- .../src/providers/config.test.ts | 2 +- .../src/ldap/client.ts | 2 +- .../src/ldap/read.test.ts | 2 +- .../DefaultCatalogProcessingEngine.ts | 2 +- .../src/service/DefaultEntitiesCatalog.ts | 2 +- .../CatalogFilterBlueprint.test.tsx | 2 +- .../catalog-unprocessed-entities/README.md | 2 +- plugins/kubernetes-backend/src/plugin.ts | 2 +- .../src/service/KubernetesProxy.ts | 10 +-- .../gitlabMergeRequest.examples.test.ts | 2 +- .../src/actions/gitlabMergeRequest.test.ts | 2 +- .../tasks/NunjucksWorkflowRunner.ts | 8 +-- .../scaffolder-backend/src/service/rules.ts | 2 +- .../TemplateCategoryPicker.test.tsx | 4 +- .../CustomFieldPlayground.tsx | 2 +- .../config.d.ts | 2 +- .../HighlightedSearchResultText.test.tsx | 2 +- typos.toml | 60 ++++++++++++++++++ 41 files changed, 128 insertions(+), 48 deletions(-) create mode 100644 .changeset/fix-gitlab-provider-comment-typos.md create mode 100644 .changeset/fix-kubernetes-proxy-variable-typo.md create mode 100644 .changeset/fix-scaffolder-backend-variable-typo.md create mode 100644 .changeset/fix-scaffolder-css-class-name-typo.md rename docs/assets/auth/{github-unable-to-reolve-identity.png => github-unable-to-resolve-identity.png} (100%) create mode 100644 typos.toml diff --git a/.changeset/fix-gitlab-provider-comment-typos.md b/.changeset/fix-gitlab-provider-comment-typos.md new file mode 100644 index 0000000000..6eda94e062 --- /dev/null +++ b/.changeset/fix-gitlab-provider-comment-typos.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-gitlab': patch +--- + +Fixed typo in code: `Commited` corrected to `Committed` in `GitlabDiscoveryEntityProvider`. diff --git a/.changeset/fix-kubernetes-proxy-variable-typo.md b/.changeset/fix-kubernetes-proxy-variable-typo.md new file mode 100644 index 0000000000..1e7235dd1c --- /dev/null +++ b/.changeset/fix-kubernetes-proxy-variable-typo.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-kubernetes-backend': patch +--- + +Fixed typo in internal variable name: `headerSplitted` corrected to `headerSplit` in `KubernetesProxy`. diff --git a/.changeset/fix-scaffolder-backend-variable-typo.md b/.changeset/fix-scaffolder-backend-variable-typo.md new file mode 100644 index 0000000000..37ff6c36a3 --- /dev/null +++ b/.changeset/fix-scaffolder-backend-variable-typo.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-scaffolder-backend': patch +--- + +Fixed typo in internal variable name: `promtStepCount` corrected to `promStepCount` in `NunjucksWorkflowRunner`. diff --git a/.changeset/fix-scaffolder-css-class-name-typo.md b/.changeset/fix-scaffolder-css-class-name-typo.md new file mode 100644 index 0000000000..ec78159b64 --- /dev/null +++ b/.changeset/fix-scaffolder-css-class-name-typo.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-scaffolder': patch +--- + +Fixed typo in CSS class name: `ScaffolderCustomFieldExtensionsPlaygroud` corrected to `ScaffolderCustomFieldExtensionsPlayground` in `CustomFieldPlayground`. diff --git a/contrib/scripts/orphan-clean-up/OrphanCleanUp.ps1 b/contrib/scripts/orphan-clean-up/OrphanCleanUp.ps1 index 1eaaa2ab2c..378a992af6 100644 --- a/contrib/scripts/orphan-clean-up/OrphanCleanUp.ps1 +++ b/contrib/scripts/orphan-clean-up/OrphanCleanUp.ps1 @@ -1,6 +1,6 @@ <# .DESCRIPTION -Cleanes up orphaned entities for the provided Backstage URL, defaults to the local backend +Cleans up orphaned entities for the provided Backstage URL, defaults to the local backend #> param( [string]$backstageUrl = "http://localhost:7007" diff --git a/contrib/scripts/orphan-clean-up/orphan_cleanup.sh b/contrib/scripts/orphan-clean-up/orphan_cleanup.sh index 6ffe4737fb..a87b8de812 100755 --- a/contrib/scripts/orphan-clean-up/orphan_cleanup.sh +++ b/contrib/scripts/orphan-clean-up/orphan_cleanup.sh @@ -2,7 +2,7 @@ set -euo pipefail -# Cleanes up orphaned entities for the provided Backstage URL, defaults to the local backend +# Cleans up orphaned entities for the provided Backstage URL, defaults to the local backend BACKSTAGE_URL=${1:-'http://localhost:7007'} echo $BACKSTAGE_URL diff --git a/docs/assets/auth/github-unable-to-reolve-identity.png b/docs/assets/auth/github-unable-to-resolve-identity.png similarity index 100% rename from docs/assets/auth/github-unable-to-reolve-identity.png rename to docs/assets/auth/github-unable-to-resolve-identity.png diff --git a/docs/auth/identity-resolver.md b/docs/auth/identity-resolver.md index ef77e69c22..9d332d19e5 100644 --- a/docs/auth/identity-resolver.md +++ b/docs/auth/identity-resolver.md @@ -496,6 +496,6 @@ This error can be caused by the following: The second common error is: "Failed to sign-in, unable to resolve user identity". Here is what this looks like for the GitHub Auth provider: -![Failed to sign-in, unable to resolve user identity](../assets/auth/github-unable-to-reolve-identity.png) +![Failed to sign-in, unable to resolve user identity](../assets/auth/github-unable-to-resolve-identity.png) This error is caused by the Sign-In Resolver you configured being unable to find a matching User in the Catalog. To fix this you need to import User, and Group, data from some source of truth for this data at your Organization. To do this you can use one of the existing Org Data providers like the ones for [Entra ID (Azure AD/MS Graph)](../integrations/azure/org.md), [GitHub](../integrations/github/org.md), [GitLab](../integrations/gitlab/org.md), etc. or if none of those fit your needs you can create a [Custom Entity Provider](../features/software-catalog/external-integrations.md#custom-entity-providers). diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index 2678b5c6f1..7523779a06 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -828,7 +828,7 @@ metadata: apiVersion: backstage.io/v1alpha1 kind: Component metadata: - name: example-platfrom + name: example-platform title: Example Application Platform namespace: default description: This is the child entity diff --git a/microsite/blog/2023-11-15-backstagecon-kubecon-23.mdx b/microsite/blog/2023-11-15-backstagecon-kubecon-23.mdx index cdb2d9e582..06d355be33 100644 --- a/microsite/blog/2023-11-15-backstagecon-kubecon-23.mdx +++ b/microsite/blog/2023-11-15-backstagecon-kubecon-23.mdx @@ -50,7 +50,7 @@ People gathered outside the conference room where BackstageCon was happening to ### Mom, Backstage is not a phase -The interest from the cloud-native community in Backstage did not waver this year. Instead, the Backstage booth in the KubeCon Project Pavillion saw a nonstop flux of visitors asking more about the project. There were three talks featuring Backstage during KubeCon. +The interest from the cloud-native community in Backstage did not waver this year. Instead, the Backstage booth in the KubeCon Project Pavilion saw a nonstop flux of visitors asking more about the project. There were three talks featuring Backstage during KubeCon. **Backstage talks during KubeCon NA '23** diff --git a/packages/backend-defaults/src/entrypoints/discovery/HostDiscovery.ts b/packages/backend-defaults/src/entrypoints/discovery/HostDiscovery.ts index 7e25ba66c4..5e47a9910f 100644 --- a/packages/backend-defaults/src/entrypoints/discovery/HostDiscovery.ts +++ b/packages/backend-defaults/src/entrypoints/discovery/HostDiscovery.ts @@ -100,7 +100,7 @@ export interface HostDiscoveryOptions { * These endpoints have lower priority than any that are defined in * app-config, but higher priority than the fallback ones. * - * This parameter is usedful for example if you want to provide a shared + * This parameter is useful for example if you want to provide a shared * library of core services to your plugin developers, which is set up for the * default behaviors in your org. This alleviates the need for replicating any * given set of endpoint config in every backend that you deploy. diff --git a/packages/cli-module-build/src/lib/bundler/moduleFederation.ts b/packages/cli-module-build/src/lib/bundler/moduleFederation.ts index 69e1415b5d..4d2dc3e141 100644 --- a/packages/cli-module-build/src/lib/bundler/moduleFederation.ts +++ b/packages/cli-module-build/src/lib/bundler/moduleFederation.ts @@ -100,7 +100,7 @@ export function prepareRuntimeSharedDependenciesScript( return { name, version: sharedDep.version, - lib: name as unknown as () => Promise, // Coverted into import below + lib: name as unknown as () => Promise, // Converted into import below shareConfig: { singleton: sharedDep.singleton, requiredVersion: sharedDep.requiredVersion, diff --git a/packages/cli/src/wiring/errors.ts b/packages/cli/src/wiring/errors.ts index aee6d3f575..ef5613c224 100644 --- a/packages/cli/src/wiring/errors.ts +++ b/packages/cli/src/wiring/errors.ts @@ -50,7 +50,7 @@ export function exitWithError(error: unknown): never { return exit(error.message, 64 /* command line usage error */); case 'AuthenticationError': case 'NotAllowedError': - return exit(error.message, 77 /* permissino denied */); + return exit(error.message, 77 /* permission denied */); case 'ExitCodeError': return exit( error.message, diff --git a/packages/core-components/src/components/MarkdownContent/MarkdownContent.stories.tsx b/packages/core-components/src/components/MarkdownContent/MarkdownContent.stories.tsx index 79523470af..ef0a898cc6 100644 --- a/packages/core-components/src/components/MarkdownContent/MarkdownContent.stories.tsx +++ b/packages/core-components/src/components/MarkdownContent/MarkdownContent.stories.tsx @@ -120,7 +120,7 @@ const markdown = '\n' + 'Per quem, nec formosior qui cum Peliden me interea **ornatos**! Te facit\n' + 'instimulat sequentia in flumina exilium te vulnere, sola. Coetum nec amnes.\n' + - 'Protinus nam Caras cava, *a* vocantem dicta inevitabile, nata nulla.\n' + + 'Lumen nova signa at tempori flecta, sed quietum narrata civitas.\n' + '\n' + '## Piscem Iunoni maius\n' + '\n' + diff --git a/packages/core-components/src/components/MarkdownContent/MarkdownContent.tsx b/packages/core-components/src/components/MarkdownContent/MarkdownContent.tsx index 4098a6e52d..7eba6fef8e 100644 --- a/packages/core-components/src/components/MarkdownContent/MarkdownContent.tsx +++ b/packages/core-components/src/components/MarkdownContent/MarkdownContent.tsx @@ -130,7 +130,7 @@ const gfmRehypePlugins: PluggableList = [ [ rehypeRaw, { - tagFiter: true, + tagfilter: true, }, ], [ diff --git a/packages/frontend-plugin-api/src/apis/definitions/auth.ts b/packages/frontend-plugin-api/src/apis/definitions/auth.ts index d686ed5d08..53bbf16163 100644 --- a/packages/frontend-plugin-api/src/apis/definitions/auth.ts +++ b/packages/frontend-plugin-api/src/apis/definitions/auth.ts @@ -66,7 +66,7 @@ export type AuthProviderInfo = { icon: IconComponent | IconElement; /** - * Optional user friendly messaage to display for the auth provider. + * Optional user friendly message to display for the auth provider. */ message?: string; }; diff --git a/packages/frontend-plugin-api/src/wiring/createExtension.test.ts b/packages/frontend-plugin-api/src/wiring/createExtension.test.ts index 8f259be6f9..536b702b98 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtension.test.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtension.test.ts @@ -278,14 +278,14 @@ describe('createExtension', () => { expect(String(extension)).toBe( 'ExtensionDefinition{attachTo=@tabs+page:@tabs+/index@tabs+page:/index@otherTabs}', ); - const overrdeExtension = extension.override({ + const overrideExtension = extension.override({ attachTo: [ parent2.inputs.tabs, parent3.inputs.tabs, parent4.inputs.otherTabs, ] as any, }); - expect(String(overrdeExtension)).toBe( + expect(String(overrideExtension)).toBe( 'ExtensionDefinition{attachTo=page:@tabs+/index@tabs+page:/index@otherTabs}', ); }); diff --git a/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts b/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts index 99ed7c1afb..50351f5d9a 100644 --- a/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts +++ b/packages/frontend-plugin-api/src/wiring/createExtensionBlueprint.ts @@ -48,8 +48,8 @@ import { describeParentCallSite } from '../routing/describeParentCallSite'; * @remarks * * This function is primarily intended to enable the use of inferred type - * parameters for blueprint params, but it can also be used to transoform the - * params before they are handed ot the blueprint. + * parameters for blueprint params, but it can also be used to transform the + * params before they are handed to the blueprint. * * The function must return an object created with * {@link createExtensionBlueprintParams}. diff --git a/packages/repo-tools/src/commands/package-docs/Cache.ts b/packages/repo-tools/src/commands/package-docs/Cache.ts index 0ca38c1c39..3f26ceca1c 100644 --- a/packages/repo-tools/src/commands/package-docs/Cache.ts +++ b/packages/repo-tools/src/commands/package-docs/Cache.ts @@ -77,7 +77,7 @@ export class PackageDocsCache { } map.set(pkg, parsed); } catch (e) { - console.error(`Skipping unparseable cache file ${file}: ${e}`); + console.error(`Skipping unparsable cache file ${file}: ${e}`); } } return new PackageDocsCache(lockfile, map, baseDirectory); diff --git a/plugins/auth-backend/src/providers/router.test.ts b/plugins/auth-backend/src/providers/router.test.ts index 3a1fde881e..b312a3f1d8 100644 --- a/plugins/auth-backend/src/providers/router.test.ts +++ b/plugins/auth-backend/src/providers/router.test.ts @@ -33,7 +33,7 @@ describe('Auth origin filtering', () => { }); it('Will explode, invalid origin domain', () => { - const origin = 'https://test-1234.examplee.net'; + const origin = 'https://test-1234.wrong-example.net'; expect(createOriginFilter(config)(origin)).toBeFalsy(); }); diff --git a/plugins/auth-node/src/types.ts b/plugins/auth-node/src/types.ts index e5a18bfafc..89a4eb2f0e 100644 --- a/plugins/auth-node/src/types.ts +++ b/plugins/auth-node/src/types.ts @@ -37,7 +37,7 @@ export interface BackstageSignInResult { /** * Identity information to pass to the client rather than using the - * information that's embeeded in the token. + * information that's embedded in the token. */ identity?: BackstageUserIdentity; } diff --git a/plugins/catalog-backend-module-gitlab/src/__testUtils__/mocks.ts b/plugins/catalog-backend-module-gitlab/src/__testUtils__/mocks.ts index ba326971c6..af6626b6eb 100644 --- a/plugins/catalog-backend-module-gitlab/src/__testUtils__/mocks.ts +++ b/plugins/catalog-backend-module-gitlab/src/__testUtils__/mocks.ts @@ -1367,9 +1367,9 @@ export const all_groups_response: GitLabGroup[] = [ }, { id: 8, - name: 'awsome-group', + name: 'awesome-group', description: '', - full_path: 'awsome-group', + full_path: 'awesome-group', }, ]; diff --git a/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts b/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts index c171e66801..3a676866a2 100644 --- a/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts +++ b/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts @@ -476,12 +476,12 @@ export class GitlabDiscoveryEntityProvider implements EntityProvider { ); // Modified files will be scheduled to a refresh - const addedEntities = this.createLocationSpecCommitedFiles( + const addedEntities = this.createLocationSpecCommittedFiles( event.project, added, ); - const removedEntities = this.createLocationSpecCommitedFiles( + const removedEntities = this.createLocationSpecCommittedFiles( event.project, removed, ); @@ -563,7 +563,7 @@ export class GitlabDiscoveryEntityProvider implements EntityProvider { * @param addedFiles - The array of added file paths. * @returns An array of location specs. */ - private createLocationSpecCommitedFiles( + private createLocationSpecCommittedFiles( project: WebhookProjectSchema, addedFiles: string[], ): LocationSpec[] { diff --git a/plugins/catalog-backend-module-gitlab/src/providers/config.test.ts b/plugins/catalog-backend-module-gitlab/src/providers/config.test.ts index f6c8021655..d986019bce 100644 --- a/plugins/catalog-backend-module-gitlab/src/providers/config.test.ts +++ b/plugins/catalog-backend-module-gitlab/src/providers/config.test.ts @@ -402,7 +402,7 @@ describe('config', () => { ); }); - it('valid config with empyt topics', () => { + it('valid config with empty topics', () => { const config = new ConfigReader({ catalog: { providers: { diff --git a/plugins/catalog-backend-module-ldap/src/ldap/client.ts b/plugins/catalog-backend-module-ldap/src/ldap/client.ts index 49b6d56238..6285394b13 100644 --- a/plugins/catalog-backend-module-ldap/src/ldap/client.ts +++ b/plugins/catalog-backend-module-ldap/src/ldap/client.ts @@ -179,7 +179,7 @@ export class LdapClient { } } - // Check a shema for Google-specific patterns + // Check a schema for Google-specific patterns private checkGoogleSchema(rootDSE: Entry): boolean { try { const objectClasses = this.parseSchemaValues(rootDSE.objectClasses); diff --git a/plugins/catalog-backend-module-ldap/src/ldap/read.test.ts b/plugins/catalog-backend-module-ldap/src/ldap/read.test.ts index 9e840f08ba..5c16e02d02 100644 --- a/plugins/catalog-backend-module-ldap/src/ldap/read.test.ts +++ b/plugins/catalog-backend-module-ldap/src/ldap/read.test.ts @@ -137,7 +137,7 @@ describe('readLdapUsers', () => { it('override default vendor configs', async () => { const searchEntries: Entry[] = [ { - dn: 'dn-vaule', + dn: 'dn-value', uid: 'uid-value', description: 'description-value', cn: 'cn-value', diff --git a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingEngine.ts b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingEngine.ts index e7865cd8d2..a8dad983b2 100644 --- a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingEngine.ts +++ b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingEngine.ts @@ -256,7 +256,7 @@ export class DefaultCatalogProcessingEngine { // non-catastrophic things such as due to validation errors, as well as if // something fatal happens inside the processing for other reasons. In any // case, this means we can't trust that anything in the output is okay. So - // just store the errors and trigger a stich so that they become visible to + // just store the errors and trigger a stitch so that they become visible to // the outside. if (!result.ok) { // notify the error listener if the entity can not be processed. diff --git a/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts b/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts index 9a6fdd595b..6636096bb9 100644 --- a/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts +++ b/plugins/catalog-backend/src/service/DefaultEntitiesCatalog.ts @@ -260,7 +260,7 @@ export class DefaultEntitiesCatalog implements EntitiesCatalog { // For performance reasons we invoke the count query only on the first // request. The result is then embedded into the cursor for subsequent - // requests. Threfore this can be undefined here, but will then get + // requests. Therefore this can be undefined here, but will then get // populated further down. const shouldComputeTotalItems = cursor.totalItems === undefined && !cursor.skipTotalItems; diff --git a/plugins/catalog-react/src/alpha/blueprints/CatalogFilterBlueprint.test.tsx b/plugins/catalog-react/src/alpha/blueprints/CatalogFilterBlueprint.test.tsx index fc2bbb993d..7553e87119 100644 --- a/plugins/catalog-react/src/alpha/blueprints/CatalogFilterBlueprint.test.tsx +++ b/plugins/catalog-react/src/alpha/blueprints/CatalogFilterBlueprint.test.tsx @@ -57,7 +57,7 @@ describe('CatalogFilterBlueprint', () => { `); }); - it('should allow overrding of inputs and config', async () => { + it('should allow overriding of inputs and config', async () => { const extension = CatalogFilterBlueprint.makeWithOverrides({ name: 'test-name', inputs: { diff --git a/plugins/catalog-unprocessed-entities/README.md b/plugins/catalog-unprocessed-entities/README.md index fc20168b80..1af3fc19f3 100644 --- a/plugins/catalog-unprocessed-entities/README.md +++ b/plugins/catalog-unprocessed-entities/README.md @@ -74,7 +74,7 @@ import { useApi } from '@backstage/core-plugin-api'; const catalogUnprocessedEntitiesApi = useApi(catalogUnprocessedEntitiesApiRef); ``` -Note that if you are not rendering the `CatalogUnprocessedEntitiesPage` in the `App.tsx` tree, you will need to export the `catalogUnproccessedEntitiesPlugin` from your `plugins.ts` file to setup the plugin otherwise you will receive an error like `No implementation available for apiRef{plugin.catalog-unprocessed-entities.service}` +Note that if you are not rendering the `CatalogUnprocessedEntitiesPage` in the `App.tsx` tree, you will need to export the `catalogUnprocessedEntitiesPlugin` from your `plugins.ts` file to setup the plugin otherwise you will receive an error like `No implementation available for apiRef{plugin.catalog-unprocessed-entities.service}` ```typescript // In packages/app/src/plugins.ts diff --git a/plugins/kubernetes-backend/src/plugin.ts b/plugins/kubernetes-backend/src/plugin.ts index 5a2a22f2b5..3b68f9c1e1 100644 --- a/plugins/kubernetes-backend/src/plugin.ts +++ b/plugins/kubernetes-backend/src/plugin.ts @@ -235,7 +235,7 @@ export const kubernetesPlugin = createBackendPlugin({ auth, httpAuth, }) { - // TODO: this could do with a cleanup and push some of this initalization somewhere else + // TODO: this could do with a cleanup and push some of this initialization somewhere else if (config.has('kubernetes')) { const initializer = KubernetesInitializer.create({ logger, diff --git a/plugins/kubernetes-backend/src/service/KubernetesProxy.ts b/plugins/kubernetes-backend/src/service/KubernetesProxy.ts index a277b6bb8b..8ab10fd118 100644 --- a/plugins/kubernetes-backend/src/service/KubernetesProxy.ts +++ b/plugins/kubernetes-backend/src/service/KubernetesProxy.ts @@ -295,11 +295,11 @@ export class KubernetesProxy { originalHeaders: IncomingHttpHeaders, ): KubernetesRequestAuth { const obj: KubernetesRequestAuth = {}; - const headerSplitted = header.split('-'); - if (headerSplitted.length >= 4) { - const framework = headerSplitted[3].toLowerCase(); - if (headerSplitted.length >= 5) { - const provider = headerSplitted.slice(4).join('-').toLowerCase(); + const headerSplit = header.split('-'); + if (headerSplit.length >= 4) { + const framework = headerSplit[3].toLowerCase(); + if (headerSplit.length >= 5) { + const provider = headerSplit.slice(4).join('-').toLowerCase(); obj[framework] = { [provider]: originalHeaders[header] }; } else { obj[framework] = originalHeaders[header]; diff --git a/plugins/scaffolder-backend-module-gitlab/src/actions/gitlabMergeRequest.examples.test.ts b/plugins/scaffolder-backend-module-gitlab/src/actions/gitlabMergeRequest.examples.test.ts index 27f39fe621..9b86cf6945 100644 --- a/plugins/scaffolder-backend-module-gitlab/src/actions/gitlabMergeRequest.examples.test.ts +++ b/plugins/scaffolder-backend-module-gitlab/src/actions/gitlabMergeRequest.examples.test.ts @@ -189,7 +189,7 @@ describe('createGitLabMergeRequest', () => { description: 'This is an important change', removeSourceBranch: false, targetPath: 'Subdirectory', - assingnee: 'John Doe', + assignee: 'John Doe', }; mockDir.setContent({ [workspacePath]: { diff --git a/plugins/scaffolder-backend-module-gitlab/src/actions/gitlabMergeRequest.test.ts b/plugins/scaffolder-backend-module-gitlab/src/actions/gitlabMergeRequest.test.ts index 0cc1ca60c3..80a78772a9 100644 --- a/plugins/scaffolder-backend-module-gitlab/src/actions/gitlabMergeRequest.test.ts +++ b/plugins/scaffolder-backend-module-gitlab/src/actions/gitlabMergeRequest.test.ts @@ -465,7 +465,7 @@ describe('createGitLabMergeRequest', () => { description: 'This is an important change', removeSourceBranch: false, targetPath: 'Subdirectory', - assingnee: 'John Doe', + assignee: 'John Doe', }; mockDir.setContent({ [workspacePath]: { diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts index ebede4dbc3..656427bf09 100644 --- a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts +++ b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts @@ -804,7 +804,7 @@ function scaffoldingTracker(metrics: MetricsService) { help: 'Duration of a task run', labelNames: ['template', 'result'], }); - const promtStepCount = createCounterMetric({ + const promStepCount = createCounterMetric({ name: 'scaffolder_step_count', help: 'Count of step runs', labelNames: ['template', 'step', 'result'], @@ -942,7 +942,7 @@ function scaffoldingTracker(metrics: MetricsService) { stepId: step.id, status: 'completed', }); - promtStepCount.inc({ + promStepCount.inc({ template, step: step.name, result: 'ok', @@ -958,7 +958,7 @@ function scaffoldingTracker(metrics: MetricsService) { } async function markCancelled() { - promtStepCount.inc({ + promStepCount.inc({ template, step: step.name, result: 'cancelled', @@ -974,7 +974,7 @@ function scaffoldingTracker(metrics: MetricsService) { } async function markFailed() { - promtStepCount.inc({ + promStepCount.inc({ template, step: step.name, result: 'failed', diff --git a/plugins/scaffolder-backend/src/service/rules.ts b/plugins/scaffolder-backend/src/service/rules.ts index a163933c53..2c1f613f96 100644 --- a/plugins/scaffolder-backend/src/service/rules.ts +++ b/plugins/scaffolder-backend/src/service/rules.ts @@ -141,7 +141,7 @@ export const isTaskOwner = createTaskPermissionRule({ createdBy: z .array(z.string()) .describe( - 'List of creater entity refs; only tasks created by these users will be viewable', + 'List of creator entity refs; only tasks created by these users will be viewable', ), }), apply: (resource, { createdBy }) => { diff --git a/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.test.tsx b/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.test.tsx index 9489321854..6ecb320dab 100644 --- a/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.test.tsx +++ b/plugins/scaffolder-react/src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.test.tsx @@ -35,7 +35,7 @@ describe('TemplateCategoryPicker', () => { it('should post the error to errorApi if an errors is returned', async () => { (useEntityTypeFilter as jest.Mock).mockReturnValue({ - error: new Error('something broked'), + error: new Error('something broken'), }); mockAlertApi.clearAlerts(); @@ -48,7 +48,7 @@ describe('TemplateCategoryPicker', () => { expect(mockAlertApi.getAlerts().length).toBeGreaterThanOrEqual(1); expect(mockAlertApi.getAlerts()[0]).toMatchObject({ - message: expect.stringContaining('something broked'), + message: expect.stringContaining('something broken'), severity: 'error', }); }); diff --git a/plugins/scaffolder/src/alpha/components/TemplateEditorPage/CustomFieldPlayground.tsx b/plugins/scaffolder/src/alpha/components/TemplateEditorPage/CustomFieldPlayground.tsx index fcc77449af..4f5a814c93 100644 --- a/plugins/scaffolder/src/alpha/components/TemplateEditorPage/CustomFieldPlayground.tsx +++ b/plugins/scaffolder/src/alpha/components/TemplateEditorPage/CustomFieldPlayground.tsx @@ -54,7 +54,7 @@ const useStyles = makeStyles( width: '100%', }, }), - { name: 'ScaffolderCustomFieldExtensionsPlaygroud' }, + { name: 'ScaffolderCustomFieldExtensionsPlayground' }, ); export const CustomFieldPlayground = ({ diff --git a/plugins/search-backend-module-elasticsearch/config.d.ts b/plugins/search-backend-module-elasticsearch/config.d.ts index 00af29e372..baf2cc0fbe 100644 --- a/plugins/search-backend-module-elasticsearch/config.d.ts +++ b/plugins/search-backend-module-elasticsearch/config.d.ts @@ -68,7 +68,7 @@ export interface Config { fuzziness?: 'AUTO' | number; /** - * Minimum number of characters that must match exactly at the beginning of the qeury. Defaults to 0. + * Minimum number of characters that must match exactly at the beginning of the query. Defaults to 0. */ prefixLength?: number; }; diff --git a/plugins/search-react/src/components/HighlightedSearchResultText/HighlightedSearchResultText.test.tsx b/plugins/search-react/src/components/HighlightedSearchResultText/HighlightedSearchResultText.test.tsx index 852e47b6cd..2bca34aa06 100644 --- a/plugins/search-react/src/components/HighlightedSearchResultText/HighlightedSearchResultText.test.tsx +++ b/plugins/search-react/src/components/HighlightedSearchResultText/HighlightedSearchResultText.test.tsx @@ -24,7 +24,7 @@ describe('HighlightedSearchResultText', () => { , ); diff --git a/typos.toml b/typos.toml new file mode 100644 index 0000000000..7f6a41114d --- /dev/null +++ b/typos.toml @@ -0,0 +1,60 @@ +[default] +extend-ignore-re = [ + # PEM-encoded key blocks in test fixtures + "(?s)-----BEGIN [A-Z ]+-----.*?-----END [A-Z ]+-----", +] + +[default.extend-words] +# Project-specific acronyms +BUI = "BUI" +Aks = "Aks" +AKS = "AKS" +# Words valid in specific contexts +Hel = "Hel" # truncated string literal in docs/plugins/testing.md code example +requestors = "requestors" # legal/formal variant used intentionally in glossary +TYO = "TYO" # Tokyo IATA code used as clock label in example apps +Damon = "Damon" # person's name (Damon Kaswell) in microsite blog post +Phoen = "Phoen" # GitHub username K-Phoen in plugin metadata +Hashi = "Hashi" # prefix of HashiCorp company name +ba = "ba" # Swedish word in comment in buildDocs.ts +mosquitto = "mosquitto" # correct spelling of the Eclipse Mosquitto MQTT broker +Additiona = "Additiona" # deprecated field name getAdditionaRemoteInfo kept for backward compat +ALLO = "ALLO" # prefix of ALLOWs in AuthorizedSearchEngine.ts comment +VALIDAT = "VALIDAT" # prefix of VALIDATEs in catalog-backend migration comment +styl = "styl" # Stylus stylesheet file extension in jest.js regex pattern +Entitie = "Entitie" # camelCase fragment of starredEntitie$ (RxJS observable naming convention in StarredEntitiesApi) + +[files] +extend-exclude = [ + # Release and changelog files + "README-*.md", + "ADOPTERS.md", + "docs/releases/*", + "**/**/CHANGELOG.md", + "docs-ui/src/utils/changelogs/", + # Binary and generated assets + "docs/assets/**/*.svg", + "plugins/bitbucket-cloud-common/bitbucket-cloud.oas.json", + "plugins/scaffolder-backend/assets/nunjucks.js.txt", + # Locale files with non-English content + "plugins/home/src/homePageComponents/WelcomeTitle/locales/*.json", + # Test files with intentional non-word data (hashes, base64 tokens, crypto keys, etc.) + "packages/backend-defaults/src/entrypoints/auth/authServiceFactory.test.ts", + "packages/backend-defaults/src/entrypoints/auth/external/jwks.test.ts", + "packages/config-loader/src/sources/EnvConfigSource.test.ts", + "packages/core-components/src/components/LogViewer/LogLine.test.tsx", + "packages/core-components/src/layout/ProxiedSignInPage/ProxiedSignInIdentity.test.ts", + "packages/eslint-plugin/src/no-undeclared-imports.test.ts", + "packages/frontend-plugin-api/src/translation/TranslationResource.test.ts", + "packages/frontend-plugin-api/src/translation/__fixtures__/", + "plugins/catalog-backend/src/database/operations/stitcher/buildEntitySearch.test.ts", + "plugins/catalog-backend/src/providers/DefaultLocationStore.test.ts", + "plugins/home/src/homePageComponents/HeaderWorldClock/HeaderWorldClock.test.tsx", + "plugins/scaffolder-backend-module-sentry/src/actions/createProject.examples.test.ts", + "plugins/scaffolder-backend-module-sentry/src/actions/createProject.examples.ts", # fake auth token hashes + "plugins/scaffolder-backend-module-sentry/src/actions/fetchDSN.examples.test.ts", + "plugins/scaffolder-node/src/actions/util.test.ts", + "plugins/scaffolder-react/src/next/lib/schema.test.ts", + "plugins/scaffolder/src/components/RenderSchema/RenderSchema.test.tsx", + "plugins/search-backend-node/src/engines/LunrSearchEngine.test.ts", +]