Skip to content
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

wip: generate type declarations #131

Closed
wants to merge 1 commit into from
Closed

Conversation

barmac
Copy link
Member

@barmac barmac commented Jan 17, 2022

This adds TypeScript declarations to the package.

Closes #65

@bpmn-io-tasks bpmn-io-tasks bot added the in progress Currently worked on label Jan 17, 2022
@barmac
Copy link
Member Author

barmac commented Jan 17, 2022

Basic infrastructure is in place and now I will focus on fixing the errors.

@barmac barmac force-pushed the 65-add-type-declarations branch from 33acfe0 to f8bd7e7 Compare January 18, 2022 19:36
@barmac barmac force-pushed the 65-add-type-declarations branch from f8bd7e7 to dcb15a4 Compare January 19, 2022 16:38
@barmac
Copy link
Member Author

barmac commented Jan 19, 2022

I've fixed the types, but I believe we should also cross-test this with bpmn-js-properties-panel or have an integration-test app similar to the one in form-js before we merge this.

@barmac
Copy link
Member Author

barmac commented Jan 20, 2022

I created a branch which implements the type linting in bpmn-js-properties-panel but it's far from being finished. Check out the link: https://github.com/bpmn-io/bpmn-js-properties-panel/tree/add-type-linting

@barmac
Copy link
Member Author

barmac commented Jan 20, 2022

Although the type linting results are all green, the hundreds of errors within the integration test branch linked above makes me believe we don't sufficiently test the declarations. Also, it's not that easy to handle the broken JSDoc typings we have in bpmn-js-properties-panel. This means I don't expect that we quickly adopt type linting in that project and thus cannot verify the typings here.

Consequently, I am closing this PR. I believe we should start with limited, public API-only declarations written by hand. Regarding the code in this PR, there are some fixes which we can use (e.g. spellCheck fix) in a separate contribution.

@barmac barmac closed this Jan 20, 2022
@bpmn-io-tasks bpmn-io-tasks bot removed the in progress Currently worked on label Jan 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add type linting + generation
1 participant