WIP: add typings #112
WIP: add typings #112
Conversation
…3_0 to prevent accidental merges
package.json
Outdated
| }, | ||
| "dependencies": { | ||
| "@mischnic/async-hooks": "^0.0.4", | ||
| "autogypi": "^0.2.2", | ||
| "libui-download": "^1.1.0", | ||
| "nbind": "^0.3.14", | ||
| "node-gyp": "^3.3.1" | ||
| } | ||
| }, | ||
| "main": "./index.js", |
There was a problem hiding this comment.
This is already the default for node, there is no need to insert this property
package.json
Outdated
| "proc-stats": "0.0.4" | ||
| "prettier": "^1.12.1", | ||
| "proc-stats": "0.0.4", | ||
| "typescript": "^2.8.3" |
There was a problem hiding this comment.
Why we need typescript as a devdep? It will allow us to check types in example, tests etc?
If so, could you add an entry in scripts to do this check?
index.d.ts
Outdated
| type: textUnderlineColor, | ||
| color: Color): FontAttribute; | ||
|
|
||
| static getFamily(): textAttributeType|null; |
index.d.ts
Outdated
| static getOTFeatures(): OpenTypeFeatures|null; | ||
| } | ||
|
|
||
| export class OpenTypeFeatures { |
There was a problem hiding this comment.
This class has also add, remove, forEach methods
index.d.ts
Outdated
| static get(str: string): number|null; | ||
| } | ||
|
|
||
| export class Color { |
There was a problem hiding this comment.
For Color, Point, and their double counterparts: number is ok, but they also has properties with the same names as the constructor arguments
There was a problem hiding this comment.
@parro-it Sorry I can not get your point. Could you explain with some code?
There was a problem hiding this comment.
const p = new Point(12, 13);
console.log(p.x, p.y)
package.json
Outdated
| "ava": "^0.25.0", | ||
| "clang-format": "^1.2.2", | ||
| "humanize": "0.0.9", | ||
| "husky": "^0.14.3", | ||
| "proc-stats": "0.0.4" | ||
| "prettier": "^1.12.1", |
There was a problem hiding this comment.
Why prettier? We already use clangformat to check style, I think prettier would clash with that: it probably format the code in a way that clangformat does not accept
There was a problem hiding this comment.
I use prettier because it will automatically add ';', clang-format does not
There was a problem hiding this comment.
before submit, I will run lint to make sure code will be formatted with clang-format
There was a problem hiding this comment.
I use prettier because it will automatically add ';', clang-format does not
Yes, and I also miss some other checks that was provided by eslint, but clangformat has the advantage that also format objective-c c and c++. We'll need to improve on this. Meanwhile, you can jsut install it globally?
|
I have finished adding type to index.js. You can try adding About the UI part, I have read through the c++ code. I need some of your comments on which is the public API, how to use it, parameters information... This will help me work faster instead of having to switching between docs and code... I believe there is tons of tools to help you auto generate code based on comments so it will help keep the docs in sync as well. Please add those and push to the 0.3.0 branch then notify me when you have finished. |
Thank you, I'll try and confirm if it works.
You can check the JavaScript classes contained in https://github.com/parro-it/libui-napi/tree/master/js folder.
The public API will be the same as now, and that classes map current C++ classes one - by - one. If you prefer, and you think it's simpler, you can open a PR on libui-napi repo and insert TS directly there. |
|
@parro-it thank you for pointing me to that library, it helps. I will continue working on this |
|
Hovering over function in VS Code works well, displaing corrects TS signatures. |
|
@parro-it after I have finished this, you could simply copy all the jsdoc to the ts declare file so user don't have to go to docs page all the time ^^ |
Update control-gallery.js
Ref #106