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
chore: add npm script to report deprecated but unremoved api #11366
Conversation
Relates to #11362 Note that I didn't have it check method parameters or events. |
cc @janvennemann this probably should go into appcelerator/docs-devkit with a parameter to filter out results with a new-enough version (i.e. when we lint modules or sdk api docs, we can pass in an argument and say, show me all results so long as the deprecated since version is < 8.0.0) |
Also possibly useful? another variant that finds deprecated and removed APIs older than version X for potential removal from the apidocs altogether (i.e. we probably don't need to document APIs that have been removed 2/3+ years ago any more) |
OK, followed it up with another script that can show the "old" removed apis to give us a listing of things we should consider dropping from the YML docs altogether. For now it's set to consider any API removed prior to 7.0.0 release. |
|
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.
Awesome! This will be really helpful in cleaning up our code base and docs. Code looks good, approved!
merged manually |
Optional Description:
This adds an npm script:
npm run deprecations
which will parse the apidocs and find types/properties/methods we've marked as deprecated but have not yet marked as removed.Lists the APIs in order from oldest deprecated version to newest. This should give a good listing for things we need to get rid of in breaking change releases.
Gives me: