From aedd4daa661c57b6067d872f67884af461a710b8 Mon Sep 17 00:00:00 2001 From: Dimitris Apostolou Date: Sun, 13 Mar 2022 14:09:19 +0200 Subject: [PATCH 1/3] Fix typos Signed-off-by: Dimitris Apostolou --- ADOPTERS.md | 2 +- docs/architecture-decisions/adr006-avoid-react-fc.md | 2 +- docs/assets/search/architecture.drawio.svg | 2 +- docs/features/kubernetes/configuration.md | 2 +- .../features/software-templates/writing-templates.md | 2 +- docs/local-dev/cli-build-system.md | 2 +- microsite/data/plugins/opsgenie.yaml | 2 +- .../src/database/DatabaseManager.test.ts | 12 ++++++------ .../backend-common/src/database/connection.test.ts | 2 +- .../catalog-model/examples/apis/swapi-graphql.yaml | 2 +- .../src/lib/builder/buildTypeDefinitionsWorker.ts | 2 +- packages/cli/src/lib/diff/types.ts | 2 +- packages/core-app-api/src/app/types.ts | 2 +- packages/core-app-api/src/routing/collectors.tsx | 2 +- .../src/components/EmptyState/EmptyState.test.tsx | 2 +- packages/core-components/src/layout/Sidebar/Page.tsx | 2 +- .../core-components/src/layout/Sidebar/config.ts | 2 +- .../src/apis/definitions/FeatureFlagsApi.ts | 2 +- packages/dev-utils/src/devApp/render.tsx | 2 +- .../src/testUtils/apis/ErrorApi/MockErrorApi.ts | 2 +- plugins/api-docs/dev/graphql-example-api.yaml | 2 +- plugins/badges-backend/src/types.ts | 2 +- plugins/catalog-backend-module-msgraph/config.d.ts | 2 +- .../src/microsoftGraph/client.test.ts | 2 +- .../catalog-backend/src/ingestion/CatalogRules.ts | 2 +- .../modules/codeowners/CodeOwnersProcessor.test.ts | 2 +- .../src/components/EntityRelationsGraph/relations.ts | 2 +- .../src/components/AboutCard/AboutCard.test.tsx | 2 +- plugins/cicd-statistics/src/apis/types.ts | 2 +- .../src/service/converter/cobertura.ts | 2 +- .../src/components/BarChart/BarChart.tsx | 2 +- plugins/cost-insights/src/utils/scroll.tsx | 2 +- .../src/components/Differ.test.tsx | 2 +- .../git-release-manager/src/features/Features.tsx | 2 +- .../jenkins-backend/src/service/jenkinsApi.test.ts | 2 +- .../src/service/jenkinsInfoProvider.ts | 2 +- plugins/jenkins/src/constants.ts | 2 +- plugins/kubernetes-backend/src/types/types.ts | 2 +- .../src/error-detection/error-detection.test.ts | 2 +- .../DashboardSnapshotList/DashboardSnapshot.tsx | 2 +- plugins/permission-common/src/types/api.ts | 4 ++-- plugins/permission-react/src/apis/PermissionApi.ts | 2 +- .../src/actions/fetch/cookiecutter.test.ts | 2 +- .../scaffolder/tasks/NunjucksWorkflowRunner.test.ts | 2 +- plugins/scaffolder/src/types.ts | 2 +- plugins/search-backend-node/src/Scheduler.test.ts | 2 +- .../src/engines/LunrSearchEngine.test.ts | 2 +- .../src/engines/LunrSearchEngine.ts | 2 +- plugins/search/src/components/SearchFilter/hooks.ts | 2 +- .../search/DefaultTechDocsCollatorFactory.test.ts | 2 +- .../techdocs-node/src/stages/publish/helpers.test.ts | 6 +++--- .../src/home/components/Grids/DocsCardGrid.test.tsx | 2 +- plugins/techdocs/src/reader/README.md | 2 +- .../src/components/BuildList/BuildList.test.tsx | 2 +- 54 files changed, 62 insertions(+), 62 deletions(-) diff --git a/ADOPTERS.md b/ADOPTERS.md index 35a0e4ccc3..8647961a5c 100644 --- a/ADOPTERS.md +++ b/ADOPTERS.md @@ -71,7 +71,7 @@ _If you're using Backstage in your organization, please try to add your company | [Signal Iduna Group](https://www.signal-iduna.de/) | [Jonas Thomsen](https://github.com/JoThomsen) | Developer Portal, documentation, monitoring, service catalog for our insurance ecosystem | | [Tradeshift](https://www.tradeshift.com/) | [Soren Mathiasen](https://github.com/sorenmat) | Developer Portal: documentation, monitoring, service templates, service catalog for our micro services | | [Unity](https://unity.com) | [Ted Cordery](https://github.com/TeddyBallGame) | A centralized service catalog with documentation for our service engineers. | -| [PicPay](https://www.picpay.com) | [Luis Baroni](https://github.com/lcsbaroni), [Renata Poluceno](https://github.com/renatapoluceno), [PicPay](https://github.com/picpay) | Developer portal for building services throught templates, service catalog with ownership of services, documentation and metrics providing autonomy and visibility for all. | +| [PicPay](https://www.picpay.com) | [Luis Baroni](https://github.com/lcsbaroni), [Renata Poluceno](https://github.com/renatapoluceno), [PicPay](https://github.com/picpay) | Developer portal for building services through templates, service catalog with ownership of services, documentation and metrics providing autonomy and visibility for all. | | [Epic Games](https://www.epicgames.com) | [Brian Jung](https://github.com/brian-at-epic), [Jeff Goldian](https://github.com/jeffgoldian-Epic) | Developer Portal: Service Catalog, Documentation, Software Templates and more making our internal teams' lives easier! | | [Globo](https://globo.com) | [Carlos Gusmão](https://github.com/caeugusmao), [Guilherme Vierno](https://github.com/vierno), [Denis Aoki](https://github.com/dnsaoki2), [Maycon Dionisio](https://github.com/MayconDionisio), | Reduce the friction of accessing the information engineers need about Globo's digital services through a coherent and centralized experience. | | [QBE](https://www.qbe.com/) | [Daniel Steel](https://github.com/danielsteelqbe), [Pete Jespers](https://github.com/petejespersqbe) | Developer portal allowing our global teams to explore and create applications, documentation and cloud infrastructure easily and quickly 🚀 | diff --git a/docs/architecture-decisions/adr006-avoid-react-fc.md b/docs/architecture-decisions/adr006-avoid-react-fc.md index ea43cb215d..6a7c431655 100644 --- a/docs/architecture-decisions/adr006-avoid-react-fc.md +++ b/docs/architecture-decisions/adr006-avoid-react-fc.md @@ -45,7 +45,7 @@ const GoodComponent = ({ text, children }: GoodProps) => ( ); -/* Or as a shorthand, if no specifc child type is required */ +/* Or as a shorthand, if no specific child type is required */ type GoodProps = PropsWithChildren<{ text: string }>; const GoodComponent = ({ text, children }: GoodProps) => (
diff --git a/docs/assets/search/architecture.drawio.svg b/docs/assets/search/architecture.drawio.svg index 1acad6d74b..d7a8177d1c 100644 --- a/docs/assets/search/architecture.drawio.svg +++ b/docs/assets/search/architecture.drawio.svg @@ -525,7 +525,7 @@
- Compile and Execut... + Compile and Execute... diff --git a/docs/features/kubernetes/configuration.md b/docs/features/kubernetes/configuration.md index 702e0c7736..612f4903d9 100644 --- a/docs/features/kubernetes/configuration.md +++ b/docs/features/kubernetes/configuration.md @@ -255,7 +255,7 @@ CPU/Memory for pods returned by the API server. Defaults to `false`. ##### `exposeDashboard` -This determines wether the `dashboardApp` and `dashboardParameters` should be +This determines whether the `dashboardApp` and `dashboardParameters` should be automatically configured in order to expose the GKE dashboard from the Kubernetes plugin. diff --git a/docs/features/software-templates/writing-templates.md b/docs/features/software-templates/writing-templates.md index 41061d45a3..82604f13bc 100644 --- a/docs/features/software-templates/writing-templates.md +++ b/docs/features/software-templates/writing-templates.md @@ -251,7 +251,7 @@ use `ui:widget: password` or set some properties of `ui:backstage`: type: string ui:backstage: review: - show: false # wont print any info about 'hidden' property on Review Step + show: false # won't print any info about 'hidden' property on Review Step ``` ### The Repository Picker diff --git a/docs/local-dev/cli-build-system.md b/docs/local-dev/cli-build-system.md index be07a67f22..91f4668f4e 100644 --- a/docs/local-dev/cli-build-system.md +++ b/docs/local-dev/cli-build-system.md @@ -66,7 +66,7 @@ These steps are generally kept isolated form each other, with each step focusing on its specific task. For example, we do not do linting or type checking together with the building or bundling. This is so that we can provide more flexibility and avoid duplicate work, improving performance. It is strongly -recommended that as a part of developing withing Backstage you use a code editor +recommended that as a part of developing within Backstage you use a code editor or IDE that has support for formatting, linting, and type checking. Let's dive into a detailed look at each of these steps and how they are diff --git a/microsite/data/plugins/opsgenie.yaml b/microsite/data/plugins/opsgenie.yaml index 43ba040f75..3db06c04c8 100644 --- a/microsite/data/plugins/opsgenie.yaml +++ b/microsite/data/plugins/opsgenie.yaml @@ -3,7 +3,7 @@ title: Opsgenie author: K-Phoen authorUrl: https://github.com/K-Phoen category: Monitoring -description: Opsgenie offers a simple way to associate alerts to components and vizualize incidents. +description: Opsgenie offers a simple way to associate alerts to components and visualize incidents. documentation: https://github.com/K-Phoen/backstage-plugin-opsgenie/ iconUrl: https://avatars.githubusercontent.com/u/1818843?s=200&v=4 npmPackageName: '@k-phoen/backstage-plugin-opsgenie' diff --git a/packages/backend-common/src/database/DatabaseManager.test.ts b/packages/backend-common/src/database/DatabaseManager.test.ts index 2b2cc17f91..ea8aca38ea 100644 --- a/packages/backend-common/src/database/DatabaseManager.test.ts +++ b/packages/backend-common/src/database/DatabaseManager.test.ts @@ -93,7 +93,7 @@ describe('DatabaseManager', () => { plugin: { testdbname: { connection: { - database: 'database_name_overriden', + database: 'database_name_overridden', }, }, differentclient: { @@ -304,10 +304,10 @@ describe('DatabaseManager', () => { const mockCalls = mocked(createDatabaseClient).mock.calls.splice(-1); const [_baseConfig, overrides] = mockCalls[0]; - // simple case where only database name is overriden + // simple case where only database name is overridden expect(overrides).toMatchObject({ connection: { - database: 'database_name_overriden', + database: 'database_name_overridden', }, }); }); @@ -581,7 +581,7 @@ describe('DatabaseManager', () => { plugin: { testdbname: { connection: { - database: 'database_name_overriden', + database: 'database_name_overridden', host: 'newhost', }, }, @@ -599,7 +599,7 @@ describe('DatabaseManager', () => { expect(baseConfig.get()).toMatchObject({ client: 'pg', connection: { - database: 'database_name_overriden', + database: 'database_name_overridden', host: 'newhost', user: 'foo', password: 'bar', @@ -608,7 +608,7 @@ describe('DatabaseManager', () => { expect(overrides).toHaveProperty('searchPath', ['testdbname']); expect(overrides).toHaveProperty( 'connection.database', - 'database_name_overriden', + 'database_name_overridden', ); }); diff --git a/packages/backend-common/src/database/connection.test.ts b/packages/backend-common/src/database/connection.test.ts index cb65113a9c..044f807576 100644 --- a/packages/backend-common/src/database/connection.test.ts +++ b/packages/backend-common/src/database/connection.test.ts @@ -193,7 +193,7 @@ describe('database connection', () => { }); describe('ensureSchemaExists', () => { - it('returns sucessfully with pg client', async () => { + it('returns successfully with pg client', async () => { await ensureSchemaExists( new ConfigReader({ client: 'pg', diff --git a/packages/catalog-model/examples/apis/swapi-graphql.yaml b/packages/catalog-model/examples/apis/swapi-graphql.yaml index f3d924fc53..ccddc537e7 100644 --- a/packages/catalog-model/examples/apis/swapi-graphql.yaml +++ b/packages/catalog-model/examples/apis/swapi-graphql.yaml @@ -529,7 +529,7 @@ spec: terrains: [String] """ - The percentage of the planet surface that is naturally occuring water or bodies + The percentage of the planet surface that is naturally occurring water or bodies of water. """ surfaceWater: Float diff --git a/packages/cli/src/lib/builder/buildTypeDefinitionsWorker.ts b/packages/cli/src/lib/builder/buildTypeDefinitionsWorker.ts index 43e5cbc526..2533131a40 100644 --- a/packages/cli/src/lib/builder/buildTypeDefinitionsWorker.ts +++ b/packages/cli/src/lib/builder/buildTypeDefinitionsWorker.ts @@ -16,7 +16,7 @@ /** * NOTE: This is a worker thread function that is stringified and executed - * withing a `worker_threads.Worker`. Everything in this function must + * within a `worker_threads.Worker`. Everything in this function must * be self-contained. * Using TypeScript is fine as it is transpiled before being stringified. */ diff --git a/packages/cli/src/lib/diff/types.ts b/packages/cli/src/lib/diff/types.ts index d22d690196..ba649f66ff 100644 --- a/packages/cli/src/lib/diff/types.ts +++ b/packages/cli/src/lib/diff/types.ts @@ -19,7 +19,7 @@ export type WriteFileFunc = (contents: string) => Promise; export type FileDiff = { // Relative path within the target directory path: string; - // Wether the target file exists in the target directory. + // Whether the target file exists in the target directory. missing: boolean; // Contents of the file in the target directory, or an empty string if the file is missing. targetContents: string; diff --git a/packages/core-app-api/src/app/types.ts b/packages/core-app-api/src/app/types.ts index 902e64c09f..ff7a43d0eb 100644 --- a/packages/core-app-api/src/app/types.ts +++ b/packages/core-app-api/src/app/types.ts @@ -190,7 +190,7 @@ export type AppOptions = { /** * A collection of ApiFactories to register in the application as default APIs. - * Theses APIs can not be overridden by plugin factories, but can be overridden + * These APIs cannot be overridden by plugin factories, but can be overridden * by plugin APIs provided through the * A collection of ApiFactories to register in the application to either * add new ones, or override factories provided by default or by plugins. diff --git a/packages/core-app-api/src/routing/collectors.tsx b/packages/core-app-api/src/routing/collectors.tsx index 320f1a66d8..46734707a6 100644 --- a/packages/core-app-api/src/routing/collectors.tsx +++ b/packages/core-app-api/src/routing/collectors.tsx @@ -93,7 +93,7 @@ export const routeParentCollector = createCollector( acc.set(routeRef, parentRouteRef.sticky); // When we encounter a mount point with an explicit path, we stop gathering - // mount points withing the children and remove the sticky state + // mount points within the children and remove the sticky state if (node.props?.path) { nextParent = routeRef; } else { diff --git a/packages/core-components/src/components/EmptyState/EmptyState.test.tsx b/packages/core-components/src/components/EmptyState/EmptyState.test.tsx index 620e8d4d31..6487fcf4e6 100644 --- a/packages/core-components/src/components/EmptyState/EmptyState.test.tsx +++ b/packages/core-components/src/components/EmptyState/EmptyState.test.tsx @@ -20,7 +20,7 @@ import { renderWithEffects, wrapInTestApp } from '@backstage/test-utils'; import Button from '@material-ui/core/Button'; describe('', () => { - it('render EmptyState component with type annotaion is missing', async () => { + it('render EmptyState component with type annotation is missing', async () => { const rendered = await renderWithEffects( wrapInTestApp( ({ isOpen: false, diff --git a/packages/core-plugin-api/src/apis/definitions/FeatureFlagsApi.ts b/packages/core-plugin-api/src/apis/definitions/FeatureFlagsApi.ts index ac43bbebe8..946bd1d37a 100644 --- a/packages/core-plugin-api/src/apis/definitions/FeatureFlagsApi.ts +++ b/packages/core-plugin-api/src/apis/definitions/FeatureFlagsApi.ts @@ -17,7 +17,7 @@ import { ApiRef, createApiRef } from '../system'; /** - * Fetaure flag descriptor. + * Feature flag descriptor. * * @public */ diff --git a/packages/dev-utils/src/devApp/render.tsx b/packages/dev-utils/src/devApp/render.tsx index 36d6abcfd1..9f9fcd8ca6 100644 --- a/packages/dev-utils/src/devApp/render.tsx +++ b/packages/dev-utils/src/devApp/render.tsx @@ -148,7 +148,7 @@ export class DevAppBuilder { } /** - * Adds an array of themes to overide the default theme. + * Adds an array of themes to override the default theme. */ addThemes(themes: AppTheme[]) { this.themes = themes; diff --git a/packages/test-utils/src/testUtils/apis/ErrorApi/MockErrorApi.ts b/packages/test-utils/src/testUtils/apis/ErrorApi/MockErrorApi.ts index 96918b4e47..c7c8556355 100644 --- a/packages/test-utils/src/testUtils/apis/ErrorApi/MockErrorApi.ts +++ b/packages/test-utils/src/testUtils/apis/ErrorApi/MockErrorApi.ts @@ -54,7 +54,7 @@ const nullObservable = { /** * Mock implementation of the {@link core-plugin-api#ErrorApi} to be used in tests. - * Incudes withForError and getErrors methods for error testing. + * Includes withForError and getErrors methods for error testing. * @public */ export class MockErrorApi implements ErrorApi { diff --git a/plugins/api-docs/dev/graphql-example-api.yaml b/plugins/api-docs/dev/graphql-example-api.yaml index f3d924fc53..ccddc537e7 100644 --- a/plugins/api-docs/dev/graphql-example-api.yaml +++ b/plugins/api-docs/dev/graphql-example-api.yaml @@ -529,7 +529,7 @@ spec: terrains: [String] """ - The percentage of the planet surface that is naturally occuring water or bodies + The percentage of the planet surface that is naturally occurring water or bodies of water. """ surfaceWater: Float diff --git a/plugins/badges-backend/src/types.ts b/plugins/badges-backend/src/types.ts index 4342a5af40..0467b18155 100644 --- a/plugins/badges-backend/src/types.ts +++ b/plugins/badges-backend/src/types.ts @@ -44,7 +44,7 @@ export interface Badge { link?: string; /** Badge message */ message: string; - /** Badge style (apperance). One of "plastic", "flat", "flat-square", "for-the-badge" and "social" */ + /** Badge style (appearance). One of "plastic", "flat", "flat-square", "for-the-badge" and "social" */ style?: BadgeStyle; } diff --git a/plugins/catalog-backend-module-msgraph/config.d.ts b/plugins/catalog-backend-module-msgraph/config.d.ts index d47abf60bb..db5ab81c4b 100644 --- a/plugins/catalog-backend-module-msgraph/config.d.ts +++ b/plugins/catalog-backend-module-msgraph/config.d.ts @@ -58,7 +58,7 @@ export interface Config { clientSecret: string; // TODO: Consider not making these config options and pass them in the - // constructor instead. They are probably not environment specifc, so + // constructor instead. They are probably not environment specific, so // they could also be configured "in code". /** diff --git a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.test.ts b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.test.ts index 467b03733e..5ff4fa4e0e 100644 --- a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.test.ts +++ b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.test.ts @@ -157,7 +157,7 @@ describe('MicrosoftGraphClient', () => { expect(userProfile).toEqual({ surname: 'Example' }); }); - it('should throw expection if load user profile fails', async () => { + it('should throw exception if load user profile fails', async () => { worker.use( rest.get('https://example.com/users/user-id', (_, res, ctx) => res(ctx.status(404)), diff --git a/plugins/catalog-backend/src/ingestion/CatalogRules.ts b/plugins/catalog-backend/src/ingestion/CatalogRules.ts index e4bfdb8d0f..376ea128b7 100644 --- a/plugins/catalog-backend/src/ingestion/CatalogRules.ts +++ b/plugins/catalog-backend/src/ingestion/CatalogRules.ts @@ -131,7 +131,7 @@ export class DefaultCatalogRulesEnforcer implements CatalogRulesEnforcer { constructor(private readonly rules: CatalogRule[]) {} /** - * Checks wether a specific entity/location combination is allowed + * Checks whether a specific entity/location combination is allowed * according to the configured rules. */ isAllowed(entity: Entity, location: LocationSpec) { diff --git a/plugins/catalog-backend/src/modules/codeowners/CodeOwnersProcessor.test.ts b/plugins/catalog-backend/src/modules/codeowners/CodeOwnersProcessor.test.ts index 8cf250de2a..ac4415549e 100644 --- a/plugins/catalog-backend/src/modules/codeowners/CodeOwnersProcessor.test.ts +++ b/plugins/catalog-backend/src/modules/codeowners/CodeOwnersProcessor.test.ts @@ -76,7 +76,7 @@ describe('CodeOwnersProcessor', () => { expect(result).toEqual(entity); }); - it('should ingore invalid locations type', async () => { + it('should ignore invalid locations type', async () => { const { entity, processor } = setupTest(); const result = await processor.preProcessEntity( diff --git a/plugins/catalog-graph/src/components/EntityRelationsGraph/relations.ts b/plugins/catalog-graph/src/components/EntityRelationsGraph/relations.ts index ed847d7143..44352040ae 100644 --- a/plugins/catalog-graph/src/components/EntityRelationsGraph/relations.ts +++ b/plugins/catalog-graph/src/components/EntityRelationsGraph/relations.ts @@ -38,7 +38,7 @@ import { */ export type RelationPairs = [string, string][]; -// TODO: This file only contains the pairs for the build-in relations. +// TODO: This file only contains the pairs for the built-in relations. // How to implement this when custom relations are used? Right now you can pass // the relations everywhere. // Another option is to move this into @backstage/catalog-model diff --git a/plugins/catalog/src/components/AboutCard/AboutCard.test.tsx b/plugins/catalog/src/components/AboutCard/AboutCard.test.tsx index 9a878e3b60..563ccd0cd7 100644 --- a/plugins/catalog/src/components/AboutCard/AboutCard.test.tsx +++ b/plugins/catalog/src/components/AboutCard/AboutCard.test.tsx @@ -448,7 +448,7 @@ describe('', () => { expect(getByText('View TechDocs').closest('a')).not.toHaveAttribute('href'); }); - it('renders disbaled techdocs link when route is not bound', async () => { + it('renders disabled techdocs link when route is not bound', async () => { const entity = { apiVersion: 'v1', kind: 'Component', diff --git a/plugins/cicd-statistics/src/apis/types.ts b/plugins/cicd-statistics/src/apis/types.ts index 0a87b40fc2..32d9d3f2df 100644 --- a/plugins/cicd-statistics/src/apis/types.ts +++ b/plugins/cicd-statistics/src/apis/types.ts @@ -47,7 +47,7 @@ export const statusTypes: Array = [ /** * The branch enum of either 'master' or 'branch' (or possibly the meta 'all'). * - * The concept of what constitues a master branch is generic. It might be called + * The concept of what constitutes a master branch is generic. It might be called * something like 'release' or 'main' or 'trunk' in the underlying CI/CD system, * which is then up to the Api to map accordingly. */ diff --git a/plugins/code-coverage-backend/src/service/converter/cobertura.ts b/plugins/code-coverage-backend/src/service/converter/cobertura.ts index e7f7490304..025d40a4f6 100644 --- a/plugins/code-coverage-backend/src/service/converter/cobertura.ts +++ b/plugins/code-coverage-backend/src/service/converter/cobertura.ts @@ -27,7 +27,7 @@ export class Cobertura implements Converter { * convert cobertura into shared json coverage format * * @param xml - cobertura xml object - * @param scmFiles - list of files that are commited to SCM + * @param scmFiles - list of files that are committed to SCM */ convert(xml: CoberturaXML, scmFiles: string[]): FileEntry[] { const ppc = xml.coverage.packages diff --git a/plugins/cost-insights/src/components/BarChart/BarChart.tsx b/plugins/cost-insights/src/components/BarChart/BarChart.tsx index 98a2410b7b..27ef69db7a 100644 --- a/plugins/cost-insights/src/components/BarChart/BarChart.tsx +++ b/plugins/cost-insights/src/components/BarChart/BarChart.tsx @@ -104,7 +104,7 @@ export const BarChart = ({ .slice(stepStart, stepEnd); // Pin the domain to the largest value in the series. - // Intentially redundant - This could simply be derived from the first element in the already sorted list, + // Intentionally redundant - This could simply be derived from the first element in the already sorted list, // but that may not be the case in the future when custom sorting is implemented. const globalResourcesMax = resources.reduce( (max, r: ResourceData) => Math.max(max, r.current, r.previous), diff --git a/plugins/cost-insights/src/utils/scroll.tsx b/plugins/cost-insights/src/utils/scroll.tsx index 1cf824aeda..65fce35174 100644 --- a/plugins/cost-insights/src/utils/scroll.tsx +++ b/plugins/cost-insights/src/utils/scroll.tsx @@ -17,7 +17,7 @@ import React, { useEffect, useRef } from 'react'; import { ScrollTo, useScroll } from '../hooks/useScroll'; /* - Utility component use in conjuction with useScroll that allows scrollable components to control behavior and offset. + Utility component use in conjunction with useScroll that allows scrollable components to control behavior and offset. 1. ScrollAnchor must be a direct child of a scrollable component. 2. ScrollAnchor's parent position must be relative. 3. ScrollAnchor's id must be unique. diff --git a/plugins/git-release-manager/src/components/Differ.test.tsx b/plugins/git-release-manager/src/components/Differ.test.tsx index 20483767b4..a5af1c893e 100644 --- a/plugins/git-release-manager/src/components/Differ.test.tsx +++ b/plugins/git-release-manager/src/components/Differ.test.tsx @@ -52,7 +52,7 @@ describe('Differ', () => { expect(next).not.toBeInTheDocument(); }); - it('should render icon & current & next (with seperator)', () => { + it('should render icon & current & next (with separator)', () => { const { getByTestId, queryByTestId } = render( - Error occured while fetching information for "{project.owner}/ + Error occurred while fetching information for "{project.owner}/ {project.repo}" ({gitBatchInfo.error.message}) ); diff --git a/plugins/jenkins-backend/src/service/jenkinsApi.test.ts b/plugins/jenkins-backend/src/service/jenkinsApi.test.ts index 45f7424e40..d1625cb65e 100644 --- a/plugins/jenkins-backend/src/service/jenkinsApi.test.ts +++ b/plugins/jenkins-backend/src/service/jenkinsApi.test.ts @@ -332,7 +332,7 @@ describe('JenkinsApi', () => { const result = await jenkinsApi.getProjects(jenkinsInfo); expect(result).toHaveLength(1); - // TODO: I am really just asserting the previous behaviour wth no understanding here. + // TODO: I am really just asserting the previous behaviour with no understanding here. // In my 2 Jenkins instances, 1 returns a lot of different and confusing BuildData sections and 1 returns none ☹️ expect(result[0].lastBuild!.source).toEqual({ branchName: 'master', diff --git a/plugins/jenkins-backend/src/service/jenkinsInfoProvider.ts b/plugins/jenkins-backend/src/service/jenkinsInfoProvider.ts index a88dbf965e..d9a97e2f2d 100644 --- a/plugins/jenkins-backend/src/service/jenkinsInfoProvider.ts +++ b/plugins/jenkins-backend/src/service/jenkinsInfoProvider.ts @@ -97,7 +97,7 @@ export class JenkinsConfig { const unnamedAllPresent = baseUrl && username && apiKey; if (!(unnamedAllPresent || unnamedNonePresent)) { throw new Error( - `Found partial default jenkins config. All (or none) of baseUrl, username ans apiKey must be provided.`, + `Found partial default jenkins config. All (or none) of baseUrl, username and apiKey must be provided.`, ); } diff --git a/plugins/jenkins/src/constants.ts b/plugins/jenkins/src/constants.ts index e1be37ee46..53978bc8f6 100644 --- a/plugins/jenkins/src/constants.ts +++ b/plugins/jenkins/src/constants.ts @@ -14,6 +14,6 @@ * limitations under the License. */ export const JENKINS_ANNOTATION = 'jenkins.io/job-full-name'; -// @deprecated The legacy annotation used for identifing Jenkins jobs, use +// @deprecated The legacy annotation used for identifying Jenkins jobs, use // JENKINS_ANNOTATION instead. export const LEGACY_JENKINS_ANNOTATION = 'jenkins.io/github-folder'; diff --git a/plugins/kubernetes-backend/src/types/types.ts b/plugins/kubernetes-backend/src/types/types.ts index 4f25805063..37c26956fe 100644 --- a/plugins/kubernetes-backend/src/types/types.ts +++ b/plugins/kubernetes-backend/src/types/types.ts @@ -110,7 +110,7 @@ export interface ClusterDetails { * @remarks * Note that you should specify the app used for the dashboard * using the dashboardApp property, in order to properly format - * links to kubernetes resources, otherwise it will assume that you're running the standard one. + * links to kubernetes resources, otherwise it will assume that you're running the standard one. * @see dashboardApp * @see dashboardParameters */ diff --git a/plugins/kubernetes/src/error-detection/error-detection.test.ts b/plugins/kubernetes/src/error-detection/error-detection.test.ts index dcac7db907..ef64ff6a20 100644 --- a/plugins/kubernetes/src/error-detection/error-detection.test.ts +++ b/plugins/kubernetes/src/error-detection/error-detection.test.ts @@ -231,7 +231,7 @@ describe('detectErrors', () => { expect(errors).toBeDefined(); expect(errors).toHaveLength(0); }); - it('should detect in deployment which cant progress', () => { + it('should detect in deployment which cannot progress', () => { const result = detectErrors(oneDeployment(failingDeploy as any)); expect(result.size).toBe(1); diff --git a/plugins/newrelic-dashboard/src/components/NewRelicDashboard/DashboardSnapshotList/DashboardSnapshot.tsx b/plugins/newrelic-dashboard/src/components/NewRelicDashboard/DashboardSnapshotList/DashboardSnapshot.tsx index 0b6a676f52..69608833f7 100644 --- a/plugins/newrelic-dashboard/src/components/NewRelicDashboard/DashboardSnapshotList/DashboardSnapshot.tsx +++ b/plugins/newrelic-dashboard/src/components/NewRelicDashboard/DashboardSnapshotList/DashboardSnapshot.tsx @@ -71,7 +71,7 @@ export const DashboardSnapshot = ({ src={url} /> ) : ( - 'Dashboard loading... , click here to open if it didnt render correctly' + 'Dashboard loading... , click here to open if it did not render correctly' )} diff --git a/plugins/permission-common/src/types/api.ts b/plugins/permission-common/src/types/api.ts index e0ab1f1642..5b46b955d8 100644 --- a/plugins/permission-common/src/types/api.ts +++ b/plugins/permission-common/src/types/api.ts @@ -79,7 +79,7 @@ export type PermissionCondition = { type NonEmptyArray = [T, ...T[]]; /** - * Represnts a logical AND for the provided criteria. + * Represents a logical AND for the provided criteria. * @public */ export type AllOfCriteria = { @@ -87,7 +87,7 @@ export type AllOfCriteria = { }; /** - * Represnts a logical OR for the provided criteria. + * Represents a logical OR for the provided criteria. * @public */ export type AnyOfCriteria = { diff --git a/plugins/permission-react/src/apis/PermissionApi.ts b/plugins/permission-react/src/apis/PermissionApi.ts index b17350c38e..69a42cae91 100644 --- a/plugins/permission-react/src/apis/PermissionApi.ts +++ b/plugins/permission-react/src/apis/PermissionApi.ts @@ -21,7 +21,7 @@ import { import { ApiRef, createApiRef } from '@backstage/core-plugin-api'; /** - * This API is used by various frontend utilities that allow developers to implement authorization wihtin their frontend + * This API is used by various frontend utilities that allow developers to implement authorization within their frontend * plugins. A plugin developer will likely not have to interact with this API or its implementations directly, but * rather with the aforementioned utility components/hooks. * @public diff --git a/plugins/scaffolder-backend-module-cookiecutter/src/actions/fetch/cookiecutter.test.ts b/plugins/scaffolder-backend-module-cookiecutter/src/actions/fetch/cookiecutter.test.ts index 18a6722663..8c501cf8f1 100644 --- a/plugins/scaffolder-backend-module-cookiecutter/src/actions/fetch/cookiecutter.test.ts +++ b/plugins/scaffolder-backend-module-cookiecutter/src/actions/fetch/cookiecutter.test.ts @@ -115,7 +115,7 @@ describe('fetch:cookiecutter', () => { }); }); - // Mock when executeShellCommand is called it creats some new files in the mock filesystem + // Mock when executeShellCommand is called it creates some new files in the mock filesystem executeShellCommand.mockImplementation(async () => { mockFs({ [`${join(mockTmpDir, 'intermediate')}`]: { diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts index 1b635b695c..61df2a167d 100644 --- a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts +++ b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts @@ -339,7 +339,7 @@ describe('DefaultWorkflowRunner', () => { expect(logger.error).not.toHaveBeenCalled(); }); - it('should keep the original types for the input and not parse things that arent meant to be parsed', async () => { + it('should keep the original types for the input and not parse things that are not meant to be parsed', async () => { const task = createMockTaskWithSpec({ apiVersion: 'scaffolder.backstage.io/v1beta3', steps: [ diff --git a/plugins/scaffolder/src/types.ts b/plugins/scaffolder/src/types.ts index a542a8a473..bddd6a7b70 100644 --- a/plugins/scaffolder/src/types.ts +++ b/plugins/scaffolder/src/types.ts @@ -73,7 +73,7 @@ export type ScaffolderTaskOutput = { /** * The shape of each entry of parameters which gets rendered - * as a seperate step in the wizard input + * as a separate step in the wizard input * * @public */ diff --git a/plugins/search-backend-node/src/Scheduler.test.ts b/plugins/search-backend-node/src/Scheduler.test.ts index d5f671358a..de6add13fe 100644 --- a/plugins/search-backend-node/src/Scheduler.test.ts +++ b/plugins/search-backend-node/src/Scheduler.test.ts @@ -61,7 +61,7 @@ describe('Scheduler', () => { // Stop scheduling process testScheduler.stop(); - // Should't throw error, as it is stopped. + // Shouldn't throw error, as it is stopped. expect(() => testScheduler.addToSchedule(mockTask2, 4), ).not.toThrowError(); diff --git a/plugins/search-backend-node/src/engines/LunrSearchEngine.test.ts b/plugins/search-backend-node/src/engines/LunrSearchEngine.test.ts index 46aaf47c60..b0bd2bca8f 100644 --- a/plugins/search-backend-node/src/engines/LunrSearchEngine.test.ts +++ b/plugins/search-backend-node/src/engines/LunrSearchEngine.test.ts @@ -932,7 +932,7 @@ describe('LunrSearchEngine', () => { }); inspectableSearchEngine.setDocStore({ 'existing-location': doc }); - // Mock methds called by close handler. + // Mock methods called by close handler. indexerMock.buildIndex.mockReturnValueOnce('expected-index'); indexerMock.getDocumentStore.mockReturnValueOnce({ 'new-location': doc, diff --git a/plugins/search-backend-node/src/engines/LunrSearchEngine.ts b/plugins/search-backend-node/src/engines/LunrSearchEngine.ts index b642647466..b1d695ad1d 100644 --- a/plugins/search-backend-node/src/engines/LunrSearchEngine.ts +++ b/plugins/search-backend-node/src/engines/LunrSearchEngine.ts @@ -68,7 +68,7 @@ export class LunrSearchEngine implements SearchEngine { lunrQueryBuilder: q => { const termToken = lunr.tokenizer(term); - // Support for typeahead seach is based on https://github.com/olivernn/lunr.js/issues/256#issuecomment-295407852 + // Support for typeahead search is based on https://github.com/olivernn/lunr.js/issues/256#issuecomment-295407852 // look for an exact match and apply a large positive boost q.term(termToken, { usePipeline: true, diff --git a/plugins/search/src/components/SearchFilter/hooks.ts b/plugins/search/src/components/SearchFilter/hooks.ts index 7b27ac1fe2..217e65d1c0 100644 --- a/plugins/search/src/components/SearchFilter/hooks.ts +++ b/plugins/search/src/components/SearchFilter/hooks.ts @@ -43,7 +43,7 @@ export const useAsyncFilterValues = ( // for the lifetime of the hook/component. if (valuesMemo.current[inputValue] === undefined) { valuesMemo.current[inputValue] = callback(inputValue).then(values => { - // Overrite the value for future immediate returns. + // Override the value for future immediate returns. valuesMemo.current[inputValue] = values; return values; }); diff --git a/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.test.ts b/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.test.ts index 291f21a0d1..659f4783ce 100644 --- a/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.test.ts +++ b/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.test.ts @@ -203,7 +203,7 @@ describe('DefaultTechDocsCollatorFactory', () => { const pipeline = TestPipeline.withSubject(collator); const { documents } = await pipeline.execute(); - // Only 1 entity with TechDocs configured multipled by 3 pages. + // Only 1 entity with TechDocs configured multiplied by 3 pages. expect(documents).toHaveLength(3); }); diff --git a/plugins/techdocs-node/src/stages/publish/helpers.test.ts b/plugins/techdocs-node/src/stages/publish/helpers.test.ts index 7acdb47ea7..ceb1b02a20 100644 --- a/plugins/techdocs-node/src/stages/publish/helpers.test.ts +++ b/plugins/techdocs-node/src/stages/publish/helpers.test.ts @@ -216,7 +216,7 @@ describe('getCloudPathForLocalPath', () => { ); }); - it('should add trailing seperator to root directory', () => { + it('should add trailing separator to root directory', () => { const localPath = 'index/html'; const rootPath = 'backstage-data/techdocs'; const remoteBucket = getCloudPathForLocalPath( @@ -230,7 +230,7 @@ describe('getCloudPathForLocalPath', () => { ); }); - it('should remove leading seperator from root directory', () => { + it('should remove leading separator from root directory', () => { const localPath = 'index/html'; const rootPath = '/backstage-data/techdocs/'; const remoteBucket = getCloudPathForLocalPath( @@ -244,7 +244,7 @@ describe('getCloudPathForLocalPath', () => { ); }); - it('should ignore seperator if root directory is explicitly defined', () => { + it('should ignore separator if root directory is explicitly defined', () => { const localPath = 'index/html'; const rootPath = '/'; const remoteBucket = getCloudPathForLocalPath( diff --git a/plugins/techdocs/src/home/components/Grids/DocsCardGrid.test.tsx b/plugins/techdocs/src/home/components/Grids/DocsCardGrid.test.tsx index 311f83544a..0891ddcfd3 100644 --- a/plugins/techdocs/src/home/components/Grids/DocsCardGrid.test.tsx +++ b/plugins/techdocs/src/home/components/Grids/DocsCardGrid.test.tsx @@ -45,7 +45,7 @@ describe('Entity Docs Card Grid', () => { jest.resetAllMocks(); }); - it('should render all entities passed ot it', async () => { + it('should render all entities passed to it', async () => { const { findByText, findAllByRole } = render( wrapInTestApp( { return dom => { - // Change the first occurance of H1 to say "TechDocs!" + // Change the first occurrence of H1 to say "TechDocs!" dom.querySelector('h1')?.innerHTML = 'TechDocs!'; return dom; diff --git a/plugins/xcmetrics/src/components/BuildList/BuildList.test.tsx b/plugins/xcmetrics/src/components/BuildList/BuildList.test.tsx index 53471f5e9f..d03555f5e2 100644 --- a/plugins/xcmetrics/src/components/BuildList/BuildList.test.tsx +++ b/plugins/xcmetrics/src/components/BuildList/BuildList.test.tsx @@ -53,7 +53,7 @@ describe('BuildList', () => { ); userEvent.click( - (await rendered.findAllByLabelText('Detail panel visiblity toggle'))[0], + (await rendered.findAllByLabelText('Detail panel visibility toggle'))[0], ); expect(await rendered.findByText('BuildDetails')).toBeInTheDocument(); }); From f24ef7864e38e99c8c238b6e2674f8848b7d29a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Mon, 14 Mar 2022 09:33:11 +0100 Subject: [PATCH 2/3] add changeset MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/sixty-countries-peel.md | 38 ++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .changeset/sixty-countries-peel.md diff --git a/.changeset/sixty-countries-peel.md b/.changeset/sixty-countries-peel.md new file mode 100644 index 0000000000..fbb539ef86 --- /dev/null +++ b/.changeset/sixty-countries-peel.md @@ -0,0 +1,38 @@ +--- +'@backstage/backend-common': patch +'@backstage/catalog-model': patch +'@backstage/cli': patch +'@backstage/core-app-api': patch +'@backstage/core-components': patch +'@backstage/core-plugin-api': patch +'@backstage/dev-utils': patch +'@backstage/test-utils': patch +'@backstage/plugin-api-docs': patch +'@backstage/plugin-badges-backend': patch +'@backstage/plugin-catalog': patch +'@backstage/plugin-catalog-backend': patch +'@backstage/plugin-catalog-backend-module-msgraph': patch +'@backstage/plugin-catalog-graph': patch +'@backstage/plugin-cicd-statistics': patch +'@backstage/plugin-code-coverage-backend': patch +'@backstage/plugin-cost-insights': patch +'@backstage/plugin-git-release-manager': patch +'@backstage/plugin-jenkins': patch +'@backstage/plugin-jenkins-backend': patch +'@backstage/plugin-kubernetes': patch +'@backstage/plugin-kubernetes-backend': patch +'@backstage/plugin-newrelic-dashboard': patch +'@backstage/plugin-permission-common': patch +'@backstage/plugin-permission-react': patch +'@backstage/plugin-scaffolder': patch +'@backstage/plugin-scaffolder-backend': patch +'@backstage/plugin-scaffolder-backend-module-cookiecutter': patch +'@backstage/plugin-search': patch +'@backstage/plugin-search-backend-node': patch +'@backstage/plugin-techdocs': patch +'@backstage/plugin-techdocs-backend': patch +'@backstage/plugin-techdocs-node': patch +'@backstage/plugin-xcmetrics': patch +--- + +Minor typo fixes From d24039a2528565f87aed4b8e44e5053941a92dfb Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 15 Mar 2022 10:11:19 +0100 Subject: [PATCH 3/3] chore: spelling mistake from library needs to be honoured Signed-off-by: blam --- plugins/xcmetrics/src/components/BuildList/BuildList.test.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/xcmetrics/src/components/BuildList/BuildList.test.tsx b/plugins/xcmetrics/src/components/BuildList/BuildList.test.tsx index d03555f5e2..53471f5e9f 100644 --- a/plugins/xcmetrics/src/components/BuildList/BuildList.test.tsx +++ b/plugins/xcmetrics/src/components/BuildList/BuildList.test.tsx @@ -53,7 +53,7 @@ describe('BuildList', () => { ); userEvent.click( - (await rendered.findAllByLabelText('Detail panel visibility toggle'))[0], + (await rendered.findAllByLabelText('Detail panel visiblity toggle'))[0], ); expect(await rendered.findByText('BuildDetails')).toBeInTheDocument(); });