Skip to content

Remove as assertions, or fix to mitigate the risk of silent failure #158

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
MajorLift merged 8 commits into from
Oct 17, 2023
Merged

Remove as assertions, or fix to mitigate the risk of silent failure #158

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
53cf673
Replace `as T[]` assertions with `?? []`
MajorLift Oct 13, 2023
f950f3e
Replace `as` assertions with redundant type guards
MajorLift Oct 13, 2023
8da9f21
Make `as` assertion rely on inference instead of hard-coded type casting
MajorLift Oct 13, 2023
033cd4e
Fix type narrowing for `currentVersion` by consolidating conditional …
MajorLift Oct 16, 2023
44cc00d
Install `@metamask/utils` as a devDep
MajorLift Oct 16, 2023
d788964
Replace `Object.keys` with `getKnownPropertyNames` method
MajorLift Oct 16, 2023
a26b0bb
Update src/update-changelog.ts
MajorLift Oct 17, 2023
7b7eef8
Merge branch 'main' into 231013-remove-or-fix-as-assertions
MajorLift Oct 17, 2023
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
Prev Previous commit
Next Next commit
Make as assertion rely on inference instead of hard-coded type casting 
If anything changes in the typing of `ChangeCategory` or `unreleasedChanges` that make them inconsistent, this code will fail silently. Relying on type inference instead of explicit type casting will make these line a little less brittle.

- TODO: document and expound in MetaMask/contributor-docs#47
  • Loading branch information
@MajorLift
MajorLift committed Oct 13, 2023
commit 8da9f215a13db6775d178968ff343144fc3f7ffb
4 changes: 3 additions & 1 deletion src/changelog.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,9 @@ export default class Changelog {

const unreleasedChanges = this.#changes[unreleased];

for (const category of Object.keys(unreleasedChanges) as ChangeCategory[]) {
for (const category of Object.keys(
unreleasedChanges,
) as (keyof typeof unreleasedChanges)[]) {
if (releaseChanges[category]) {
releaseChanges[category] = [
...(unreleasedChanges[category] ?? []),
Expand Down