Fixes for non-breaking typos and typos configuration

Signed-off-by: Andre Wanlin <awanlin@spotify.com> More Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2026-04-29 16:53:20 -05:00
parent 84913005fd
commit 2f33a9f63f
41 changed files with 128 additions and 48 deletions
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-backend-module-gitlab': patch
+---
+
+Fixed typo in code: `Commited` corrected to `Committed` in `GitlabDiscoveryEntityProvider`.
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-kubernetes-backend': patch
+---
+
+Fixed typo in internal variable name: `headerSplitted` corrected to `headerSplit` in `KubernetesProxy`.
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-scaffolder-backend': patch
+---
+
+Fixed typo in internal variable name: `promtStepCount` corrected to `promStepCount` in `NunjucksWorkflowRunner`.
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-scaffolder': patch
+---
+
+Fixed typo in CSS class name: `ScaffolderCustomFieldExtensionsPlaygroud` corrected to `ScaffolderCustomFieldExtensionsPlayground` in `CustomFieldPlayground`.
@@ -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"
@@ -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

@@ -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).
@@ -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
@@ -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**

@@ -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.
@@ -100,7 +100,7 @@ export function prepareRuntimeSharedDependenciesScript(
      return {
        name,
        version: sharedDep.version,
-        lib: name as unknown as () => Promise<unknown>, // Coverted into import below
+        lib: name as unknown as () => Promise<unknown>, // Converted into import below
        shareConfig: {
          singleton: sharedDep.singleton,
          requiredVersion: sharedDep.requiredVersion,
@@ -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,
@@ -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' +
@@ -130,7 +130,7 @@ const gfmRehypePlugins: PluggableList = [
  [
    rehypeRaw,
    {
-      tagFiter: true,
+      tagfilter: true,
    },
  ],
  [
@@ -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;
 };
@@ -278,14 +278,14 @@ describe('createExtension', () => {
    expect(String(extension)).toBe(
      'ExtensionDefinition{attachTo=<plugin>@tabs+page:<plugin>@tabs+<plugin>/index@tabs+page:<plugin>/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:<plugin>@tabs+<plugin>/index@tabs+page:<plugin>/index@otherTabs}',
    );
  });
@@ -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}.
@@ -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);
@@ -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();
  });

@@ -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;
 }
@@ -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',
  },
 ];

@@ -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[] {
@@ -402,7 +402,7 @@ describe('config', () => {
    );
  });

-  it('valid config with empyt topics', () => {
+  it('valid config with empty topics', () => {
    const config = new ConfigReader({
      catalog: {
        providers: {
@@ -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);
@@ -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',
@@ -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.
@@ -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;
@@ -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: {
@@ -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
@@ -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,
@@ -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];
@@ -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]: {
@@ -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]: {
@@ -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',
@@ -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 }) => {
@@ -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',
    });
  });
@@ -54,7 +54,7 @@ const useStyles = makeStyles(
      width: '100%',
    },
  }),
-  { name: 'ScaffolderCustomFieldExtensionsPlaygroud' },
+  { name: 'ScaffolderCustomFieldExtensionsPlayground' },
 );

 export const CustomFieldPlayground = ({
@@ -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;
      };
@@ -24,7 +24,7 @@ describe('HighlightedSearchResultText', () => {
      <HighlightedSearchResultText
        preTag="<tag>"
        postTag="</tag>"
-        text="test <tag>highlighted</tag> restult <tag>text</tag>"
+        text="test <tag>highlighted</tag> result <tag>text</tag>"
      />,
    );

@@ -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",
+]