Deprecate this package and archive the gihtub repository
tbouffard opened this issue · 1 comments
@hungtcs hi,
I have seen that you have just cut a new 1.0.5 release which fixes backported from https://github.com/typed-mxgraph/typed-mxgraph, which is nice for users like me we are still using mxgraph-type-definitions
.
However, as you mentioned few months ago in typed-mxgraph/typed-mxgraph#1 (comment) that you don't have much time working on mxgraph types (and me neither), I would suggest that we stop updating mxgraph-type-definitions
starting from now.
Most contributions are now done in typed-mxgraph
which is a sign that the new repository is gaining more popularity. Stopping mxgraph-type-definitions
would also redirect more people to typed-mxgraph
.
Backporting changes is a painful, time consuming and quite a boring task: this is too much work for a small community like ours.
My suggestions to properly stop mxgraph-type-definitions
[feel free to add/remove any elements here]
The following mxgraph-type-definitions
resources may be backported to typed-mxgraph
- documentation
- README explanations about
Progress
and links - helpers scripts
- README explanations about
- tests file:
- I have added a test.ts file as suggested by DefinitivelyTyped to validate some fixed definitions and demonstrate the type usage: https://github.com/hungtcs/mxgraph-type-definitions/blob/e472e593061294606432071723b43b1adf3d7169/test.ts
- I am not sure if this brings values or if it is a pain, so if it deserves to be preserved in
typed-mxgraph
The actual deperecation
- add a clear statement in the README
- npm package deprecation: https://docs.npmjs.com/deprecating-and-undeprecating-packages-or-package-versions
- optionally pin this issue
- archive the repository
Hi @tbouffard, if you decide to migrate to typed-mxgraph, I will archive this repository and deprecate mxgraph-type-definitions package. I will start to perform these steps next.