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.
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
[trianglify]: fix trianglify types #69426
[trianglify]: fix trianglify types #69426
Conversation
@fdaciuk Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through. This is a live comment which I will keep updated. 1 package in this PR
Code ReviewsBecause this PR edits the configuration file, it can be merged once it's reviewed by a DT maintainer. You can test the changes of this PR in the Playground. Status
All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes. Diagnostic Information: What the bot saw about this PR{
"type": "info",
"now": "-",
"pr_number": 69426,
"author": "fdaciuk",
"headCommitOid": "ded6548afc5c5f7e361327abef094bc773463cd0",
"mergeBaseOid": "9ff6856db12ba15015b91b2466171b7f27ab3677",
"lastPushDate": "2024-04-23T23:31:50.000Z",
"lastActivityDate": "2024-05-15T21:51:03.000Z",
"mergeOfferDate": "2024-05-15T21:10:14.000Z",
"mergeRequestDate": "2024-05-15T21:51:03.000Z",
"mergeRequestUser": "fdaciuk",
"hasMergeConflict": false,
"isFirstContribution": true,
"tooManyFiles": false,
"hugeChange": false,
"popularityLevel": "Well-liked by everyone",
"pkgInfo": [
{
"name": "trianglify",
"kind": "edit",
"files": [
{
"path": "types/trianglify/index.d.ts",
"kind": "definition"
},
{
"path": "types/trianglify/package.json",
"kind": "package-meta-ok"
},
{
"path": "types/trianglify/trianglify-tests.ts",
"kind": "test"
},
{
"path": "types/trianglify/tsconfig.json",
"kind": "package-meta",
"suspect": "not [the expected form](https://github.com/DefinitelyTyped/DefinitelyTyped#user-content-tsconfigjson) and not moving towards it (check: `compilerOptions.exactOptionalPropertyTypes`)"
}
],
"owners": [
"unindented"
],
"addedOwners": [
"fdaciuk"
],
"deletedOwners": [],
"popularityLevel": "Well-liked by everyone"
}
],
"reviews": [
{
"type": "approved",
"reviewer": "peterblazejewicz",
"date": "2024-05-15T21:09:37.000Z",
"isMaintainer": true
}
],
"mainBotCommentID": 2073654179,
"ciResult": "pass"
} |
🔔 @unindented — please review this PR in the next few days. Be sure to explicitly select |
@fdaciuk The CI build failed! Please review the logs for more information. Once you've pushed the fixes, the build will automatically re-run. Thanks! Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review. |
@fdaciuk The CI build failed! Please review the logs for more information. Once you've pushed the fixes, the build will automatically re-run. Thanks! Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review. |
Re-ping @unindented: This PR has been out for over a week, yet I haven't seen any reviews. Could someone please give it some attention? Thanks! |
Let's wait a little more, the changes are braking, introducing new version and new module exports, etc. |
@peterblazejewicz the types were from an older version of trianglify. The update is to use the current version of the lib (4.1.1), as you can see here |
It has been more than two weeks and this PR still has no reviews. I'll bump it to the DT maintainer queue. Thank you for your patience, @fdaciuk. (Ping @unindented.) |
types/trianglify/index.d.ts
Outdated
/** An array of [x,y] coordinates to triangulate. Defaults to `undefined`, and points are generated. */ | ||
points?: Points | undefined; | ||
/** A boolean value to tell if trianglify should render the triangles or not. Defaults to `true` */ | ||
fill?: boolean | undefined; |
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.
I think this is inconsistent, defaults like width/height should not have the defaults, so no undefined as supported type, that looks OK. But here (and other places) fill
, won't have default null
, if someone passes undefined
:
https://github.com/qrohlf/trianglify/blob/master/src/trianglify.js#L48
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.
You're right, my bad 🙈. I'll test every property to make sure they are consistent and I'll update this PR =)
Thanks for your review ❤️
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.
Done @peterblazejewicz =)
@peterblazejewicz Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review? |
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.
LGTM
@fdaciuk thanks!
@fdaciuk: Everything looks good here. I am ready to merge this PR (at ded6548) on your behalf whenever you think it's ready. If you'd like that to happen, please post a comment saying:
and I'll merge this PR almost instantly. Thanks for helping out! ❤️ (@unindented: you can do this too.) |
Ready to merge |
Please fill in this template.
pnpm test trianglify
.package.json
.