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

fta-cli npm package does not currently export type defs #26

Closed
sgb-io opened this issue May 20, 2023 · 4 comments · Fixed by #166
Closed

fta-cli npm package does not currently export type defs #26

sgb-io opened this issue May 20, 2023 · 4 comments · Fixed by #166
Labels
enhancement New feature or request

Comments

@sgb-io
Copy link
Owner

sgb-io commented May 20, 2023

No description provided.

@bencollins54 bencollins54 added the enhancement New feature or request label Jun 12, 2023
@EcoFreshKase
Copy link
Contributor

Hi, I'm looking into creating the type declarations for the npm package.
How should the type declarations be implemented? Should a Pull Request be made on the DefinitelyTyped project, or should the declarations be added directly to the project?

I think it would make more sense to add them directly to the project. As far as I know, DefinitelyTyped ensures that types are well-commented. However, maintaining them there would be more of a hassle, as every interface change would require a new PR on DefinitelyTyped. That said, I don't expect frequent changes.

I've already created the type declarations (comments are still missing): fta.

@sgb-io
Copy link
Owner Author

sgb-io commented Sep 23, 2024

@EcoFreshKase thanks for the contribution!

Yes, it's best if the types are simply added direct to the project. You can open a PR with your changes and i'll adopt it.

I don't have major changes planned so the types are likely to remain stable, but it still makes sense to have the types co-located.

There is one caveat; I need to upgrade the github actions in order to get green builds and be able to release as there is currently a dependency on v2 actions that have recently been removed (see #163)

@sgb-io
Copy link
Owner Author

sgb-io commented Sep 23, 2024

The issue mentioned in #163 is now fixed, with the possible exception of some actions I depend on in release.yml (https://github.com/sgb-io/fta/blob/main/.github/workflows/release.yml).

You should be good to submit a PR and I can merge it, then see if the release succeeds (or migrate the release actions as needed).

sgb-io pushed a commit that referenced this issue Sep 23, 2024
* add type declarations

* add doc strings
@sgb-io
Copy link
Owner Author

sgb-io commented Sep 24, 2024

@EcoFreshKase I have now upgraded most of the workflow dependencies so the project can build and release successfully again.
I've just released 2.0.1 which includes your changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants