Skip to content

chore: fix incorrectly detects api changes #2998

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 22, 2025
Merged

chore: fix incorrectly detects api changes #2998

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f88346
chore: fix incorrectly detects api changes
mrgrain Sep 22, 2025
2c3ca5c
fix expected error
mrgrain Sep 22, 2025
cda6dad
expected error formatting and output formatting
mrgrain Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/loose-carrots-divide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
2 changes: 1 addition & 1 deletion scripts/components/api-changes-validator/api_changes_validator.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ void describe('Api changes validator', { concurrency: true }, () => {
(error: Error) => {
assert.ok(
error.message.includes(expectedErrorMessage),
`Error message ${EOL}${error.message}${EOL} must contain ${EOL}${expectedErrorMessage}${EOL}`,
`Error message ${EOL}\`\`\`${EOL}${error.message}${EOL}\`\`\`${EOL} must contain ${EOL}\`\`\`${EOL}${expectedErrorMessage}${EOL}\`\`\`${EOL}`,
);
return true;
},
Expand Down
6 changes: 5 additions & 1 deletion scripts/components/api-changes-validator/api_changes_validator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export class ApiChangesValidator {
if (this.latestPackageDependencyDeclarationStrategy === 'npmRegistry') {
dependencies[latestPackageJson.name] = latestPackageJson.version;
}
dependencies['typescript'] = '^5.0.0';
dependencies['typescript'] = '5.9.x';
dependencies['@types/node'] = '^18.15.11';
// Add the latest dependencies and peer dependencies as public API might use them
if (latestPackageJson.dependencies) {
Expand Down Expand Up @@ -123,11 +123,15 @@ export class ApiChangesValidator {
'node16',
'--moduleResolution',
'node16',
'--types',
'node',
'--target',
'es2022',
'--noEmit',
'--verbatimModuleSyntax',
'false',
'--exactOptionalPropertyTypes', // 2025-09-22: this is kind of bad, but our types are currently not set up for it to be enabled
'false',
];
await execa('npx', tscArgs, { cwd: this.testProjectPath });
};
Expand Down
4 changes: 3 additions & 1 deletion ...s/test-projects/with-breaks/type-break-make-property-mandatory/expected-error-message.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
index.ts(8,9): error TS2322: Type 'SampleTypeBaseline' is not assignable to type 'SampleType'.
Property 'anotherProperty' is optional in type 'SampleTypeBaseline' but required in type 'SampleType'.
Types of property 'anotherProperty' are incompatible.
Type 'string | undefined' is not assignable to type 'string'.
Type 'undefined' is not assignable to type 'string'.
Loading