paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 27 Packages Projects Releases Wiki Activity

Merge pull request #8982 from backstage/rugvip/tsbump

Browse Source 
Upgrade TypeScript to 4.5 and decouple versioning
This commit is contained in:
Patrik Oldsberg
2022-01-18 14:01:32 +01:00
committed by GitHub
parent b4e6325654 d45cb13107
commit a57bee1a02
13 changed files with 155 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/clever-olives-shake.md
+40
View File
@@ -0,0 +1,40 @@
---
'@backstage/cli': minor
---
Removed the `typescript` dependency from the Backstage CLI in order to decouple the TypeScript version in Backstage projects. To keep using a specific TypeScript version, be sure to add an explicit dependency in your root `package.json`:
```json
"dependencies": {
...
"typescript": "~4.5.4",
}
```
We recommend using a `~` version range since TypeScript releases do not adhere to semver.
It may be the case that you end up with errors if you upgrade the TypeScript version. This is because there was a change to TypeScript not long ago that defaulted the type of errors caught in `catch` blocks to `unknown`. You can work around this by adding `"useUnknownInCatchVariables": false` to the `"compilerOptions"` in your `tsconfig.json`:
```json
"compilerOptions": {
...
"useUnknownInCatchVariables": false
}
```
Another option is to use the utilities from `@backstage/errors` to assert the type of errors caught in `catch` blocks:
```ts
import { assertError, isError } from '@backstage/errors';
try {
...
} catch (error) {
assertError(error);
...
// OR
if (isError(error)) {
...
}
}
```
.changeset/stupid-baboons-hug.md
+42
View File
@@ -0,0 +1,42 @@
---
'@backstage/create-app': patch
---
The app template has been updated to add an explicit dependency on `typescript` in the root `package.json`. This is because it was removed as a dependency of `@backstage/cli` in order to decouple the TypeScript versioning in Backstage projects.
To apply this change in an existing app, add a `typescript` dependency to your `package.json` in the project root:
```json
"dependencies": {
...
"typescript": "~4.5.4",
}
```
We recommend using a `~` version range since TypeScript releases do not adhere to semver.
It may be the case that you end up with errors if you upgrade the TypeScript version. This is because there was a change to TypeScript not long ago that defaulted the type of errors caught in `catch` blocks to `unknown`. You can work around this by adding `"useUnknownInCatchVariables": false` to the `"compilerOptions"` in your `tsconfig.json`:
```json
"compilerOptions": {
...
"useUnknownInCatchVariables": false
}
```
Another option is to use the utilities from `@backstage/errors` to assert the type of errors caught in `catch` blocks:
```ts
import { assertError, isError } from '@backstage/errors';
try {
...
} catch (error) {
assertError(error);
...
// OR
if (isError(error)) {
...
}
}
```
package.json
+1 -1
View File
@@ -79,7 +79,7 @@
"prettier": "^2.2.1",
"shx": "^0.3.2",
"ts-node": "^10.4.0",
"typescript": "~4.3.5",
"typescript": "~4.5.4",
"yarn-lock-check": "^1.0.5"
},
"prettier": "@spotify/prettier-config",
packages/cli/package.json
-1
View File
@@ -105,7 +105,6 @@
"sucrase": "^3.20.2",
"tar": "^6.1.2",
"terser-webpack-plugin": "^5.1.3",
"typescript": "^4.0.3",
"util": "^0.12.3",
"webpack": "^5.48.0",
"webpack-dev-server": "4.3.1",
packages/core-components/api-report.md
+36 -36
View File
@@ -906,28 +906,29 @@ export const SidebarDivider: React_2.ComponentType<
React_2.HTMLAttributes<HTMLHRElement>,
HTMLHRElement
>,
| 'id'
| 'color'
| 'translate'
| 'hidden'
| 'dir'
| 'slot'
| 'style'
| 'title'
| 'color'
| 'translate'
| 'accessKey'
| 'draggable'
| 'lang'
| 'prefix'
| 'children'
| 'id'
| 'contentEditable'
| 'inputMode'
| 'tabIndex'
| 'defaultChecked'
| 'defaultValue'
| 'suppressContentEditableWarning'
| 'suppressHydrationWarning'
| 'accessKey'
| 'contentEditable'
| 'contextMenu'
| 'draggable'
| 'lang'
| 'placeholder'
| 'spellCheck'
| 'tabIndex'
| 'radioGroup'
| 'role'
| 'about'
@@ -948,7 +949,6 @@ export const SidebarDivider: React_2.ComponentType<
| 'results'
| 'security'
| 'unselectable'
| 'inputMode'
| 'is'
| 'aria-activedescendant'
| 'aria-atomic'
@@ -1268,28 +1268,29 @@ export const SidebarScrollWrapper: React_2.ComponentType<
React_2.HTMLAttributes<HTMLDivElement>,
HTMLDivElement
>,
| 'id'
| 'color'
| 'translate'
| 'hidden'
| 'dir'
| 'slot'
| 'style'
| 'title'
| 'color'
| 'translate'
| 'accessKey'
| 'draggable'
| 'lang'
| 'prefix'
| 'children'
| 'id'
| 'contentEditable'
| 'inputMode'
| 'tabIndex'
| 'defaultChecked'
| 'defaultValue'
| 'suppressContentEditableWarning'
| 'suppressHydrationWarning'
| 'accessKey'
| 'contentEditable'
| 'contextMenu'
| 'draggable'
| 'lang'
| 'placeholder'
| 'spellCheck'
| 'tabIndex'
| 'radioGroup'
| 'role'
| 'about'
@@ -1310,7 +1311,6 @@ export const SidebarScrollWrapper: React_2.ComponentType<
| 'results'
| 'security'
| 'unselectable'
| 'inputMode'
| 'is'
| 'aria-activedescendant'
| 'aria-atomic'
@@ -1543,28 +1543,29 @@ export const SidebarSpace: React_2.ComponentType<
React_2.HTMLAttributes<HTMLDivElement>,
HTMLDivElement
>,
| 'id'
| 'color'
| 'translate'
| 'hidden'
| 'dir'
| 'slot'
| 'style'
| 'title'
| 'color'
| 'translate'
| 'accessKey'
| 'draggable'
| 'lang'
| 'prefix'
| 'children'
| 'id'
| 'contentEditable'
| 'inputMode'
| 'tabIndex'
| 'defaultChecked'
| 'defaultValue'
| 'suppressContentEditableWarning'
| 'suppressHydrationWarning'
| 'accessKey'
| 'contentEditable'
| 'contextMenu'
| 'draggable'
| 'lang'
| 'placeholder'
| 'spellCheck'
| 'tabIndex'
| 'radioGroup'
| 'role'
| 'about'
@@ -1585,7 +1586,6 @@ export const SidebarSpace: React_2.ComponentType<
| 'results'
| 'security'
| 'unselectable'
| 'inputMode'
| 'is'
| 'aria-activedescendant'
| 'aria-atomic'
@@ -1817,28 +1817,29 @@ export const SidebarSpacer: React_2.ComponentType<
React_2.HTMLAttributes<HTMLDivElement>,
HTMLDivElement
>,
| 'id'
| 'color'
| 'translate'
| 'hidden'
| 'dir'
| 'slot'
| 'style'
| 'title'
| 'color'
| 'translate'
| 'accessKey'
| 'draggable'
| 'lang'
| 'prefix'
| 'children'
| 'id'
| 'contentEditable'
| 'inputMode'
| 'tabIndex'
| 'defaultChecked'
| 'defaultValue'
| 'suppressContentEditableWarning'
| 'suppressHydrationWarning'
| 'accessKey'
| 'contentEditable'
| 'contextMenu'
| 'draggable'
| 'lang'
| 'placeholder'
| 'spellCheck'
| 'tabIndex'
| 'radioGroup'
| 'role'
| 'about'
@@ -1859,7 +1860,6 @@ export const SidebarSpacer: React_2.ComponentType<
| 'results'
| 'security'
| 'unselectable'
| 'inputMode'
| 'is'
| 'aria-activedescendant'
| 'aria-atomic'
packages/create-app/templates/default-app/package.json.hbs
+2 -1
View File
@@ -34,7 +34,8 @@
"@spotify/prettier-config": "^12.0.0",
"concurrently": "^6.0.0",
"lerna": "^4.0.0",
"prettier": "^2.3.2"
"prettier": "^2.3.2",
"typescript": "~4.5.4"
},
"prettier": "@spotify/prettier-config",
"lint-staged": {
plugins/azure-devops/src/hooks/useUserTeamIds.ts
+1 -1
View File
@@ -16,7 +16,7 @@
import { azureDevOpsApiRef } from '../api';
import { useApi } from '@backstage/core-plugin-api';
import { useAsync } from 'react-use';
import useAsync from 'react-use/lib/useAsync';
export function useUserTeamIds(userId: string | undefined): {
teamIds?: string[];
plugins/bazaar/src/components/HomePageBazaarInfoCard/HomePageBazaarInfoCard.tsx
+1 -1
View File
@@ -43,7 +43,7 @@ import {
import { Member, BazaarProject } from '../../types';
import { bazaarApiRef } from '../../api';
import { Alert } from '@material-ui/lab';
import { useAsyncFn } from 'react-use';
import useAsyncFn from 'react-use/lib/useAsyncFn';
import {
catalogApiRef,
catalogRouteRef,
plugins/catalog-react/api-report.md
+22 -22
View File
@@ -296,43 +296,40 @@ export const EntityRefLink: React_2.ForwardRefExoticComponent<
Pick<
EntityRefLinkProps,
| 'replace'
| 'type'
| 'key'
| 'id'
| 'media'
| 'state'
| 'color'
| 'display'
| 'translate'
| 'hidden'
| 'dir'
| 'slot'
| 'style'
| 'title'
| 'color'
| 'underline'
| 'display'
| 'translate'
| 'target'
| 'accessKey'
| 'draggable'
| 'lang'
| 'className'
| 'prefix'
| 'children'
| 'key'
| 'id'
| 'variant'
| 'state'
| 'href'
| 'contentEditable'
| 'inputMode'
| 'tabIndex'
| 'underline'
| 'download'
| 'href'
| 'hrefLang'
| 'ping'
| 'rel'
| 'target'
| 'type'
| 'referrerPolicy'
| 'defaultChecked'
| 'defaultValue'
| 'suppressContentEditableWarning'
| 'suppressHydrationWarning'
| 'accessKey'
| 'className'
| 'contentEditable'
| 'contextMenu'
| 'draggable'
| 'lang'
| 'placeholder'
| 'spellCheck'
| 'tabIndex'
| 'radioGroup'
| 'role'
| 'about'
@@ -353,7 +350,6 @@ export const EntityRefLink: React_2.ForwardRefExoticComponent<
| 'results'
| 'security'
| 'unselectable'
| 'inputMode'
| 'is'
| 'aria-activedescendant'
| 'aria-atomic'
@@ -403,6 +399,7 @@ export const EntityRefLink: React_2.ForwardRefExoticComponent<
| 'aria-valuemin'
| 'aria-valuenow'
| 'aria-valuetext'
| 'rel'
| 'dangerouslySetInnerHTML'
| 'onCopy'
| 'onCopyCapture'
@@ -564,13 +561,16 @@ export const EntityRefLink: React_2.ForwardRefExoticComponent<
| 'onAnimationIterationCapture'
| 'onTransitionEnd'
| 'onTransitionEndCapture'
| 'ping'
| 'referrerPolicy'
| 'align'
| 'variant'
| 'component'
| 'classes'
| 'innerRef'
| 'noWrap'
| 'gutterBottom'
| 'paragraph'
| 'align'
| 'variantMapping'
| 'TypographyClasses'
| 'entityRef'
plugins/gocd/src/components/GoCdBuildsComponent/GoCdBuildsComponent.tsx
+1 -1
View File
@@ -24,7 +24,7 @@ import {
Page,
} from '@backstage/core-components';
import { useApi, configApiRef } from '@backstage/core-plugin-api';
import { useAsync } from 'react-use';
import useAsync from 'react-use/lib/useAsync';
import { gocdApiRef } from '../../plugin';
import { GoCdBuildsTable } from '../GoCdBuildsTable/GoCdBuildsTable';
import { GoCdApiError, PipelineHistory } from '../../api/gocdApi.model';
plugins/scaffolder/src/components/fields/EntityTagsPicker/EntityTagsPicker.tsx
+2 -1
View File
@@ -14,7 +14,8 @@
* limitations under the License.
*/
import React, { useState } from 'react';
import { useAsync, useEffectOnce } from 'react-use';
import useAsync from 'react-use/lib/useAsync';
import useEffectOnce from 'react-use/lib/useEffectOnce';
import { CatalogEntitiesRequest } from '@backstage/catalog-client';
import { Entity, makeValidator } from '@backstage/catalog-model';
import { useApi } from '@backstage/core-plugin-api';
tsconfig.json
+2 -1
View File
@@ -8,6 +8,7 @@
],
"compilerOptions": {
"outDir": "dist-types",
"rootDir": "."
"rootDir": ".",
"useUnknownInCatchVariables": false
}
}
yarn.lock
+5 -10
View File
@@ -27640,21 +27640,16 @@ typescript-json-schema@^0.52.0:
typescript "~4.4.4"
yargs "^17.1.1"
typescript@^4.0.3, typescript@~4.5.2:
version "4.5.4"
resolved "https://registry.npmjs.org/typescript/-/typescript-4.5.4.tgz#a17d3a0263bf5c8723b9c52f43c5084edf13c2e8"
integrity sha512-VgYs2A2QIRuGphtzFV7aQJduJ2gyfTljngLzjpfW9FoYZF6xuw1W0vW9ghCKLfcWrCFxK81CSGRAvS1pn4fIUg==
typescript@~4.3.5:
version "4.3.5"
resolved "https://registry.npmjs.org/typescript/-/typescript-4.3.5.tgz#4d1c37cc16e893973c45a06886b7113234f119f4"
integrity sha512-DqQgihaQ9cUrskJo9kIyW/+g0Vxsk8cDtZ52a3NGh0YNTfpUSArXSohyUGnvbPazEPLu398C0UxmKSOrPumUzA==
typescript@~4.4.4:
version "4.4.4"
resolved "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz#2cd01a1a1f160704d3101fd5a58ff0f9fcb8030c"
integrity sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==
typescript@~4.5.2, typescript@~4.5.4:
version "4.5.4"
resolved "https://registry.npmjs.org/typescript/-/typescript-4.5.4.tgz#a17d3a0263bf5c8723b9c52f43c5084edf13c2e8"
integrity sha512-VgYs2A2QIRuGphtzFV7aQJduJ2gyfTljngLzjpfW9FoYZF6xuw1W0vW9ghCKLfcWrCFxK81CSGRAvS1pn4fIUg==
ua-parser-js@^0.7.18:
version "0.7.28"
resolved "https://registry.npmjs.org/ua-parser-js/-/ua-parser-js-0.7.28.tgz#8ba04e653f35ce210239c64661685bf9121dec31"