chore: use TSTyche for type testing #2234
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,15 +4,15 @@ import { | |
| FallbackLocales, | ||
| LinguiConfig, | ||
| } from "@lingui/conf" | ||
| import { expect } from "tstyche" | ||
|
|
||
| // only required props | ||
| expect({ | ||
| locales: ["en", "pl"], | ||
| }).type.toBeAssignableTo<LinguiConfig>() | ||
|
|
||
| // all props | ||
| expect({ | ||
| catalogs: [ | ||
| { | ||
| path: "<rootDir>/locale/{locale}/messages", | ||
|
|
@@ -33,19 +33,19 @@ expectAssignable<LinguiConfig>({ | |
| tsExperimentalDecorators: false, | ||
| }, | ||
| fallbackLocales: {} as FallbackLocales, | ||
| format: "po" as const, | ||
|
There was a problem hiding this comment. The behaviour is the same as discussed here: https://github.com/lingui/js-lingui/pull/1622/files#r1178201302 More details in documentation: https://tstyche.org/reference/expect-api#type-widening |
||
| formatOptions: { origins: true, lineNumbers: true }, | ||
| locales: [], | ||
| orderBy: "messageId" as const, | ||
| pseudoLocale: "", | ||
| rootDir: ".", | ||
| runtimeConfigModule: ["@lingui/core", "i18n"] as [string, string], | ||
| sourceLocale: "", | ||
| service: { name: "", apiKey: "" }, | ||
| }).type.toBeAssignableTo<LinguiConfig>() | ||
|
|
||
| // custom extractors | ||
| expect({ | ||
| locales: ["en", "pl"], | ||
| extractors: [ | ||
| { | ||
|
|
@@ -58,18 +58,18 @@ expectAssignable<LinguiConfig>({ | |
| ) => {}, | ||
| }, | ||
| ], | ||
| }).type.toBeAssignableTo<LinguiConfig>() | ||
|
|
||
| // runtimeConfigModule | ||
| expect({ | ||
| locales: ["en", "pl"], | ||
| runtimeConfigModule: ["./custom-i18n-config", "i18n"] as [string, string], | ||
| }).type.toBeAssignableTo<LinguiConfig>() | ||
|
|
||
| expect({ | ||
| locales: ["en", "pl"], | ||
| runtimeConfigModule: { | ||
| i18n: ["./custom-config", "i18n"] as [string, string], | ||
| Trans: ["./custom-config", "Trans"] as [string, string], | ||
| }, | ||
| }).type.toBeAssignableTo<LinguiConfig>() | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -38,7 +38,6 @@ | |
| ], | ||
| "devDependencies": { | ||
| "@lingui/jest-mocks": "*", | ||
| "unbuild": "^2.0.0" | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,56 @@ | ||
| import { i18n } from "@lingui/core" | ||
| import { expect } from "tstyche" | ||
|
|
||
| expect(i18n._("message.id")).type.toBe<string>() | ||
| expect( | ||
| i18n._({ | ||
| id: "message.id", | ||
| message: "Message", | ||
| }) | ||
| ).type.toBe<string>() | ||
| expect( | ||
| i18n._( | ||
| "message.id", | ||
| { name: "Tim" }, | ||
| { message: "Hello {name}", comment: "", formats: {} } | ||
| ) | ||
| ).type.toBe<string>() | ||
| expect(i18n._).type.not.toBeCallableWith( | ||
| // cannot use message descriptor together with rest of params | ||
| { | ||
| id: "message.id", | ||
| message: "Message", | ||
| }, | ||
| { name: "Tim" }, | ||
| { message: "Hello {name}", comment: "", formats: {} } | ||
| ) | ||
|
|
||
| expect(i18n.t("message.id")).type.toBe<string>() | ||
| expect( | ||
| i18n.t({ | ||
| id: "message.id", | ||
| message: "Message", | ||
| }) | ||
| ).type.toBe<string>() | ||
|
|
||
| expect( | ||
| i18n.t( | ||
| "message.id", | ||
| { name: "Tim" }, | ||
| { message: "Hello {name}", comment: "", formats: {} } | ||
| ) | ||
| ).type.toBe<string>() | ||
|
|
||
| expect(i18n.t).type.not.toBeCallableWith( | ||
| // cannot use message descriptor together with rest of params | ||
| { | ||
| id: "message.id", | ||
| message: "Message", | ||
| }, | ||
| { name: "Tim" }, | ||
| { message: "Hello {name}", comment: "", formats: {} } | ||
| ) | ||
|
|
||
| expect(i18n.load).type.toBeCallableWith("cs", {}) | ||
| expect(i18n.load).type.toBeCallableWith({ cs: {} }) | ||
| expect(i18n.load).type.not.toBeCallableWith({ cs: {} }, {}) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As an example, you can state that TypeScript 5.4 and above is supported and run tests like this:
The tests will run agains each minor release, currently:
5.4,5.5,5.6,5.7,5.8. New TypeScript versions are added automatically as soon as they are published to npm.